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

Owned by Michael France
Last updated: 21-10-2024Version comment
24 min read

ID

RM199

Version

1.0.3

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, Appointments Management - Citizen, Communicate With Practice - Citizen

Change Route

Managed Capacity - Minor/Patch uplifts

Change Type

Uplift

Status

Draft

Publication Date

TBC

Effective Date

TBC

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.

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 Provider Solution

Note: Incumbent 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 services or Solutions:

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

    • IM1 - Interface Mechanism Standard (Patient interface 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

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:

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

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

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

Interoperability Standard: Capability-independent interoperability Standards section updated

Interoperability Standard: Capability-independent interoperability Standards section updated

IM1 - Interface Mechanism

IM1 - Interface Mechanism is a mechanism for accessing data held in GP Systems (Systems providing one or more Capabilities as part of the GP IT Futures Contracting Vehicle. The interface mechanism facilitates three use-cases (Patient, Bulk and Practice) which are detailed within the IM1 page.

A system or application is required to provide IM1 interfaces if ANY of the following are true: it offered IM1 interfaces under GPSoC GP IT Futures.

  • It offers ALL Foundation Capabilities

Where a GP Connect interface capability is available, Provider Suppliers would be expected to develop against that, rather than developing a new bespoke or proprietary interface.

A system or application may wish to consume IM1 interfaces where they have a requirement to access data held in GP Systems and the Provider Solution does not offer a GP Connect interface.

IM1 Standard: Applicability section updated

IM1 Standard: Applicability section updated

Applicability

A system or application is required to provide IM1 interfaces if ANY of the following are true: it offered IM1 interfaces under GPSoC GP IT Futures.

Where a GP Connect interface capability is available, Provider Suppliers would be expected to develop against that, rather than developing a new bespoke or proprietary interface.

A system or application may wish to consume IM1 interfaces where they have a requirement to access data held in GP Systems and the Provider Solution does not offer a GP Connect interface.

GP Connect (Patient Facing) Prescriptions: new Standard added

GP Connect (Patient Facing) Prescriptions: new Standard added

New Standard added, see Full Specification.

GP Connect (Patient Facing) Access Record: new Standard added

GP Connect (Patient Facing) Access Record: new Standard added

New Standard added, see Full Specification.

GP Connect (Patient Facing) User Permission: new Standard added

GP Connect (Patient Facing) User Permission: new Standard added

New Standard added, see Full Specification.

Consumer Solutions

Prescription Ordering - Citizen: E00327, E00328 and E00313 updated

Prescription Ordering - Citizen: E00327, E00328 and E00313 updated

E00327 - Patient viewing Repeat medications

As a Patient

I want to view my Repeat medications using Citizen Services

So that I can view the Repeat medications I can request to be issued

Acceptance criterion 1: view Repeat Medications

Given the Patient is enabled for the Prescription Ordering Citizen Service

When the Patient selects to view their Repeat medications

Then the Patient’s Repeat medications are displayed

And the name for each medication is displayed

And the strength for each medication is displayed

And the form for each medication is displayed

And the dose for each medication is displayed

And the date of the most recent issue for each medication is displayed

And the duration for each medication is displayed

E00328 - Patient managing requests for a Repeat medication to be issued

As a Patient

I want to manage my requests for Repeat medication to be issued using Citizen Services

So that I can manage requests for my Repeat medications to be issued

Acceptance criterion 1: create a request for a Repeat medication to be issued

Given the Patient is enabled for the Prescription Ordering Citizen Service

When the Patient selects to request for a Repeat medication to be issued

And the Patient does not have any existing pre-authorised issues outstanding for the Repeat medication

Then the request is created

Acceptance criterion 2: view outstanding requests for Repeat medications to be issued

Given the Patient is enabled for the Prescription Ordering Citizen Service

When the Patient selects to view outstanding requests for Repeat medications to be issued

Then the outstanding requests are displayed

Acceptance criterion 3: cancel an outstanding request for a Repeat medication to be issued

Given the Patient is enabled for the Prescription Ordering Citizen Service

When the Patient selects to cancel a request for a Repeat medication to be issued

Then the request is cancelled

E00313 - request to amend my Citizen Service Access

As a Citizen

I want to submit a request to amend my Citizen Service Access

So that I can request changes to the Citizen Services I have access to

Acceptance criterion 1: request to amend Citizen Service Access

Given the Citizen is enabled for Citizen Services

When the Citizen submits a request to amend their Citizen Service Access

Then the Citizen’s request is submitted to the Healthcare Organisation

View Record - Citizen: E00357, E00358, E00359, E00360 and E00313 updated

View Record - Citizen: E00357, E00358, E00359, E00360 and E00313 updated

E00357 - Patient viewing Summary Information Record

As a Patient

I want to view my Summary Information Record

So that I can see a summary of the information from my Electronic Patient Record (EPR)

Acceptance criterion 1: view Summary Information Record

Given the Patient is enabled for the View Record Citizen Service

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

When the Patient selects to view the Summary Information Record

Then the Summary Information Record is displayed

E00358 - Patient viewing Detailed Coded Record

As a Patient

I want to view my Detailed Coded Record

So that I can see coded data from my Electronic Patient Record (EPR)

Acceptance criterion 1: view Detailed Coded Record

Given the Patient is enabled for the View Record Citizen Service

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

When the Patient selects to view the Detailed Coded Record

Then the Detailed Coded Record is displayed

E00359 - Patient viewing documents from Electronic Patient Record (EPR)

As a Patient

I want to view documents from my Electronic Patient Record (EPR)

So that I can see the documents from my Electronic Patient Record (EPR)

Acceptance criterion 1: view documents from Electronic Patient Record (EPR)

Given the Patient is enabled for the View Record Citizen Service

And the Patient is enabled for the Document Access Level

When the Patient selects to view a document from their Electronic Patient Record (EPR)

Then the document is displayed

E00360 - Patient viewing Full Patient Record

As a Patient

I want to view my Full Patient Record

So that I can see all available information from my Electronic Patient Record (EPR)

Acceptance criterion 1: view Full Patient Record

Given the Patient is enabled for the View Record Citizen Service

And the Patient is enabled for the Full Record Access Level

When the Patient selects to view the Full Patient Record

Then the Full Patient Record is displayed

E00313 - request to amend my Citizen Service Access

As a Citizen

I want to submit a request to amend my Citizen Service Access

So that I can request changes to the Citizen Services I have access to

Acceptance criterion 1: request to amend Citizen Service Access

Given the Citizen is enabled for Citizen Services

When the Citizen submits a request to amend their Citizen Service Access

Then the Citizen’s request is submitted to the Healthcare Organisation

Appointments Management - Citizen: E00313 updated

Appointments Management - Citizen: E00313 updated

E00313 - request to amend my Citizen Service Access

As a Citizen

I want to submit a request to amend my Citizen Service Access

So that I can request changes to the Citizen Services I have access to

Acceptance criterion 1: request to amend Citizen Service Access

Given the Citizen is enabled for Citizen Services

When the Citizen submits a request to amend their Citizen Service Access

Then the Citizen’s request is submitted to the Healthcare Organisation

Communicate With Practice - Citizen: E00313 updated

Communicate With Practice - Citizen: E00313 updated

E00313 - request to amend my Citizen Service Access

As a Citizen

I want to submit a request to amend my Citizen Service Access

So that I can request changes to the Citizen Services I have access to

Acceptance criterion 1: request to amend Citizen Service Access

Given the Citizen is enabled for Citizen Services

When the Citizen submits a request to amend their Citizen Service Access

Then the Citizen’s request is submitted to the Healthcare Organisation

Full Specification

The new GP Connect (Patient Facing) Prescriptions, GP Connect (Patient Facing) Access Record and GP Connect (Patient Facing) User Permissions Standard will be added at a later date. Proposed changes can be viewed in the Summary of Change above.

Updated versions of Patient Information Maintenance - GP, Prescription Ordering - Citizen, View Record - Citizen, Appointments Management - Citizen, Communicate With Practice - Citizen Capabilities, the Interoperability Standard and IM1 Standard will be added at a later date. Proposed changes can be viewed in the Summary of Change above.

The Citizen Services Implementation Guidance will also be updated at a later date and provided as part of this Roadmap Item.

Assurance Approach

The Assurance Approach for Providers and Consumers will be provided at a later date.