Search loading...


Explore and Make use of Nationally Defined Messaging APIs


Business requirements

Clinical, user and governance requirements that must be supported by the solution

The GP Connect requirements documentation for the Appointment Management Capability contains the set of business and solution requirements as defined in the API specifications and FHIR Structure Definitions. The GP Connect specification SHALL be regarded as authoritative where difference, contradiction, or inaccuracy is identified between the specification and the following requirements documentation.

The requirements and resulting API design have been developed in collaboration with NHS England, the GP Principal System Suppliers, clinical and GP Practice administrative stakeholders, FoT CCGs, and NHS Digital Urgent Care teams.

User stories, API requirements & use cases

The business requirements are described as a set of high-level user stories with corresponding functional specification requirements. System use case descriptions and activity diagrams detail how the Capability APIs are used in the end-to-end processes of booking an appointment, or amending/cancelling an appointment.

Requirements Documentation

This consists of:

Tags: appointments

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