Use this API to publish or receive messages about changes to a patient's vaccination details, including:
- new vaccinations
- updated vaccination details
- deleted vaccination details
Using a publish-subscribe model, we share information about these events with healthcare workers in other organisations such as GPs, Emergency Departments and Local Authorities.
To send messages, use this API. To receive these messages you need to subscribe to them via National Events Management Service (NEMS) and collect them via MESH.
For example, when a GP system records a vaccination, it sends an event message containing the vaccination details to NEMS. NEMS then sends the message to all healthcare workers who have subscribed to receive vaccination event messages.
Who can use this API
This API can only be used where there is a legal basis to do so.
Make sure you have a valid use case before you go too far with your development. To do this, contact us.
For details of the legal basis for sharing NEMS events, see the NEMS controller catalogue.
You must do this before you can go live (see 'Onboarding' below).
Environments and testing
This API uses NEMS, which is available in Opentest for early development and testing.
NEMS is also available for testing purposes in:
The base URLs are as follows:
The base URL for the publishing and subscribing interactions are the same, but the path is different, for example:
- publish in integration over HSCN:
- subscribe in integration over HSCN:
- publish in integration over the internet:
- subscribe in integration over the internet:
There is a testing tool which allows you to simulate a provider publishing event messages. You can also simulate making changes on PDS to trigger PDS-published event messages so you can test event message consumption.
To get advice on how to begin testing, contact us.
For more details, see the NEMS onboarding guide on getting access to Opentest and the integration (INT) test environment.
Last edited: 17 January 2022 4:22 pm