We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
GP Connect is a service that lets GP practices and authorised clinical staff share and view GP practice clinical information and data between IT systems.
GP Connect APIs
GP Connect has worked with GP clinical system suppliers to develop Application Programming Interfaces (APIs).
These APIs make data from clinical systems available in a standard form so that it can be used across different systems and be made available to clinicians who need access to the data for direct patient care.
Testing the GP Connect APIs
We are working with both health and care organisations and software suppliers to develop technical solutions to local issues by sharing patient records and appointment booking functionality across system and healthcare setting boundaries.
Which specification do I need?
GP Connect supports the delivery of capabilities which have been defined based on business drivers. These are outlined in the corresponding specifications.
Before you start developing against any specification, we recommend you email the GP Connect programme team: gpconnect@nhs.net.
You can discuss your goals and use cases with the team.
GP Connect API specifications listed by capability
Access Record HTML
This capability enables a read only view of the patient’s GP Practice record.
Current specification
This is the current version of the specification that system suppliers are recommended to develop against and be compliant with.
Appointment Management
This capability enables the management of GP practice appointments between different systems.
Current specification
This is the latest version of the specification that Appointment Management system suppliers are recommended to develop against and be compliant with.
Access Record Structured
This capability enables structured information to be retrieved from the patient’s GP Practice record.
Current specifications
The Access Record Structured capability is being delivered in phases and there are different versions of the specification relevant to each phase. The specifications are ‘beta’ at this time and are subject to change until initial implementations are proven in Live deployments.
Medications and allergies
This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with. However, please note there have been no material changes for suppliers to Access Record Structured since 1.2.6.
Please see the release notes for further information.
Extended Phase 1 – Immunisations, Uncategorised Data, Problems and Consultations (in addition to Medications and Allergies)
This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with.
Extended Phase 2 – Investigations, Referrals, Diary Entries and Immunisations not given (in addition to Extended Phase 1 scope)
This specification includes Diary Entries and Immunisations not given profiles that were previously planned for release in Extended Phase 3.
This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with.
Access Document
This capability enables access to documents that can be retrieved from the patient’s GP Practice record. This was previously released as an independent ‘GP Connect Access Document API 1.0.1-beta’ specification.
Current specification
This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with.
The specification is ‘beta’ at this time and is subject to change until initial implementations are proven in Live deployments.
GP Connect Messaging specification listed by capability
Send document
This capability provides a simple and standardised means of sending a document to a GP Practice system.
Current specification
This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with.
The specification is ‘beta’ at this time and is subject to change until initial implementations are proven in Live deployments.
Archived specifications
Archived versions of the GP Connect API and GP Connect Messaging specifications.
Last edited: 13 October 2020 2:18 pm