Retrieve patient's document pointers (GET)
Retrieve the document pointers for a single patient. Your request is constrained by the document pointer types agreed during onboarding. The results can also be filtered to return documents by a given type and/or created by a given producer (custodian).
Query parameters
The URL encoded patient's NHS number. The primary identifier of a patient across systems, unique to NHS England and Wales. This needs to be URL Encoded as its passed as a query parameter and part of the URL.
| Type | Expression |
|---|---|
| token | Appointment.participant.actor:identifier |
Example before encoding https://fhir.nhs.uk/Id/nhs-number|4857773456
The custodian of the pointer This needs to be URL Encoded as its passed as a query parameter and part of the URL.
Endpoint without encoding https://fhir.nhs.uk/Id/ods-organization-code|Y05868
The specified type of pointers to be returned. This needs to be URL Encoded as its passed as a query parameter and part of the URL.
Example query without encoding http://snomed.info/sct|749001000000101
A token that can be sent as either a query parameter or in the post body parameter to retrieve the next set of 20 records.
This token is returned in the meta.tag field.
Headers
The X-Request-Id for the request header, when supplied, mirrored back by the receiver.
The X-Correlation-Id for the request header, when supplied, mirrored back by the receiver.
Requesting Organization described in an object based on a FHIR 'Organization' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for.
In this example an ODS code and the Organisation name is provided. Other identifiers are permitted if required.
Requesting Organization described in an object based on a FHIR 'Organization' resource (Standard Base64 encoded JSON). Different BaRS Applications may have different standards and requirements for the Access Control which these headers are used for. In the example given an ODS code and the Organisation name is provided. Other identifiers are permitted if required.
Example object before encoding
{
"resourceType": "Organization",
"identifier": [
{
"value": "A1001",
"system": "https://fhir.nhs.uk/Id/ods-organization-code"
}
],
"name": "My service provider name"
}
The Accept header must also contain version of BaRS Core the Sender is expecting to interoperate on.
Response
Successful response