Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties


IDS32
Version12.0.0
TypeInteroperability Standard
StatusEffective
Effective Date 




Excerpt
hiddentrue

Defines a comprehensive set of standards, interfaces and protocols that Solutions and systems will use when interoperating.


Table of Contents

Introduction

This standard replaces General Practice Systems of Choice (GPSoC) requirements relating to integration and interoperability. It provides a single place for system suppliers to find out which interfaces they need to implement and to access the required documentation.

Future changes to interfaces will be communicated via the Roadmap.

Notes on quality and consistency of interface documentation

There are a large number of interfaces that GP systems need to implement. These interfaces, and their documentation, have been created over a very long period of time by a number of different organisations and programmes. The static nature of the GP systems market (no new entrants needing to implement) means that historically there has been limited justification and appetite for modernising or standardising existing documentation. This means that the format, quality and consistency of interface documentation is currently extremely variable.

Until these issues can be addressed suppliers and system implementers should expect to encounter issues with interface documentation. These could include:

  • Inconsistencies in how optionality of requirements is expressed, e.g. MoSCoW ratings
  • References to obsolete or outdated externalities, e.g. in-force legal frameworks, organisations or systems
  • Descriptions of 'upcoming' or planned future phases which may or may not have actually occurred
  • Broken links
  • Referenced documents that have been included elsewhere in this standard rather than in the indicated location
  • Referenced documents that interface owners have advised are no longer relevant
  • Unavailable information relating to the impact of upcoming roadmap changes, e.g. where the replacement of existing VUA/OSA/LOSA based patient accounts by Nhs login could impact an interface implementation
  • Verbose and/or difficult to follow documentation compared to modern best practices for interface documentation
  • Unavailable sample files or test data

Suppliers should contact the NHS Digital team at gpitfutures@nhs.net to resolve any documentation issues which block them from delivering compliant implementations.

Interoperability principles

These interoperability principles are a 

Status
colourYellow
titleSHOULD
and suppliers are expected to adhere to them wherever possible.  Whilst adherence will not be assessed at onboarding, NHSD will expect any deviation from these principles to be supported by a valid rationale on delivery of interfaces.  NHSD may use adherence to these principles to guide decision making in circumstances of non-compliance or partial compliance against assured standards.

  1. True interoperability (defined as the ability of two or systems to work together unchanged, even if they weren't designed to work together) rather than integration (change is required to make the systems connect) should be achieved wherever possible - Integration takes work, interoperability just works. Although the term interoperability is in widespread use within the NHS, what is meant is rarely well defined and the terms interoperability and integration are frequently used interchangeably. In our experience, the NHS uses a weak definition where two systems are said to be interoperable if they can exchange data in any way - even if that exchange is via a bespoke, point-to-point integration. True interoperability reduces the integration burden and allows systems to communicate more readily. 

  2. Interoperability is more important than supporting customisation. Use the base definition of standards wherever possible. Extend only by addition and by exception. Do not view integration as a source of competitive advantage.

  3. Use open design. The effectiveness of security components included in a Solution design should not be compromised by any visibility of that design, i.e. should not rely on obscurity.

  4. Use open and government standards. Design systems up front to support information sharing. This covers both alignment with Open Standards and the use of Open APIs. Use open standards (including from outside healthcare), and common government platforms (eg GOV.UK, identity assurance, shared services) where available.

  5. Make data open by default. Whilst minimising and securing personal data, or data restricted for national security reasons. Public data should be made available by default in both human and open machine-readable formats. Users should have access to, and control over how their own personal data is shared.

  6. Use a common data model. Healthcare systems are connected in a many-to-many fashion. In this scenario, the use of a common data model ensures that each system only has to be able to translate to and from the common model and does not need system-specific knowledge of myriad other connected systems.

  7. Messages should always be structured. Adding preformatted ‘human readable’ text or formats such as HTML to messages increases coupling with the source system and reduces the reusability of the message while increasing the risk of a system receiving inappropriate data which cannot be detected. Receiving systems are responsible for transforming structured message into appropriate formats (e.g. HTML, PDF or images etc.). It's always preferable to store the structured data and render to a display format on demand.

  8. Interfaces must be system agnostic and semantically standardised. Systems must not expose their internal complexity and data structures on interfaces, nor should they expect systems they interface with to understand their internal data encodings and semantics.

  9. Use decoupled integration patterns wherever possible. Decoupling should be achieved using appropriate integration patterns such as publish-subscribe and event-based architectures.

Interoperability non-functional requirements

The following overarching requirements apply to all interfaces in the scope of the Interoperability Standard which are offered by a Solution.    

Req IDRequirement TextLevel
ISNFR01

Suppliers will implement uplifts to the message & API specifications included within the interoperability standard as agreed & directed by the ‘Minor or patch changes’ section of the Change Management Process

Status
colourRed
titleMUST

ISNFR02The system will provide comprehensive audit facilities for ALL messages, including acknowledgements, over ALL transports and using ALL message types/syntax in order to satisfy general IG requirements and specific message flow requirements to ensure that support desks have access to the required information when investigating incidents/issues.

Status
colourRed
titleMUST

ISNFR03

Suppliers will publicly publish full documentation for all currently live or in development and available-to-consumers interfaces, under a Creative Commons Attribution-NoDerivatives 4.0 International License. Documentation must include, but is not limited to:

  • Full details of all available endpoints
  • Message structures
  • Code sets
  • Intended interface behaviour, including any sequencing of calls, with pseudo code reference exemplars.
  • Requirements on consumers
  • Error handling
  • Authentication and authorisation requirements
  • Encryption, transport layer security and certificate requirements
Status
colourRed
titleMUST
ISNFR04

For all currently live or in development and available-to-consumers interfaces, suppliers will make available public, mock versions of the interfaces to support consumer development and testing. Mocks must meet the following criteria:

  1. They must cover the full scope of behaviour of the interface
  2. They must offer sufficient fidelity to the live interface to fully support consumer development and testing
    1. Test data/scenarios must be publicly documented, e.g. consumers will be clearly signposted which data they must submit in order to test a particular endpoint, error handling scenario or particular behaviour of the interface
Status
colourRed
titleMUST
ISNFR05Discrepancies discovered between ISNFR04 test mocks and behaviour of live interfaces will be rectified within two working days of first notification to the interface provider
Status
colourYellow
titleSHOULD
ISNFR06Discrepancies discovered between ISNFR03 documentation and actual interfaces will be rectified within 5 working days of first notification to the interface provider
Status
colourRed
titleMUST
ISNFR07Within the scope of interfaces specified within the standard, Suppliers must not offer differential service, e.g all API functionality and behaviour will be equally available to all API consumers, including the API provider's own apps.
Status
colourRed
titleMUST
ISNFR08

Suppliers should not offer multiple APIs for the same purpose, e.g. there should not be multiple, different Appointments Booking APIs. Suppliers are free to offer APIs to different consumers under different commercial terms if permitted by the contract and framework, but they should offer only one technical API for each purpose.

Status
colourYellow
titleSHOULD

Minimum non-functional requirements for interfaces built to the Authority's specifications

Where an interface/extract is built to the Authority's functional specifications, e.g. IM1 - Interface MechanismGP Connect the following requirements apply to the production implementation. For requirements relating to performance and availability suppliers should refer to the Service Level Agreement.

Req IDRequirement TextLevel
ASNFR01Data currency. Updates to systems made through non-API mechanisms (e.g. user interface) should be available on APIs in real time, i.e. as soon as the update transaction is committed.
Status
colourYellow
titleSHOULD
ASNFR02Data currency. Updates made through APIs must be available on APIs in real time, i.e. as soon as the update transaction is committed.
Status
colourRed
titleMUST

Capability-independent interoperability standards

This section lists the interoperability requirements which are not linked to single capabilities. These are typically (but not exclusively) supporting standards such as communications protocols or related technical standards.

Spine

The NHS Spine provides national interoperability infrastructure as well as specific national services, for example the Personal Demographics Service (PDS) listed further below under Dependencies. 

Two specific Spine components are key supporting standards for a number of the interop standards, and are listed multiple times within the 'Dependencies' column below. They are:

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 Framework). The interface mechanism facilitates three use-cases (Patient, Bulk and Practice) which are detailed within the IM1 page.

A system or application may wish to consume IM1 interfaces where they have a requirement to access data held in GP Systems.

A system or application is required to provide IM1 interfaces if ANY of the following are true:

  • It offered IM1 interfaces under GPSoC
  • It offers ALL Foundation capabilities under GP IT Futures

Authentication and authorisation

Standards for confirming the identity of service users and controlling their access to services or specific resources.

Communications

  • Email (system accounts for automated sending for purposes such as notifications)

Generic FHIR Receiver 

Capability-specific interoperability standards

This section details the interoperability requirements which are associated with each Capability. 

Some interdependencies between individual interface standards exist. Creating a compliant implementation requires implementing all the required dependent interface standards, as detailed in the 'Dependencies' column.

Suppliers need to comply with all of the requirements that are associated with the Capability/Capabilities which the supplier is offering. 

Foundation Capabilities

Patient Information Maintenance

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements (if offering all Foundation capabilities)
NHAIS HA/GP Links v1.0.0
Personal Demographics Service (PDS)

Insert excerpt
Personal Demographics Service (PDS)
Personal Demographics Service (PDS)
nopaneltrue

GP2GP

Insert excerpt
GP2GP
GP2GP
nopaneltrue

Summary Care Record (SCR)

Insert excerpt
Summary Care Record (SCR)
Summary Care Record (SCR)
nopaneltrue

GP Connect Access Record API
GP Connect Messaging Send Document
111
Insert excerpt
111
111
nopaneltrue
GPES Data Extraction
Insert excerpt
GPES Data Extraction
GPES Data Extraction
nopaneltrue
Secure Electronic File Transfer (SEFT) (in order to meet Primary Care Clinical Terminology Usage Report)
Digital Medicines and Pharmacy FHIR Payload

Generic FHIR Receiver

GP Data for Planning and Research

*May alternatively use AWS Direct S3-S3 transfers as the secure transport mechanism

Recording Consultations

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements (if offering all Foundation capabilities)
Electronic Yellow Card Reporting 

Messaging Exchange for Social Care and Health (MESH) (in order to meet eMED3 Fitnotes)


Appointments Management - GP

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements (if offering all Foundation capabilities)
GP Connect Appointments API

Or 

*May be sourced indirectly by existing PDS interface provided by PIM Solution, either via API to PIM Solution, or as a shared application resource if delivered as part of the same Solution.

Messaging Exchange for Social Care and Health (MESH) 

Or 

Secure Electronic File Transfer (SEFT) 

(in order to meet General Practice Appointments Data Reporting)


GP Data for Planning and Research

*May alternatively use AWS Direct S3-S3 transfers as the secure transport mechanism

Prescribing

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements (if offering all Foundation capabilities)
Electronic Prescription Service (EPS) - Prescribing

Insert excerpt
Electronic Prescription Service (EPS) - Prescribing
Electronic Prescription Service (EPS) - Prescribing
nopaneltrue

Referral Management

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements  (if offering all Foundation capabilities)
e-Referral Service (eRS)

Insert excerpt
e-Referrals Service (e-RS)
e-Referrals Service (e-RS)
nopaneltrue

Resource Management

Interoperability RequirementDependencies
IM1 - Interface Mechanism Provider requirements  (if offering all Foundation capabilities)

Non-foundation capabilities

Communication Management

Interoperability RequirementDependencies
Email


Appointments Management - Citizen

Interoperability RequirementDependencies
IM1 - Interface Mechanism (Patient interface Consumer)
Insert excerpt
IM1 - Interface Mechanism
IM1 - Interface Mechanism
nopaneltrue

Prescription Ordering – Citizen

Interoperability RequirementDependencies
IM1 - Interface Mechanism (Patient interface Consumer)
Insert excerpt
IM1 - Interface Mechanism
IM1 - Interface Mechanism
nopaneltrue

View Record - Citizen

Interoperability RequirementDependencies
IM1 - Interface Mechanism (Patient interface Consumer)
Insert excerpt
IM1 - Interface Mechanism
IM1 - Interface Mechanism
nopaneltrue

Digital Diagnostics

Interoperability RequirementDependencies
Digital Diagnostics & Pathology Messaging
Insert excerpt
Digital Diagnostics & Pathology Messaging
Digital Diagnostics & Pathology Messaging
nopaneltrue
Screening messaging
Insert excerpt
Screening messaging
Screening messaging
nopaneltrue

Communicate with Practice - Citizen

Interoperability RequirementDependencies
IM1 - Interface Mechanism (Patient interface Consumer) 
Insert excerpt
IM1 - Interface Mechanism
IM1 - Interface Mechanism
nopaneltrue

Capabilities to support new ways of working

Cross-organisation Appointment Booking

Interoperability RequirementDependencies
GP Connect (Appointments)

Or 

*May be sourced indirectly by existing PDS interface provided by PIM Solution, either via API to PIM Solution, or as a shared application resource if delivered as part of the same Solution.

Unified Care Record

Interoperability RequirementDependencies
GP Connect (Access Record) 

Or 

*May be sourced indirectly by existing PDS interface provided by PIM Solution, either via API to PIM Solution, or as a shared application resource if delivered as part of the same Solution.

Medicines Verification

Interoperability RequirementDependencies
National Medicines Verification System

Medicines Optimisation

Interoperability Requirement

GP Connect (Access Record) (Medication FHIR Resources)



Deprecated Standards

Roadmap

Page Properties Report
headingsStandards and Capabilities, Status, Effective Date, Description, Change Type, Change Route
pageSize300
sortByEffective Date
cqllabel = "interop_standards" and space = "GPITF"