GP Connect specifications for developers

Directory of GP Connect specifications and associated artefacts.

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?

Image showing GP Connect specifications

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.

GP Connect API 0.7.3 - contains: Access Record HTML

Release version: GP Connect API 0.7.3
Release date: 7 May 2020
Release notes: API release notes 0.7.3
Containing capabilities: Access Record HTML
Artefacts: API provider test suite, API demonstrator

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.

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

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 2 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.

Phase 1 - 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.

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

Phase 2 – Medicines, Allergies. Uncategorised, Investigations, Referrals, Diary Entries and Immunisations, Problems, Consultations

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

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 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 API 1.5.0-beta – contains Access Document

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 Document

Artefacts: API provider test suite, API demonstrator

GP2GP functionality through Access Structured Record

This capability enables GP2GP record transfers to be performed using the Access Structured Record capability.

Current specification

This is the latest version of the specification that Provider 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 API 1.6.0-beta – contains Access Document, Access Record Structured and GP2GP

Release version: GP Connect API 1.6.0-beta

Release date: 30 June 2021

Release notes: API release notes 1.6.0-beta

Containing capabilities: Access Document, Access Record Structured and GP2GP

Artefacts: API provider test suite, API demonstrator

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.

GP Connect Messaging 1.3.0 - contains: Send Document

Release version: GP Connect Messaging 1.3.0

Release date: 30 April 2021

Release notes: Messaging release note 1.3.0

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 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 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 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 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.2, 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 specification 1.2.1, 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 specification 1.2.0, 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 specification 1.1.1, 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 specification 1.1.0, 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 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.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 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.1, 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 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.0, 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 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.0, Messaging release notes 1.0.0

Last edited: 2 July 2021 9:13 am