Skip to main content
Table of contents

COVID-19 Medical Exemptions - FHIR API

Overview

Use this API to access a patient’s coronavirus (COVID-19) medical exemption status. You can:

get a patient's COVID-19 medical exemption status, based on their NHS number

You get the following data:

current COVID-19 medical exemption status

embedded Patient demographic details, including date of birth.

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 standards This API uses the FHIR standard, and includes the resources:

Bundle

Patient

QuestionnaireResponse

It references resources:

Questionnaire specifically COVID-19 Vaccination Medical Exemption Questionnaire

Data availability, timing and quality All exemption 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 exemption being recorded, 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 medical exemption available at all.

Documentation

COVID-19 Medical Exemptions - FHIR API documentation

Endpoint

https://digital.nhs.uk/developer/api-catalogue/covid-19-medical-exemptions-fhir

Contact

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