Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Immunisation History - FHIR API

Access a patient's immunisation record (including coronavirus, influenza and HPV immunisations) as an HL7 FHIR R4 API. OpenAPI harvested verbatim.

Immunisation History - FHIR API is one of 10 APIs that NHS England publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include FHIR, Immunisation, and Public Health. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/immunisation-history/FHIR/R4, https://int.api.service.nhs.uk/immunisation-history/FHIR/R4, https://api.service.nhs.uk/immunisation-history/FHIR/R4.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.service.nhs.uk/immunisation-history/FHIR/R4
License
MIT
Resource Areas
1

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Operations 1
GET
/Immunization
Get immunisation history
get-immunisation-history 9 params → 2004XX

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

Patient

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-immunisation-history-openapi.yaml Raw ↑

Other APIs NHS England publishes across the network.

Personal Demographics Service (PDS) - FHIR API
GP Connect Access Record - Structured - FHIR API
Electronic Prescription Service (EPS) - FHIR API
e-Referral Service (e-RS) - FHIR API
Booking and Referral Standard (BaRS) - FHIR API
Organisation Data Service (ODS) - FHIR API
NHS App API
NHS Notify (Communications Manager) API
Service Search (Directory of Healthcare Services) API