Skip to content

Hospital Activity Notification Service NEMS subscriber

License

Notifications You must be signed in to change notification settings

nhsx/il-hans-nems-subscriber

Repository files navigation

Hospital Activity Notification Service (HANS) - Subscription Management API

The Hospital Activity Notification Service forwards relevant internal messages from hospital systems to domiciliary care providers, to let them know when their clients have been admitted. It is a pilot project over a limited period to assess the benefits of providing this information in a timely way.

This project provides the integration with the Personal Demographics Service (PDS), to check subscriptions are being created for the right patients and the "publish" logic to queue up and send messages to care providers.

Related projects are:

It is an AWS SAM application written in Python.

The pilot is being run by the NHS Innovation Lab.

Prerequisites

You will need access to the Personal Demographics Service (PDS) FHIR API integration environment. This will provide you with the following:

  • PDS API public/private key pair
  • PDS API JWKS hosted online
  • PDS API Key

You will need a GOV.UK Notify API Key. This will provide you with:

  • GOV.UK Notify API Key

You will need to install the AWS SAM CLI.

Note, that using this with AWS SSO requires a "legacy" profile - you can create this by leaving "SSO session name" blank when running aws configure sso.

To run the code locally you will need to install Docker Engine and ensure it is running.

Usage

Set up a copy of envars.json and add the information from above.

You can run the code locally using sam local start-api --env-vars envars.json. This will set up a local endpoint at 127.0.0.1:3000.

In production, you will need to use production APIs, run the software in an environment that has been CHECK pentration tested and achieve IG and DCB0129 (Clinical Safety) approval.

Documentation

The API is documented in the OpenAPI format on the tech docs website.

Contribution

Contact Alex Young for further information if you would like to contribute.

About

Hospital Activity Notification Service NEMS subscriber

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages