NHS 111 Report adaptor

Use this adaptor to receive NHS 111 Report messages from NHS 111, for example into a GP system, following a patient's call to the free NHS 111 service. 

You can receive and route a “post event message” to their GP when NHS 111 requests:

• an ambulance call out
• a referral to a local emergency department
• a referral to an Out Of Hours service
• a referral to their GP

The NHS 111 Report adaptor can receive messages from the NHS 111 service and post them to the mailbox of the relevant GP practice.

This adaptor is a self-hosted component - you must deploy it within your own environment. 

The status for this adaptor is Live (Beta private).

We are currently in private beta, working with a limited number of partners to gain feedback and improve the service.

The latest version of the adaptor is 1.0.5-arm64 and 1.0.5-amd64

This adaptor receives ITK 2.2 wrapped Clinical Document Architecture (CDA) XML documents over web services, and converts them into structured FHIR messages before posting them onto the GP system's inbound event queue.

This adaptor is a self-hosted component - you must deploy it within your own environment.

The following diagram illustrates the NHS 111 Report adaptor:

Deployment

You can deploy this adaptor where you like, for example, in a public or private cloud environment.

We have created a Docker image for the adaptor which you can find in Docker Hub along with the relevant install guidelines:

• NHS 111 Report adaptor Docker image

Directory of Services registration and maintenance

NHS 111 providers invoking the adaptor's ITK web service need to look up the relevant endpoint associated with the patient's registered GP practice.

Lookups are performed against the Directory of Service (DoS).  The GP supplier is responsible for registering and maintaining accurate endpoints and service profiles within DoS through their dedicated DoS Lead.

We advise GP suppliers to engage with their relevant Integrated Care Systems (ICSs) for more details.

Inbound queue configuration

The post event messages (PEM) handled by the adaptor are sent to the Active Message Queue within the GP supplier's own environment and are not stored within the NHS 111 adaptor itself.  

You need to configure the following environment variables to enable this:

PEM111_AMQP_BROKER
PEM111_AMQP_QUEUE_NAME
PEM111_AMQP_USERNAME
PEM111_AMQP_PASSWORD

Following the release of version 1.0.5-arm64 and 1.0.5-amd64, we now support RabbitMQ using AMQP protocol 0-9-1.

For this, you need to set the following environment variables:

PEM111_AMQP_BROKER - to prevent a breaking change, the full URL should be given in the form of amqp://address:port. The address section is extracted for configuration as long as your URL contains the leading :// and the following : before the port number.

PEM111_AMQP_PORT

PEM111_AMQP_PROTOCOL - needs to be set exactly to "0-9-1"

PEM111_AMQP_QUEUE_NAME

PEM111_AMQP_USERNAME

PEM111_AMQP_PASSWORD

PEM111_AMQP_ROUTING_KEY

PEM111_AMQP_SSL_ENABLED - defaults to false

For details on integration testing, see the integration testing section of our GitHub repository.

Contents include:

• pre-requisites for integration testing
• how to run unit and integration testing
• example message bundles

This adaptor enables access to national NHS Systems. You need to configure it to integrate with the relevant NHS environments.

You need to get your software approved by us before it can go live with this adaptor. We call this onboarding. The onboarding process can sometimes be quite long, so it’s worth planning well ahead.

For more details, see onboarding.

Find out how to operate this adaptor in your own infrastructure in our GitHub repository. This covers areas such as log consumption, tooling, audit and other topics.