Get current COVID-19 medical exemption status
Given an NHS number, get the patient's current COVID-19 medical exemption status. Also returns the patient's demographic details, as captured at the point of the exemption decision being made.
Sandbox testing
You can test the following scenarios in our sandbox environment:
Sample outputs are generated using any patient.identifer where the remainder of dividing by 5. (i.e. id % 5 == X)
| Scenario | Request | Response |
|---|---|---|
| No Current Exemption | patient.identifier = <code>https://fhir.nhs.uk/Id/nhs-number|<X%5==0></code> | HTTP Status 200 with empty bundle in response body |
| Exempt from Vaccination | patient.identifier = <code>https://fhir.nhs.uk/Id/nhs-number|<X%5==1></code> | HTTP Status 200 with exemption data in response body |
| Exempt from Vaccination and Testing | patient.identifier = <code>https://fhir.nhs.uk/Id/nhs-number|<X%5==2></code> | HTTP Status 200 with exemption data in response body |
| Declined for Vaccination | patient.identifier = <code>https://fhir.nhs.uk/Id/nhs-number|<X%5==3></code> | HTTP Status 200 with exemption data in response body |
| Declined for Vaccination and Testing | patient.identifier = <code>https://fhir.nhs.uk/Id/nhs-number|<X%5==4></code> | HTTP Status 200 with exemption data in response body |
You can try out the sandbox using the 'Try this API' feature on this page.
Query parameters
The patient's NHS number. Expressed as <type>|<value> where <type> must be https://fhir.nhs.uk/Id/nhs-number and <value> must be a valid NHS number.
The questionnaire to be consumed
Headers
An OAuth 2.0 bearer token, obtained using our NHS login pattern.
An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding . characters.
Mirrored back in a response header.
Response
The request was valid, and the response contains a current exemption and associated patient details. If there are no exemptions for the given NHS number, the response bundle will be empty.