Referral

Get referral/s for a patient

Returns service requests for a specified patient

Use this endpoint to get all service requests for a given patient. All service requests for the specified patient at the specified target endpoint will be returned.

If a sender wants to cancel a service request, they must perform a read first and amend the response version when updating.

get/ServiceRequest

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/ServiceRequest
Auth
HTTP bearer

Query parameters

patient:identifierstring

Example:https%3A%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C4857773456

The patient's NHS number. The primary identifier of a patient across systems, unique to NHS England and Wales. It can be used without reference to Name, Date of Birth or Postcode parameters.

Type	Expression
token	Appointment.participant.actor:identifier

Example query without encoding https://fhir.nhs.uk/Id/nhs-number|4857773456

patient:namestring

Example:John%20Smith%0A

The patient's name, including family, given, prefix, suffix and/or text. The Receiving system will check against any patient name fields they hold to establish a match. It is expected this parameter is used in conjunction with Date of Birth and Postcode to ensure a unique match.

patient:birthdatestring

Example:eq20%2F01%2F1995%0A

The patient's Date of Birth. The Receiving system will check against the patient Date of Birth to establish a match. It is expected this parameter is used in conjunction with Name and Postcode to ensure a unique match.

patient:address-postalcodestring

Example:LS1%204AP%0A

The patient's Home address Postcode. The Receiving system will check against the patient 'Home' address Postcode to establish a match. It is expected this parameter is used in conjunction with Name and Date of Birth to ensure a unique match.

ServiceRequest.identifierstring

Example:https%3A%2F%2Fservicerequest.system%7C10000000000

The unique booking reference number of the referral, or the Unique GUID/UUID of the referral request. This is not the same as ServiceRequest.id. The preferred format is system|value however a value should be accepted and honoured as per FHIR guidance.

Type	Expression
token	ServiceRequest.identifier
Example query without encoding
*https://servicerequest.system	10000000000*

Response

Success

resourceTypestring

typestring

totalinteger

Example response

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "link": [
    {
      "relation": "self",
      "url": "https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/ServiceRequest"
    }
  ],
  "entry": [
    {
      "resourceType": "ServiceRequest",
      "id": "71d2b38e-b81c-4894-a522-6a65265b1d58",
      "meta": {
        "lastUpdated": "2021-11-26T15:00:00+00:00"
      },
      "basedOn": {
        "reference": "urn:uuid:9f748662-afde-540e-a6d5-8cd6ae63cd56"
      },
      "status": "active",
      "intent": "plan",
      "subject": {
        "reference": "urn:uuid:9589fb37-87a2-48d8-968f-b371429208a8"
      },
      "encounter": {
        "reference": "urn:uuid:8c63d621-4d86-4f57-8699-e8e22d49935d"
      },
      "occurrencePeriod": {
        "start": "2021-11-26T15:00:00+00:00",
        "end": "2021-11-26T15:20:00+00:00"
      },
      "authoredOn": "2021-11-26T15:00:00+00:00",
      "requester": {
        "reference": "urn:uuid:7d948662-bade-450e-b6c5-9bb6ee39cb56"
      },
      "PatientInstruction": "ADVICE GIVEN: If there are any new symptoms, or if the condition gets worse, changes or you have any other concerns",
      "search": {
        "mode": "match"
      }
    }
  ]
}

Changes

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