Versions Compared

Key

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

ID

S74

Version

1.0.2.0

Type

Interoperability Standard

Status

DraftEffective

Effective Date

TBC

Excerpt
hiddentrue

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

...

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

Req ID

Requirement Text

Level

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

ISNFR02

The 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

ISNFR05

Discrepancies 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

ISNFR06

Discrepancies discovered between ISNFR03 documentation and actual interfaces will be rectified within 5 working days of first notification to the interface provider

Status
colourRed
titleMUST

ISNFR07

Within 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

ISNFR09

Suppliers to provide Patient/Service User level data about a specific Patient/Service User upon request from the healthcare organisation.

Status
colourRed
titleMUST

...

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

Two specific Spine components are key supporting standards for a number of the interop standards, 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.

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)

...