v1

latestOpenAPI 3.0.0Apache 2.02026-07-143533191.6 KB
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

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