Response Headers

Request ID

All API responses from the Spine return a unique ID in the X-Request-Id header. This ID is used internally within the Audit Trail feature of the Spine as an identifier for each transaction. It’s recommended that Spine Client Systems include this ID in their own logs, since this must be included in any support requests.

The X-Request-Id in the API Response is the server-generated equivalent of the optional client-generated header supported in the API Request.

Logical ID

For API requests which create or search for a single record (for example: Create Pregnancy or Identify Pregnancy), the ID of the resource is returned as an X-Logical-Id header in the response. This allows clients to obtain the ID of a new record without the need to further search for it via a separate API request.

Location

In addition to the Logical ID header, the Location header is also returned by the Spine for requests which create new records or identify existing single records. This indicates the complete URL which may be used to read the record in future.

Correlation ID

When a Spine Client System includes a client-generated X-Request-Id the Spine echoes this ID back to the client in the response using the X-Correlation-Id header. This is in conformance with the FHIR Specification on Custom Headers and allows a client to correlate log messages associated with both the request and response.

This documentation space has been classified as:
COMMERCIAL IN CONFIDENCE

Confidentiality/document control

This document contains information that is confidential to System C Healthcare Ltd (System C) and is intended for our customers to use in connection with our products and services and it must not be used for any other purpose nor disclosed to any other party, either whole or in part, without the prior written consent of System C except as follows. A customer may permit those of its employees, advisors and agents having a need to know the contents of this platform, to have access to such of the contents as are strictly necessary, but that customer shall ensure that such employees, advisors and agents are bound to it by an obligation, in similar term, to keep it confidential. A customer's acceptance of these obligations shall be indicated by that customer's use of any of the information contained in this document.

System C acknowledges that a customer may be bound by the Freedom of Information Act 2000 (FOIA). In such a case System C considers that the contents of this document are confidential and exempt from disclosure pursuant to section 41 of the FOIA. A customer should consult System C before making any disclosure of information relating to System C under the FOIA. System C's business information, methodologies, solutions, as well as reference to System C clients and their projects are always considered by System C to be exempt from disclosure by virtue of section 41 and 43 of the FOIA, whether indicated or not.

Warning: Paper or PDF copies of this document are not version controlled and will automatically be considered obsolete and superseded at the time of printing or conversion.