NHS Digital Profile:
HL7 FHIR STU3 Resource(s):
Consumer interaction to support the retrieval of a single NRL pointer. The read interaction is a FHIR RESTful read interaction.
In addition to the requirements on this page, the general guidance and requirements detailed on the Development Overview page MUST be followed when using this interaction.
Read Request Headers
Consumer API read requests support the following HTTP request headers:
||Client System ASID.||REQUIRED|
||The Spine ASID.||REQUIRED|
The read interaction allows a consumer to retrieve a single pointer (DocumentReference) by logical ID.
The consumer must issue an HTTP GET as shown:
GET [baseUrl]/STU3/DocumentReference/da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142Read the DocumentReference resource for a pointer with the logical id of 'da2b6e8a-3c8f-11e8-baae-6c3be5a609f5-584d385036514c383142'.
Note the status of the pointer must be
current for the pointer to be retrieved.
A successful execution of the read interaction will:
- return a
200OK HTTP status code.
- return a response body containing a
DocumentReferenceresource which conforms to the NRL-DocumentReference-1 FHIR profile and has the status
Example Successful Response:
The following errors can be triggered when performing this operation:
Explore the NRL
You can explore and test the read interaction using Swagger in the NRL API Reference Implementation.