Immunisation History - FHIR API

Overview

Use this API to access a patient’s immunisation history. You can:

get a patient's coronavirus (COVID-19) immunisation history, based on their NHS number

You cannot currently use this API to:

get details of other types of immunisation

You get the following data:

immunisation event details

patient demographic details, as captured at the point of immunisation

The patient demographic details might differ from those held in the Personal Demographics Service (PDS).

To get demographic details from PDS, use the Personal Demographics Service FHIR API. Data availability, timing and quality All immunisation records are verified to ensure the NHS number is correct before making them available via the API. In most cases this is automatic, and the record is available within 48 hours of the immunisation event, sometimes sooner. Where automated NHS number verification fails, we verify the NHS number manually, which can take longer. In a very small number of cases, we are unable to verify the NHS number, and we do not make the immunisation record available at all.

Documentation

Immunisation History - FHIR API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/immunisation-history-fhir

Contact

https://digital.nhs.uk/developer/help-and-support