Skip to main content

Vaccination APIs

Provide information to NHS Digital relating to coronavirus (COVID-19) and seasonal flu 2020-21 vaccinations.

Overview

Use these APIs to provide information to us at NHS Digital relating to:

These APIs define the structure and content of the delimited file to send us.

They specify the flow of vaccination-related information from healthcare settings including:

  • hospital hubs - NHS providers vaccinating on site 

  • local vaccine services – community or primary care led services which could include primary care facilities, retail, community facilities, temporary structures or roving teams 

  • vaccination centres – large sites such as sports and conference venues set up for high volumes of people 

For more details on how to interact with end users to collect COVID-19 information safely, see the functional specifications under 'Additional guidance' below.

For FHIR standards relating to the flow of information directly back to the patient's GP, see Digital Medicine - FHIR API.

For FHIR standards relating to the flow of information to other care providers such as Child Health, see Vaccination Events - FHIR API.


API status

These APIs are stable.


Technology

These APIs specify pipe-delimited files you send to us over MESH.

For more details, see MESH.


Interactions

These are Microsoft Word files. To request a different format, contact us.


Additional guidance

Use these functional specifications to understand how your system must interact with end users in order to collect information safely and assist in decision making, relating to COVID-19 vaccinations.

These are Microsoft Word files. To request a different format, contact us.  

Last edited: 23 June 2021 8:20 am