The fhir prifles and interactions required for the Appointment Management capability
The following profiled FHIR resources are used in the current version of the Appointment Management capability, see “API Use Cases” in the menu on the left. Full details of profiled FHIR resources and worked examples are available on the FHIR Reference Server.
Search for free slots
Request
N/A - No fhir resource is sent within the request
Response
- FHIR Bundle
- GPConnect-Slot-1 (based on FHIR Slot)
- GPConnect-Schedule-1 (based on FHIR Schedule)
- CareConnect-GPC-Practitioner-1 (based on FHIR Practitioner)
- CareConnect-GPC-Organization-1 (based on FHIR Organization)
- CareConnect-GPC-Location-1 (based on FHIR Location)
Book an appointment
Request
- GPConnect-Appointment-1 (based on FHIR Appointment)
Response
- GPConnect-Appointment-1 (based on FHIR Appointment)
Retrieve a patients appointments
Request
N/A - No fhir resource is sent within the request
Response
- GPConnect-Appointment-1 (based on FHIR Appointment)
Read an appointment
Request
N/A - No fhir resource is sent within the request
Response
- GPConnect-Appointment-1 (based on FHIR Appointment)
Amend an appointment
Request
- GPConnect-Appointment-1 (based on FHIR Appointment)
Response
- GPConnect-Appointment-1 (based on FHIR Appointment)
Cancel an appointment
Request
- GPConnect-Appointment-1 (based on FHIR Appointment)
Response
- GPConnect-Appointment-1 (based on FHIR Appointment)
Errors
If there is a problem with the request or an error occurs during processing of the request then the provider should return a http error along with an “OperationOutcome” Resource within the response payload. Details of the required error responses are available on the Error Handling Guidance page within the specification.
