---
title: "Get immunisation history"
method: GET
path: "/Immunization"
---

# Get immunisation history

`GET /Immunization`

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:

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/b7dfde415e5726658d09)

## Query parameters

- `patient.identifier` string, required
- `procedure-code:below` string — Parent SNOMED code for all COVID-19 vaccinations.
- `immunization.target` 'COVID19' | 'HPV' | 'FLU'
- `date.from` string, date
- `date.to` string, date
- `_include` string, required

## Headers

- `Authorization` string, ^Bearer\ [[:ascii:]]+$, required
- `X-Correlation-ID` string
- `Accept` string

## Response `200`

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.

## Other responses

- `4XX` — An error occurred as follows: | HTTP status | Error code | Description | | ----------- | -------------------------- | ------------------------------------------------------------------- | | 400 | `processing` | Missing or invalid NHS number | | 400 | `processing` | Missing, invalid or conflicting parent SNOMED code / Target | | 401 | `processing` | Missing or invalid ID token | | 401 | `processing` | Missing or invalid OAuth 2.0 bearer token | | 401 | `processing` | NHS number in request doesn't match NHS number in NHS login account | For details see the `diagnostics` field.

---

[API](https://skmtc.net/nhs/apis/immunisation-history-fhir-api.md) · [All operations](https://skmtc.net/nhs/apis/immunisation-history-fhir-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nhs/immunisation-history-fhir-api/versions/c91f85fac59e/schema)