This repository contains adaptors which accelerate integration with national NHS systems.
These adaptors hide the complexity of integration with the interfaces provided by the current national systems by implementing an adaptor layer. The integrating supplier sees only a simplified and standardised set of interfaces which the adaptor layer presents. The adaptor layer is responsible for interacting with the legacy NHSD interface estate.
In the diagram below, NHS Digital are providing the set of adaptors shown as the "Adaptor Layer". This list of adaptors shown here is only a representative sample of those planned.
A supplier is therefore required only to implement a simplified set of standard clients to the adaptor layer, integrating with a simplified and standardised set of interfaces exposed by the Adaptor layer. This set of clients is shown in the "Interface Layer".
As a result, the complexity of integration work is much reduced. The integrating supplier is required to implement a minimum set of client types in their interface layer and can re-use this code across multiple integrations.
This repository contains the following directories:
- common - A Python package containing components and utilities that are common to several integration adaptors.
- documentation - Documentation and assets for the integration adaptors as a whole.
- mhs - A pre-assured implementation of a Message Handling Service (MHS), that encapsulates the details of Spine messaging and provides a simple interface to allow HL7 messages to be sent to the NHS spine MHS.
- pipeline - Scripts and configuration files used to build container images for adaptors and deploy them to various environments. Intended for use as part of an automated build pipeline, or may be run seperately.
- SCR - A package of assets that simplify the building of HL7 GP Summary Update request messages.
- SCRWebservice - An application that uses the SCR package to build GP summary upload HL7 messages, forwards the message to the MHS, parses the success response and returns the parsed details to the supplier
- supplier-example - An example web application that uses the assets from the SCR package to generate a GP Summary Update request and send it to an instance of the MHS reference implementation. Intended to show how the adaptors can be used together to simplify integration.
Each directory contains its own README.md file which provides more details.
It may be useful to run these adaptors in a local environment. Please refer to running the MHS and SCR adators locally a step-by-step guide on how to set this up.