/
GP Connect (Patient Facing) APIs to support New Market Entrants

GP Connect (Patient Facing) APIs to support New Market Entrants

ID

RM199

Version

2.0.0

Type

Roadmap Item

Contracting Vehicle(s)

Title

GP Connect (Patient Facing) APIs to support New Market Entrants

Description

Introduction of new GP Connect (Patient Facing) APIs to support New Market Entrant Providers and Consumers

Date Added

Feb 9, 2024

Standards and Capabilities

Patient Information Maintenance - GP, Interoperability Standard, IM1 Standard, Prescription Ordering - Citizen, View Record - Citizen

Change Route

Managed Capacity - Minor/Patch uplifts

Change Type

Uplift

Status

Closed

Publication Date

Sep 5, 2025

Effective Date

Sep 19, 2025

Incentives / Funding

No

Incentive / Funding Dates

N/A

Background

Patient Facing Services (PFS) ensure that Citizens (Patients and their Proxies) have the tools to access information and services digitally, so they can more actively participate in managing their own health and care. GP Connect (Patient Facing) APIs will allow all Patients and their Proxies to view a Patient’s detailed Electronic Patient Record (EPR) and order their repeat Prescriptions.

There is no single Standard across all GP systems for extracting the Electronic Patient Record (EPR) for PFS. Interface Mechanism 1 (IM1) is the current option for providing PFS APIs from Foundation Solutions. IM1 PFS interfaces, created by the Foundation Suppliers, are based on high level functional specifications rather than technical Standards aligned to interoperability Standards. PFS Consumers cannot integrate in a standardised way with Foundation Suppliers so undertake a separate development with each Supplier. Consumers must apply significant development time and effort to integrate with each differing bespoke API, which introduces technical complexity and inconsistency and negatively impacts New Market Entrants (NMEs) and innovation.

The GP Connect-based PFS APIs have therefore been developed to remove these barriers by providing a single, standardised set of technical requirements that every Provider and Consumer can adopt, enabling consistent integration.

Some existing requirements have been refined due to these changes, and to ensure consistency with the wider Capabilities & Standards model.

Outline Plan

A number of new GP Connect (Patient Facing) APIs are being developed:

  • Prescriptions - FHIR API

  • User Permissions API

  • Access Record - FHIR API

The GP Connect (Patient Facing) API specifications will continue to be uplifted so that they all adhere to the future specifications that are deemed appropriate and fit for purpose. The requirements for these APIs will be added via separate Roadmap Items.

This Roadmap Item will establish that:

  • NME Provider Solutions MUST only deliver GP Connect (Patient Facing) APIs

  • NME and Incumbent Consumer Solutions may deliver either IM1 - Interface Mechanism Standard (Patient interface Consumer requirements) or GP Connect (Patient Facing) APIs, this will be driven by what is currently supported by the GP Provider Solution

Note: Incumbent GP Provider Suppliers compliance is not impacted by this change, but they should read the content of this Roadmap Item for awareness.

Summary of Change

Provider Solutions

Patient Information Maintenance - GP: E00166, E00170, E00171, E00172 and E00174 updated

Patient Information Maintenance - GP: E00166, E00170, E00171, E00172 and E00174 updated

E00166 - manage Citizen Service Aaccess for a Patient

As a Health or Care Professional

I want to manage Citizen Service Aaccess for Patients

So that Patients have access to Citizen Services

Acceptance criterion 1: enable Citizen Service Aaccess for a Patient

Given the Health or Care Professional is permitted to enable Citizen Service Aaccess

When the Health or Care Professional selects to enable Citizen Service Aaccess for a Patient

Then the Citizen Service Aaccess is enabled for that Patient

Acceptance criterion 2: disable Citizen Service Aaccess for a Patient

Given the Health or Care Professional is permitted to disable Citizen Service Aaccess

When they the Health or Care Professional selects to disable Citizen Service Aaccess for a Patient

Then the Citizen Service Aaccess is disabled for that Patient

Acceptance criterion 3: create Verified User Accounts

Given the Health or Care Professional is permitted to create Verified User Accounts

When they select to create a Verified User Account for a Patient

Then the Verified User Account is created for that Patient

Acceptance criterion 4: amend Verified User Accounts

Given the Health or Care Professional is permitted to amend Verified User Accounts

When they select to amend a Verified User Account for a Patient

Then the Verified User Account is amended for that Patient

Acceptance criterion 5: view Verified User Accounts

Given the Health or Care Professional is permitted to view Verified User Accounts

When they select to view a Verified User Account for a Patient

Then the Verified User Account is displayed for that Patient

Acceptance criterion 6: generate Verified User Accounts credentials information

Given the Health or Care Professional is permitted to generate Verified User Account credentials information for a Patient

When the Health or Care Professional selects to generate Verified User Account credentials information for a Patient

Then the Practice ODS Code is generated

And the Verified User Accounts ID is generated

And the Verified User Accounts Linkage Key is generated

And a list of available Citizen Services is generated

And a list of Solutions providing a Citizen Service which integrate with the Patient Information Maintenance Solution is generated

And the Verified User Account credentials information is shared with the Patient

Acceptance criterion 7: link Verified User Accounts to Online Service Accounts

Given the Health or Care Professional has created a Verified User Account credentials for a Patient

When the Patient enters their Verified User Account credentials selects to link their Online Service Account with their Verified User Account

Then the Online Service Account is linked to their Verified User Account

E00166 - Additional Implementation Details

Solutions MUST comply with the following when implementing this Epic:

  • Access to Citizen Services will be disabled immediately for deceased or otherwise deducted Patients

  • Suppliers of new Solutions:

    • GP Connect (Patient Facing) User Permissions Standard (Provider requirements)

  • Suppliers of Solutions which ARE currently deployed into an operational environment:

    • IM1 - Interface Mechanism Standard (Patient interface Provider requirements) or GP Connect (Patient Facing) User Permissions Standard (Provider requirements)

    • Ability to create, view and amend Verified User Accounts

    • Ability to generate Verified User Accounts credentials information to be shared with the Patient:

      • ODS Code

      • Verified User Accounts ID

      • Verified User Accounts Linkage Key

      • List of available Citizen Services

      • List of Solutions providing a Citizen Service which integrate with the Patient Information Maintenance Solution

      • Include the standard information text and URLs when generating VUA credentials information as defined on Information for GP IT Foundation Suppliers

    • Support linking of Online Service Account and Verified User Account

    • The Solution supports the resetting of the VUA Linkage Key as requested, both

      • Via the Citizen Service Solution, or

      • By a Health or Care Professional via their Solution

    • Upon reset request, the VUA reverts to a Status of Inactive and all access to Citizen Services terminated

E00166 - Supporting Information

  • Further information on Citizen Services can be found in the Citizen Services Implementation Guidance

E00170 - manage Prescription Ordering Citizen Service access for a Patient and the Practice

As a Health or Care Professional

I want to be able to manage Patient access to the Prescription Ordering Citizen Service

So that I can manage Patient access to Prescription Ordering Citizen Service for Repeat Medication

Acceptance criterion 1: enable Patient access to the Prescription Ordering Citizen Service

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to enable the Patient’s access to the Prescription Ordering Citizen Service

Then access to the Prescription Ordering Citizen Service is enabled for the Patient

Acceptance criterion 2: disable Patient access to the Prescription Ordering Citizen Service

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to disable the Patient’s access to Prescription Ordering

Then access to the Prescription Ordering Citizen Service is disabled for the Patient

Acceptance criterion 3: enable Prescription Ordering Citizen Service for the Practice

Given the Health or Care Professional is permitted to enable a Citizen Service for the Practice

When they the Health or Care Professional selects to enable the Prescription Ordering Citizen Service for the Practice

Then the Prescription Ordering Citizen service is enabled for the Practice

Acceptance criterion 4: disable Prescription Ordering Citizen Service for the Practice

Given the Health or Care Professional is permitted to disable a Citizen Service for the Practice

When they the Health or Care Professional selects to disable the Prescription Ordering Citizen Service for the Practice

Then the Prescription Ordering Citizen Service is disabled for the Practice

E00170 - Additional Implementation Details

Solutions MUST comply with the following when implementing this Epic:

  • Suppliers of new Solutions:

    • GP Connect (Patient Facing) Prescriptions Standard (Provider requirements)

  • Suppliers of Solutions which ARE currently deployed into an operational environment:

    • IM1 - Interface Mechanism Standard (Patient interface Provider requirements) or GP Connect (Patient Facing) Prescriptions Standard (Provider requirements)

E00170 - Supporting Information

  • Further information on the Prescription Ordering Citizen Service can be found in the Prescription Ordering - Citizen Capability and Citizen Services Implementation Guidance

E00171 - manage View Record Citizen Service Aaccess for the Practice

As a Health or Care Professional

I want to be able to manage access to the View Record Citizen Service for the Practice

So that I can manage access to View Record Citizen Service

Acceptance criterion 1: enable access to the Summary Information Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to enable access to the Summary Information Record Level for the Practice

Then the Summary Information Record Access Level is enabled for the Practice

Acceptance criterion 2: disable access to the Summary Information Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to disable access to the Summary Information Record Access Level for the Practice

Then the Summary Information Record Access Level is disabled for the Practice

Acceptance criterion 3: enable access to the Detailed Coded Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to enable access to the Detailed Coded Record Access Level for the Practice

Then the Detailed Coded Record Access Level is enabled for the Practice

Acceptance criterion 4: disable access to the Detailed Coded Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to disable a Patient’s access to the Detailed Coded Record Access Level for the Practice

Then the Detailed Coded Record Access Level is disabled for the Practice

Acceptance criterion 5: enable access to the Document Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

And the Detailed Coded Recorded Access Level is enabled

When they the Health or Care Professional selects to enable access to the Document Access Level for the Practice

Then the Document Access Level is enabled for the Practice

Acceptance criterion 6: disable access to the Document Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to disable access to the Document Access Level for the Practice

Then the Document Access Level is disabled for the Practice

Acceptance criterion 7: enable access to the View Record Full Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to enable access to the View Full Record Level Access Level for the Practice

Then they can record a start date for data to be available from

Then And the View Record Full Record Access Level is enabled for the Practice

Acceptance criterion 8: disable access to the View Record Full Record Access Level for the Practice

Given the Health or Care Professional is permitted to configure access to Citizen Services for the Practice

When they the Health or Care Professional selects to disable a Patient’s access to the a View Record Full Record Access Level for the Practice

Then the View Record Full Record Access Level is disabled for the Practice

E00171 - Additional Implementation Details

Solutions MUST comply with the following when implementing this Epic:

  • The Record Access level for a Citizen will not exceed the configured Record Access Level for the Practice

  • Suppliers of new Solutions:

    • GP Connect (Patient Facing) Access Record Standard (Provider requirements)

  • Suppliers of Solutions which ARE currently deployed into an operational environment:

    • IM1 - Interface Mechanism Standard (Patient interface Provider requirements) or

      GP Connect (Patient Facing) Access Record Standard (Provider requirements)

E00171 - Supporting Information

  • The start date determines the date from which the data made available goes back to, not whether the Service is offered/available by the Practice e.g. where the Full Record Access start date is set to 15th March 2015 and the Full Record Access is enabled (‘switched on’) by the Practice on the 1st April 2015

  • Further information on the View Record Citizen Service can be found in the View Record - Citizen Capability and Citizen Services Implementation Guidance

E00172 - manage View Record Citizen Service Aaccess for a Patient

As a Health or Care Professional

I want to be able to manage access to the View Record Citizen Service for individual Patients

So that I can manage Patient access to View Record Citizen Service

Acceptance criterion 1: enable Patient access to the Summary Information Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to enable the Patient’s access to the Summary Information Record Level

Then the Summary Information Record Access Level is enabled for the Patient

Acceptance criterion 2: disable Patient access to the Summary Information Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to disable a Patient’s access to the Summary Information Record Access Level

Then the Summary Information Record Access Level is disabled for the Patient

Acceptance criterion 3: enable Patient access to the Detailed Coded Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to enable the Patient’s access to the Detailed Coded Record Access Level

Then the Detailed Coded Record Access Level is enabled for the Patient

Acceptance criterion 4: disable Patient access to the Detailed Coded Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to disable a Patient’s access to the Detailed Coded Record Access Level

Then the Detailed Coded Record Access Level is disabled for the Patient

Acceptance criterion 5: enable Patient access to the Document Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

And the Detailed Coded Recorded Access Level is enabled

When they the Health or Care Professional selects to enable the Patient’s access to the Document Access Level

Then the Document Access Level is enabled for the Patient

Acceptance criterion 6: disable Patient access to the Document Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to disable a Patient’s access to the Document Access Level

Then the Document Access Level is disabled for the Patient

Acceptance criterion 7: enable Patient access to the View Record Full Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to enable the Patient’s access to the View Full Record Level Access Level

Then they can record a start date for data to be available from

Then And the View Record Full Record Access Level is enabled for the Patient

Acceptance criterion 8: disable Patient access to View Record Full Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When they the Health or Care Professional selects to disable a Patient’s access to the a View Record Full Record Access Level

Then the View Record Full Record Access Level is disabled for the Patient

Acceptance criterion 9: enable Prospective Access to the Full Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When the Health or Care Professional selects to enable Prospective Access to the Full Record Access Level for a Patient

Then the Health or Care Professional records a start date for data to be available from

And the Prospective Access to the Full Record Access Level is enabled for the Patient

Acceptance criterion 10: disable Prospective Access to the Full Record Access Level for a Patient

Given the Health or Care Professional is permitted to configure access to Citizen Services

When the Health or Care Professional selects to disable Prospective Access to the Full Record Access Level for a Patient

Then the Prospective Access to the Full Record Access Level is disabled for the Patient

E00172 - Additional Implementation Details

Solutions MUST comply with the following when implementing this Epic:

  • The Record Access Level for a Patient will not exceed the configured Record Access Level for the Practice

  • Suppliers of new Solutions:

    • GP Connect (Patient Facing) Access Record Standard (Provider requirements)

  • Suppliers of Solutions which ARE currently deployed into an operational environment:

    • IM1 - Interface Mechanism Standard (Patient interface Provider requirements) or

      GP Connect (Patient Facing) Access Record Standard (Provider requirements)

E00172 - Supporting Information

  • The start date for Prospective Access to the Full Record Access Level determines the date from which the data made available goes back to, not whether the Service is offered/available by the Practice e.g. where the Prospective Access to the Full Record Access Level start date is set to 15th March 2015 and the Full Record Access Level is enabled (‘switched on’) by the Practice on the 1st April 2015

  • Further information on the View Record Citizen Service can be found in the View Record - Citizen Capability and Citizen Services Implementation Guidance

E00174 - configure access to elements of the Electronic Patient Record (EPR) in the View Record Citizen Service

As a Health or Care Professional

I want to record that elements of the Electronic Patient Record (EPR) are Restricted from View Record

So that elements recorded as Restricted from View Record are not displayed to Citizens via the View Record Citizen Service

Acceptance criterion 1: record existing elements of the Electronic Patient Record (EPR) as Restricted from View Record Citizen Service upon review

Given the Health or Care Professional is permitted to review the Electronic Patient Record (EPR)

When they the Health or Care Professional selects to record an existing element of the Electronic Patient Record (EPR) as Restricted from View Record

Then this element is recorded as Restricted from View Record

And it is not displayed in Citizen Services

Acceptance criterion 2: record elements of the Electronic Patient Record (EPR) as Restricted from View Record Citizen Service whilst entering information

Given the Health or Care Professional is permitted to enter information into the Electronic Patient Record (EPR)

When they the Health or Care Professional enters information into the Electronic Patient Record (EPR)

And the Health or Care Professional selects to record an element of this information as Restricted from View Record

Then this element is recorded as Restricted from View Record

And it is not displayed via the View Record Citizen Service

Acceptance criterion 3: indicate Restricted from View Record elements to Health or Care Professionals

Given the Health or Care Professional is permitted to view the Electronic Patient Record (EPR)

And there are elements of the Electronic Patient Record (EPR) that have been recorded as Restricted from View Record

When the Health or Care Professional selects to view the Electronic Patient Record (EPR)

Then the Health or Care Professional can view that these elements are Restricted from View Record

Acceptance criterion 4: update elements recorded as Restricted from View Record as available for View Record

Given the Health or Care Professional is permitted to view the Electronic Patient Record (EPR)

And there are elements of the Electronic Patient Record (EPR) that have been recorded as Restricted from View Record

When the Health or Care Professional selects to record an element as available for View Record

Then this element is recorded as available for the View Record Citizen Service

And it is displayed via the View Record Citizen Service

E00174 - Additional Implementation Details

Solutions MUST comply with the following when implementing this Epic:

  • Ability for Health or Care Professionals to record any type of element recorded in the Electronic Patient Record (EPR) as Restricted from View Record Citizen Service

E00174 - Supporting Information

  • Elements of the Electronic Patient Record (EPR) MAY include, but are not limited to:

    • An Electronic Patient Record (EPR) (as a whole)

    • Groups of elements of an Electronic Patient Record (EPR) e.g. an entire consultation, documents and all associated read coded information

    • Individual elements e.g. a code, a medication

  • Examples of when a Health or Care Professional MAY need to record an element of the Electronic Patient Record (EPR) as Restricted from view include, but are not limited to:

    • When reviewing Pathology results

    • When reviewing Radiology results

    • When reviewing external documents