v1

latestOpenAPI 3.0.0Apache 2.02026-07-143533191.6 KB
DocumentReference

Get a single document pointer

Read a single document pointer by specifying a DocumentReference.id. Note that you will only be able to retrieve document pointers that have been created by the organisation specified in the ODS-End-User-Organisation header, and agreed during onboarding.

get/DocumentReference/{id}

Path parameters

idstring uuid required
Example:c3f6145e-1a26-4345-b3f2-dccbcba62049

The identifier of the registry object.

Headers

X-Request-Idstring uuid required
Example:c1ab3fba-6bae-4ba4-b257-5a87c44d4a91

The X-Request-Id for the request header, when supplied, mirrored back by the receiver.

X-Correlation-Idstring uuid required
Example:9562466f-c982-4bd5-bb0e-255e9f5e6689

The X-Correlation-Id for the request header, when supplied, mirrored back by the receiver.

Acceptstring required
Example:application/fhir+json; version=1.4.0

The Accept header must also contain version of BaRS Core the Sender is expecting to interoperate on.

Response

Successful response