Skip to main content

Vaccination Events - FHIR API

Send and receive messages about changes to a patient's vaccination details.

Overview

Use this API to send and receive messages about changes to a patient's vaccination details, including:

  • new vaccinations
  • updated vaccination details
  • deleted vaccination details

We share information about these events, using a publication-subscription model, with health and care workers in other organisations such as GPs, Emergency Departments and Local Authorities.

To send messages, use this API. To receive these messages you'll need to subscribe to them via National Events Management Service (NEMS).

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.


API status

This API is stable.


Technology

This API uses a publish-subscribe model.

Use our National Events Management Service (NEMS) API to subscribe to events.

Use our MESH API to collect events that you have subscribed to.

The message payload uses FHIR STU3.


Interactions

For a full list of interactions for this API, see Vaccinations.

For details on the general structure of the interactions, see FHIR.

Last edited: 15 April 2021 4:59 pm