This page provides an overview of the FHIR STU3 Resources that are required to build the required API messaging. Each link will take you to the resource page detail with a link to the StructureDefinitions of each resource.
Important: This is a live release of the NHS Booking API specification. However, prior to commencing development, please contact the Booking & Referral Team.
Background
- A service would need to have been identified prior to initialising the booking system.
- Where the selected service offers appointment Booking, it will include an value.
- The ASID is used to locate the FHIR endpoint to be queried.
- A FHIR RESTful Search request is sent to the FHIR endpoint for Slots that meet the time constraints, the appropriate service id (e.g. from DoS) is passed as a constraint on the HealthcareService ID.
- The specified HealthcareService may run zero to many Schedules.
- Each Schedule may contain zero to many Slots.
- The Slots are filtered using the Time constraints before being returned in a searchset Bundle.
The diagram below illustrates the resources required for managing the appointment slots. The Slot resource is used to manage a slot of time for an appointment. The Slot always references a Schedule resource which acts as a container for the slots of time. Each Schedule will also reference additional resources to determine who the schedule is for.
Appointment structure
- The Appointment resource is POSTed to the FHIR endpoint in a FHIR RESTful Create.
- The Appointment resource contains a Slot retrieved above.
- The Appointment resource contains a Patient resource.
- The Appointment resource contains a DocumentReference resource.
| Resource | Description | Profile |
|---|---|---|
| Appointment | The appointment that is booked, linking a specific Patient into a specific Slot | CareConnect-Appointment-1 |
| Slot | A free time period, into which an appointment with a specific Patient can be booked | CareConnect-Slot-1 |
| Schedule | A grouping of Slots, used to link them to the HealthcareService which the slots are provided as part of | CareConnect-Schedule-1 |
| HealthcareService | A HealthcareService which has been selected from the DoS, and delivers one or more Schedules | CareConnect-HealthcareService-1 |
| Organization | An Organisation which delivers one or more HealthcareServices | CareConnect-Organization-1 |
| Location | A Location at which an Organisation delivers one or more HealthcareServices | CareConnect-Location-1 |
| Patient | A Patient for whom an appointment is being booked | CareConnect-Patient-1 |
| DocumentReference | A DocumentReference which points to a document which gives information supporting the Appointment | CareConnect-DocumentReference-1 |