FHIR Resources
FHIR resources when searching for free slots
This diagram shows the relationships between FHIR resources used when searching for free slots to book.
The FHIR resources above are used in the following API interactions:
Search for free slots
View How to search for free slots.
Request
No FHIR resource is sent within the request payload.
Response
- FHIR Bundle, populated with:
- GPConnect-Slot-1 (based on FHIR Appointment)
- GPConnect-Schedule-1 (based on FHIR Appointment)
- CareConnect-GPC-Location-1 (based on FHIR Location)
- CareConnect-GPC-Practitioner-1 (based on FHIR Practitioner)
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
FHIR resources when booking and managing booked appointments
This diagram shows the relationships between FHIR resources used when booking an appointment or managing a booked appointment.
The Appointment resource and Organization resource (used to hold the booking organisation) are used in the request and/or response payloads of the API interactions below. References to the other resources (such as Slot, Location, Patient, and so on) are populated in the relevant fields of the Appointment resource.
Retrieve a patient's appointments
View How to retrieve a patient's appointments.
Request
No FHIR resource is sent within the request payload.
Response
- FHIR Bundle, populated with:
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
Read an appointment
View How to read an appointment.
Request
No FHIR resource is sent within the request payload.
Response
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
Book an appointment
View How to book an appointment.
Request
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
Response
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
Cancel an appointment
View How to cancel an appointment.
Request
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
Response
- GPConnect-Appointment-1 (based on FHIR Appointment), with a contained resource of:
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
FHIR resources returned in error responses
If an error occurs during the processing of the request in any of the above API interactions, the provider system will return an HTTP error code along with an OperationOutcome resource in the response payload. See Error Handling.