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

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.

Response

Successful response

resourceTypestring
statusstring
datestring date-time

Example response

{
  "resourceType": "DocumentReference",
  "identifier": [
    {
      "system": "https://fhir.nhs.uk/Id/BaRS-Identifier",
      "value": "GL0-DZOqD39"
    }
  ],
  "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": "3495456481"
    }
  },
  "date": "2025-02-05T08:25:13.136693+00:00",
  "author": [
    {
      "identifier": {
        "system": "https://fhir.nhs.uk/Id/ods-organization-code",
        "value": "RGT"
      }
    }
  ],
  "custodian": {
    "identifier": {
      "system": "https://fhir.nhs.uk/Id/ods-organization-code",
      "value": "RGT"
    }
  },
  "content": [
    {
      "attachment": {
        "contentType": "application/fhir+json",
        "url": "https://server.fire.ly/r4/Appointment/GL0-DZOqD39"
      },
      "format": [
        {
          "coding": [
            {
              "system": "https://fhir.nhs.uk/CodeSystem/message-events-bars",
              "code": "referral"
            }
          ]
        }
      ]
    }
  ],
  "context": {
    "period": {
      "start": "2025-02-01T06:45:00+00:00",
      "end": "2025-02-01T07:00:00+00:00"
    },
    "practiceSetting": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "394802001",
          "display": "General medicine (qualifier value)"
        }
      ]
    }
  }
}

Changes

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