Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

FHIR® resources

The FHIR® profiles and interactions required for the Appointment Management capability pack

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.

The FHIR resources are linked to each other by reference as highlighted in the diagram below:

Diagram - Resource relationship structure


FHIR resources per GP Connect operation

Search for free slots

Request

Note: No FHIR resource is sent within the request.

Response


Book an appointment

Request

Response


Retrieve a patient’s appointments

Request

Note: No FHIR resource is sent within the request.

Response


Read an appointment

Request

Note: No FHIR resource is sent within the request.

Response


Amend an appointment

Request

Response


Cancel an appointment

Request

Response


Errors

If there is a problem with the request or an error occurs during processing of the request then the provider should return an 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.

Response


All content is available under the Open Government Licence v3.0, except where otherwise stated