v1

latestOpenAPI 3.0.0Apache 2.02026-07-143533191.6 KB
DocumentReference

Update a single document pointer

Update a single pointer you created.

Note that the following fields are immutable:

  • id
  • subject
  • custodian
  • type

Note that unlike NRL STU3 changing the status field does NOT delete document pointers. To delete document pointers please use the DELETE endpoint.

put/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.

use-contextstring required
Example:a4t2|validation|servicerequest-response|new

This header is for usage statistics for the BaRS Proxy for NHS England.

Response

Successful response