Get immunisation history
Given an NHS number, get the patient's immunisation history. Also returns the patient's demographic details, as captured at the point of immunisation.
Sandbox testing
You can test the following scenarios in our sandbox environment:
| Scenario | Request | Response |
|---|---|---|
| Immunisation history found | patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000009 | HTTP Status 200 with immunisation data in response body |
| No immunisations found | patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9000000033 | HTTP Status 200 with empty bundle in response body |
| Bad Request | patient.identifier= anything else | HTTP Status 400 Bad Request |
You can try out the sandbox using the 'Try this API' feature on this page.
Alternatively, you can try out the sandbox using our Postman collection:
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.
Parent SNOMED code for all COVID-19 vaccinations.
Parent SNOMED immunisation procedure code. For example, 90640007, which is the parent code for all COVID-19 vaccinations. This parameter has been deprecated and will be replaced by the immunization.target parameter.
Immunization History is segmented into multiple Data Stores, which may target specific procedures, disorders, diseases, infections or organisms.
The earliest date to be included (e.g. 2020-01-01)
The latest date to be included (e.g. 2020-12-31)
Specifies other resources to be included in the response along with the immunisations. Must be Immunization:patient, which will include patient demographic details.
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.
Optional header to select the version of the api. Version number will follow semver.
Response
The request was valid, and the response contains immunisation history and associated patient details. If there are no immunisations for the given NHS number, the response bundle will be empty.