NHS MPI Adapter for QuickFHIR - Local Development build (v1.0.0). See the Directory of published versions

Home

Official URL: https://quickfhir.cloud/docs/blackpear-quickfhir-aws-adapter-nhsmpi/ImplementationGuide/ig				Version: 1.0.0
Draft as of 2023-08-16				Computable Name: NHSMPI

The NHS MPI Adapter for QuickFHIR provides an HL7 FHIR API for the NHS Master Patient Index held by the Patient Demographics Service.

Capabilities

A consumer can search for patients within the NHS MPI and retrieve demographic and organisational information relating to the patient.

Terms of use

The adapter uses components provided by NHS Digital to read data.

The adapter can only be used as part of an ITK accredited product. Contact NHS Digital for more details about accrediting your product.

Where an endpoint is provided as a component of a Black Pear product that has already been accredited by NHS Digital, no further accreditation is required.

Configuration

Endpoint

The service uses TLS-MA to secure connection to the NHS Digital SMSP service.

To make this connection the QuickFHIR Cell must be configured with:

• Passphrase Protected Certificate Archive (PFX) containing the client certificate issued by NHS ITK team for your product.
• Passphrase for the PFX file.

Where an endpoint is provided as a component of a Black Pear product that has already been accredited by NHS Digital, no further information is required.

ITK

Requests to the NHS Digital SMSP service require the following information:

• username: A unique name to identify your organisation
• odscode: The unique organisation code issued by the NHS Organisation Data Service for your organisation.
• asid: The unique Accredited System IDentifier issued by NHS ITK team for your product.

Where an endpoint is provided as a component of a Black Pear product that has already been accredited by NHS Digital, no further information is required.

Organisations

Each organisation requesting information via this adapter in production must have completed assessment against the requirements of the NHS Data Security and Protection Toolkit and met the standards.

The minimum information required for each organisation is the unique organisation code issued by the NHS Organisation Data Service.

Operational dependencies

NHS Digital SMSP endpoints

The adapter depends on the NHS Digital SMSP service, an HL7 V3 endpoint on the UK Health and Social Care Network (production environment). If this service becomes unavailable, the adapter will not be able to respond to requests.