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 

MUST

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 Information Governance requirements and specific message flow requirements to ensure that support desks have access to the required information when investigating incidents/issues

MUST

ISNFR03

Suppliers will publicly publish full documentation (location determined by Supplier) 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

MUST

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

MUST

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

SHOULD

ISNFR06

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

MUST

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

MUST

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

SHOULD

ASNFR01

Data 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

SHOULD

ASNFR02

Data currency

Updates made through APIs must be available on APIs in real time, i.e. as soon as the update transaction is committed

MUST

Items on the Roadmap which impact or relate to this Capability