NHnhs
Booking

Get bookings for a patient

Returns bookings for a specified patient

Use this endpoint to get all bookings for a given patient. All bookings for the specified patient at the specified target endpoint will be returned in a FHIR searchset Bundle containing Appointment resources.

If a sender wants to cancel a particular booking, they must perform a read first, comparing and amending the details prior to performing the update.

get/Appointment

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/Appointment
  • 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.

TypeExpression
tokenAppointment.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.

Response

Success

resourceTypestring
typestring
totalinteger

Example response

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 2,
  "link": [
    {
      "relation": "self",
      "url": "https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/Appointment"
    }
  ],
  "entry": [
    {
      "fullUrl": "https://sandbox.api.service.nhs.uk/booking-and-referral/FHIR/R4/Appointment/c3f6145e-1a26-4345-b3f2-dccbcba62049",
      "resource": {
        "resourceType": "Appointment",
        "id": "c3f6145e-1a26-4345-b3f2-dccbcba62049",
        "meta": {
          "lastUpdated": "2021-11-11T12:11:30+00:00",
          "profile": [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Appointment"
          ]
        },
        "status": "booked",
        "description": "Reason for calling",
        "start": "2021-10-12T12:30:30+00:00",
        "end": "2021-10-12T12:40:30+00:00",
        "slot": [
          {
            "reference": "Slot/95CA8891-5CB2-4AFC-A6E4-2D20645FDE60"
          }
        ],
        "created": "2021-10-11T15:01:30+00:00",
        "basedOn": [
          {
            "reference": "ServiceRequest/136bb75d-90ef-461f-4773-fde7f899803d",
            "type": "ServiceRequest"
          }
        ],
        "participant": [
          {
            "actor": {
              "reference": "urn:uuid:788660eb-d2c9-4773-abd4-318484673fb2"
            },
            "status": "accepted",
            "type": [
              {
                "coding": [
                  {
                    "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                    "code": "ATND",
                    "display": "attender"
                  }
                ]
              }
            ]
          }
        ]
      },
      "search": {
        "mode": "match"
      }
    }
  ]
}

Changes

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