NHnhs
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}

Request

  • Base URL
    https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4
  • URL
    https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/DocumentReference/{id}
  • Auth
    HTTP bearer

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.

Request body

resourceTypestring
typestring
totalinteger

Example request

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 3,
  "link": [
    {
      "relation": "self",
      "url": "https://int.api.service.nhs.uk/record-locator/consumer/FHIR/R4/DocumentReference?subject:identifier=https://fhir.nhs.uk/Id/nhs-number|9693893123&type=http://snomed.info/sct|749001000000101&category=http://snomed.info/sct|419891008"
    }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "DocumentReference",
        "id": "V4T0L-3aeb90b0-7ffa-408a-babf-f20b80ce2c27",
        "meta": {
          "lastUpdated": "2025-02-18T17:04:53.948Z"
        },
        "status": "current",
        "type": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "749001000000101",
              "display": "Appointment (record artifact)"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://snomed.info/sct",
                "code": "419891008",
                "display": "Clinical notes"
              }
            ]
          }
        ],
        "subject": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9693893123"
          }
        },
        "date": "2025-02-18T17:04:53.948Z",
        "custodian": {
          "identifier": {
            "system": "https://fhir.nhs.uk/Id/ods-organization-code",
            "value": "RGT"
          }
        },
        "context": {
          "period": {
            "start": "2025-02-01T06:45:00+00:00",
            "end": "2025-02-01T07:00:00+00:00"
          }
        }
      }
    }
  ]
}

Response

Successful response

resourceTypestring
idstring uuid

Example response

{
  "resourceType": "OperationOutcome",
  "id": "531e073a-3295-4e67-ae90-e00bd96a9cdd",
  "meta": {
    "profile": [
      "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome"
    ]
  },
  "issue": [
    {
      "severity": "information",
      "code": "informational",
      "diagnostics": "Resource updated"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.