Skip to main content

GP Connect specifications for developers

Directory of GP Connect specifications and associated artefacts.

Page contents

This is a directory of the GP Connect API and Messaging specifications, including supporting artefacts and version history. These specifications are designed for system suppliers and developers building or maintaining solutions that connect with GP clinical systems.

What are the specifications?

The specifications define how to implement GP Connect capabilities using FHIR-based APIs and messaging standards. They include:

  • technical requirements
  • data models and FHIR profiles
  • capability statements
  • example interactions

Use these specifications to integrate your software with GP Connect as either a provider (offering data) or a consumer (accessing data). They are maintained by the GP Connect team.

Which specifications do I need?

Before starting development, we recommend contacting us at [email protected] to discuss your use case and confirm which specifications apply.

GP Connect API specifications listed by capability

Access Record: HTML

Enables a read-only view of the patient’s GP practice record.

GP Connect API 0.7.4 - contains: Access Record: HTML

Release version: GP Connect API 0.7.4
Release date: 25 April 2022
Release notes: API release notes 0.7.4
Containing capabilities: Access Record: HTML
Artefacts: API provider test suite, API demonstrator

Appointment Management

Enables the management of GP practice appointments between different systems.

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

Release version: GP Connect API 1.2.7-beta

Release date: 5 May 2020

Release notes: API release notes 1.2.7-beta

Containing capabilities: Appointment Management, Access Record: Structured

Artefacts: API provider test suite, API demonstrator

Access Record: Structured

Enables structured information to be retrieved from the patient’s GP practice record.

GP Connect API 1.5.0-beta – contains Access Record: Structured

Release version: GP Connect API 1.5.0-beta

Release date: 27 February 2020

Release notes: API release notes 1.5.0-beta

Containing capabilities: Access Record: Structured

Artefacts: API provider test suite, API demonstrator

Access Document

This capability enables access to documents that can be retrieved from the patient’s GP practice record. This version includes the ability to access deceased patients' documents.

GP Connect API 1.5.1-beta – contains Access Document

Release version: GP Connect API 1.5.1-beta

Release date: 27 February 2020

Release notes: API release notes 1.5.1-beta

Containing capabilities: Access Document, Access Record: Structured

Artefacts: API provider test suite, API demonstrator

The previous version (1.5.0) does not include the ability to access deceased patients' documents, but is available for system suppliers who have started to develop against it.

Patient Facing APIs

GP Connect: Patient Facing APIs allow patients to use a consumer application (for example, NHS App) to:

  • view their GP electronic health record
  • request repeat prescriptions 
  • retrieve the PFS permissions set by their GP practice 
GP Connect (Patient Facing) Access Record - FHIR API

Release version: GP Connect (Patient Facing) Access Record - FHIR API 

Artefacts: API test suite, Implementation guide

GP Connect (Patient Facing) Prescriptions - FHIR API

Release version: GP Connect (Patient Facing) Prescriptions - FHIR API

Artefacts: API test suite, Implementation guide

GP Connect (Patient Facing) User Permissions API

Release version: GP Connect (Patient Facing) User Permissions API

Artefacts: API test suite, Implementation guide

 

GP Connect Messaging specifications listed by capability

Send Document

This capability provides a simple and standardised means of sending a document to a GP practice system.

GP Connect Send Document 2.0.2

Release version: GP Connect - Send Document 2.0.2

Release date: 18 December 2024

Release notes: Release notes 2.0.2-public-beta

Artefacts: Implementation guide 

Update Record

Use this integration to update a patient's GP record from a community pharmacy with structured data.

Update Record

Release version: GP Connect Update Record

Release date: 14 November 2024

Release notes: Release notes 1.2.0-public-beta

Artefacts: API test suite, Implementation guide, Example payloads

Archived specifications

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

GP Connect API 1.x versions

Release version: GP Connect API 1.3.2
Release date:  24 February 2020 
Release notes API release notes 1.3.2
Containing capabilities: Appointment Management, Access Record Structured
Artefacts: API provider test suite, API demonstrator
 

Release version: GP Connect API 1.2.6
Release date: 14 February 2020
Release notes: API release notes 1.2.6
Containing capabilities: Appointment Management, Access Record Structured
Artefacts: API provider test suite, API demonstrator 

 

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)

 

Release version: GP Connect API 1.2.5-beta
Release date: 15 October 2019
Containing capabilities: Appointment Management, Access Record Structured
Artefacts: API provider test suite, API demonstrator

 

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.3.1
Release date: 11 September 2019
Release notes: API release notes 1.3.1
Containing capabilities: Appointment Management, Access Record Structured
Artefacts: API provider test suite, API demonstrator

 

Release version: GP Connect API 1.2.4-beta
Release date: 30 August 2019
Containing capabilities: Appointment Management, Foundations, Access Record Structured
Artefacts: 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 release notes 1.3.0-beta,  API provider test suite 1.3.0-beta,  API demonstrator

 

Release version: GP 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 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 release notes 1.2.2, API 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 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 release notes 1.2.0, API 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 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 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 release notes 1.0.0,  API provider test suite 1.0.0

GP Connect API 0.x versions

Release version:  GP Connect API 0.5.3
Release date: 23 April 2019
Release notes: API releases notes 0.5.3
Containing capabilities: Access Record HTML
Artefacts: API provider test suite 0.5.3,  API demonstrator
 

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, API demonstrator

 

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

 

Release version:  GP Connect API 0.7.1
Release date: 4 February 2019 
Containing capabilities: Access Record HTML
Artefacts: 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 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 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 release notes 0.5.0 , API provider test suite 0.5.0

GP Connect Messaging 1.x versions

Release version: GP Connect Messaging 1.3.2
Release date: 25 May 2022
Release notes: Messaging release notes 1.3.2
Containing capabilities: Send Document
Artefacts: No artefacts available

 

Release version: GP Connect Messaging 1.3.1
Release date: 30 April 2021
Release notes: Messaging release notes 1.3.1
Containing capabilities: Send Document
Artefacts: No artefacts available

 

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

 

Release version: GP Connect Messaging 1.1.0
Release date: 21 September 2018
Containing capabilities: Send Document
Artefacts: 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 release notes 1.0.0

GP Connect Messaging 2.x versions

Release version: GP Connect Messaging 2.0.0
Release date: 26 August 2022
Release notes: Messaging release notes 2.0.0
Containing capabilities: Send Document
Artefacts: No artefacts available

Last edited: 23 September 2025 4:26 pm