Skip to main content

GP Connect specifications for developers

Directory of GP Connect specifications and associated artefacts.

GP Connect is a service that allows GP practices and authorised clinical staff to share and view GP practice clinical information and data between IT systems, quickly and efficiently.

Which specification do I need?

Image showing GP Connect specifications

GP Connect is supporting the delivery of capabilities which have been defined based on business drivers. The capabilities are outlined below with more detail about each capability found in the corresponding specifications.

See the GPIT Futures Framework Roadmap for information on the Framework requirements. Contact the GPIT Futures team for enquires - gpifutures@nhs.net.

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 version has been widely implemented and deployed by system suppliers and is the recommended version for new system suppliers to develop against and be compliant with. 

GP Connect API 0.5.2 - contains: Access Record HTML

Release version:  GP Connect API 0.5.2

Release date: 23 April 2019

Release notes: API releases notes 0.5.2

Containing capabilities: Access Record HTML

Artefacts: API provider test suite 0.5.2,  API demonstrator

Next specification

This version is targeted by NHS Digital for delivery by system suppliers in the near future. NHS Digital are working with suppliers of API Provider systems to agree plans. This version of the specification has no additional requirements for API Consumer system suppliers over and above GP Connect API 0.5.2.

GP Connect API 0.7.2 - contains: Access Record HTML

Release version: GP Connect API 0.7.2

Release date: 23 April 2019

Release notes: API release notes 0.7.2

Containing capabilities: Access Record HTML

Artefacts: API provider test suite (not yet available) , API demonstrator (not yet available)

 

Appointment Management

This capability enables the management of GP practice appointments between different systems.

Current specification

This is the latest version of the specification containing the Appointment Management capability. For API providers there have been no material changes for Appointment Management since GP Connect API 1.2.3; system suppliers developing an API provider need to be compliant with this version. For API consumers, specifically system suppliers for the 111 service, changes were introduced in GP Connect API 1.2.4; 111 system suppliers need to be compliant with this version.

GP Connect API 1.2.5-beta - contains: Appointment Management, Access Record Structured

Release version: GP Connect API 1.2.5-beta

Release date: 15 October 2019

Release notes: API release notes 1.2.5-beta

Containing capabilities: Appointment Management, Access Record Structured

Artefacts: API provider test suite (not yet available) , API demonstrator (not yet available)

 

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.

GP Connect API 1.2.5-beta - contains: Appointment Management, Access Record Structured

Release version: GP Connect API 1.2.5-beta

Release date: 15 October 2019

Release notes: API release notes 1.2.5-beta

Containing capabilities: Appointment Management, Access Record Structured

Artefacts: API provider test suite (not yet available) , API demonstrator (not yet available)

 

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.

GP Connect API 1.3.1-beta - contains: Appointment Management, Access Record Structured

Release version: GP Connect API 1.3.1-beta

Release date: 11 September 2019

Release notes: API release notes 1.3.1-beta

Containing capabilities: Appointment Management, Access Record Structured

Artefacts: API provider test suite 1.3.1-beta,  API demonstrator

 

Extended Phase 2 – Investigations and Referrals (in addition to Medications and Allergies, and Extended Phase 1 scope)

This is the latest version of the specification that system suppliers are recommended to develop against and be compliant with.

Please note - ‘Documents’ is being delivered as a separate capability ‘Access Document’. See further down this page for details of the separate specification.

GP Connect API 1.4.1-beta - contains: Appointment Management, Access Record Structured

Release version: GP Connect API 1.4.1-beta

Release date: 5 November 2019

Release notes: API release notes 1.4.1-beta

Containing capabilities: Appointment Management, Access Record Structured

Artefacts: API provider test suite (not yet available) , API demonstrator (not yet available)

 

Extended Phase 3 – Appointments, Diary Entry, Immunisations (Not given) - subject to final confirmation (in addition to Medications and Allergies, and Extended Phase 1&2 scope)

This version specification is in development and will be released in due course.

 

Access document

This capability provides the ability to retrieve unstructured documents from a patient’s GP Practice record.

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 Access Document API 1.0.1-beta - contains: Access Document

Release version: GP Connect Access Document API 1.0.1-beta

Release date: 30 September 2019

Release notes: Access Document API release notes 1.0.1-beta

Containing capabilities: Access Document

Artefacts: Access Document API provider test suite (not yet available) , Access Document API demonstrator (not yet available)

 

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.

GP Connect Messaging 1.3.0-beta - contains: Send Document

Release version: GP Connect Messaging 1.3.0-beta

Release date: 11 September 2019

Release notes: Messaging release note 1.3.0-beta

Containing capabilities: Send Document

Artefacts: No artefacts available

 

Archived specifications

Archived versions of the GP Connect API and GP Connect Messaging specifications.

GP Connect API 1.x versions

Release version: GP Connect Access Document API 1.0.0-beta
Release date: 30 September 2019
Containing capabilities: Access Document
Artefacts: Access Document API provider test suite (not yet available) , Access Document API demonstrator (not yet available)

 

Release version: GP Connect API 1.4.0-beta
Release date: 30 September 2019
Containing capabilities: Appointment Management, Access Record Structured
Artefacts: API provider test suite (not yet available) , API demonstrator (not yet available)

 

Release version: GP Connect API 1.2.4-beta
Release date: 30 August 2019
Containing capabilities: Appointment Management, Foundations, Access Record Structured
ArtefactsAPI specification 1.2.4-beta,  API release notes 1.2.4-beta,  API provider test suite 1.2.4-beta,  API demonstrator

 

Release version: GP Connect API 1.3.0-beta
Release date:  28 June 2019
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Artefacts: API specification 1.3.0-beta,  API release notes 1.3.0-beta,  API provider test suite 1.3.0-beta,  API demonstrator

 

Release versionGP Connect API 1.2.3
Release date: 23 April 2019
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Details: Fixes and clarifications to the Appointments and Access Record Structured capabilities, and to the core elements of the specification (such as SDS queries)
Artefacts: API specification 1.2.3,  API release notes 1.2.3,  API provider test suite 1.2.3,  API demonstrator

 

Release version:  GP Connect API 1.2.2
Release date: 26 October 2018
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Artefacts:  API specification 1.2.2API release notes 1.2.2API provider test suite 1.2.2

 

Release version:  GP Connect API 1.2.1
Release date: 21 September 2018
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Artefacts: API specification 1.2.1API release notes 1.2.1 , API provider test suite 1.2.1

 

Release version:  GP Connect API 1.2.0
Release date: 3 August 2018
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Artefacts: API specification 1.2.0API release notes 1.2.0API provider test suite 1.2.0

 

Release version:  GP Connect API 1.1.1
Release date: 11 May 2018
Containing capabilities: Appointment Management, Foundations
Artefacts: API specification 1.1.1API release notes 1.1.1, API provider test suite 1.1.1

 

Release version:  GP Connect API 1.1.0
Release date: 16 March 2018
Containing capabilities: Appointment Management, Foundations
Artefacts: API specification 1.1.0API release notes 1.1.0,  API provider test suite 1.1.0

 

Release version:  GP Connect API 1.0.0
Release date: 23 February 2018
Containing capabilities: Appointment Management, Foundations
Artefacts: API specification 1.0.0,  API release notes 1.0.0,  API provider test suite 1.0.0

GP Connect API 0.x versions

Release version:  GP Connect API 0.7.1
Release date: 4 February 2019 
Containing capabilities: Access Record HTML
Artefacts: API specification 0.7.1,  API release notes 0.7.1

 

Release version:  GP Connect API 0.7.0
Release date: 20 December 2018
Containing capabilities: Access Record HTML
Artefacts: API specification 0.7.0,  API release notes 0.7.0

 

Release version: GP Connect API 0.5.1
Release date: 17 December 2018
Containing capabilities: Access Record HTML
Artefacts: API specification 0.5.1API release notes 0.5.1, API provider test suite 0.5.1

 

Release version:GP Connect API 0.5.0
Release date: 23 February 2018
Containing capabilities: Access Record HTML
Artefacts: API specification 0.5.0, API release notes 0.5.0 , API provider test suite 0.5.0

GP Connect Messaging 1.x versions

Release version: GP Connect Messaging 1.2.0
Release date: 4 February 2019
Containing capabilities: Send Document
Artefacts: Messaging specification 1.2.0Messaging release notes 1.2.0

 

Release version: GP Connect Messaging 1.1.0
Release date: 21 September 2018
Containing capabilities: Send Document
Artefacts: Messaging specification 1.1.0,  Messaging release notes 1.1.0

 

Release version: GP Connect Messaging 1.0.0
Release date: 31 August 2018
Containing capabilities: Send Document
Artefacts: Messaging specification 1.0.0Messaging release notes 1.0.0

Last edited: 8 November 2019 5:10 pm