Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions specification/immunisation-fhir-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,8 @@ paths:
description: |
## Overview
Use this interaction to search for a patient's vaccination records using their NHS number and DiseaseType. You can request the patient's vaccination history for one or more specified 'disease types'. You may limit the vaccination records by specifying date criteria, for example if you only need to know about vaccinations administered in the last 12 months.
Vaccination event details may be obfuscated for sensitive information. The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization.
Location related data items are included. Patient location sensitivity indicators (such as flags for sensitive patient records) should be obtained by connecting systems from the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) and used to apply data filtering as appropriate.
The response will not include contained resources for patient or practitioner within each immunization resource it returns. A single, separate patient resource will be included in the bundle and referenced by each immunization.
Vaccination events submitted without an NHS Number will not be available for retrieval via this interaction. Also, where a patient has a change of NHS Number some or all records may be unavailable via this interaction for a short period of time whilst records are updated.
You must be authorised for the search interaction and the disease type(s) specified in your search in order to access the records.

Expand Down Expand Up @@ -1151,7 +1152,7 @@ components:
gender: unknown
birthDate: '1965-02-28'
address:
- postalCode: ZZ99 3CZ
- postalCode: EC1A 1BB
extension:
- url: >-
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure
Expand All @@ -1161,6 +1162,10 @@ components:
code: '1303503001'
display: >-
Administration of RSV (respiratory syncytial virus) vaccine
identifier:
- use: official
system: 'https://supplierABC/identifiers/vacc'
value: e2154d29-1ead-4830-a513-0d59705078fa
status: completed
vaccineCode:
coding:
Expand All @@ -1175,8 +1180,8 @@ components:
primarySource: true
location:
identifier:
system: 'urn:iso:std:iso:3166'
value: GB
system: 'https://fhir.nhs.uk/Id/ods-organization-code'
value: 'X99999'
manufacturer:
display: AstraZeneca Ltd
lotNumber: 4120Z001
Expand All @@ -1203,7 +1208,7 @@ components:
type: Organization
identifier:
system: 'https://fhir.nhs.uk/Id/ods-organization-code'
value: N2N9I
value: B0C4P
reasonCode:
- coding:
- system: 'http://snomed.info/sct'
Expand Down Expand Up @@ -1293,8 +1298,8 @@ components:
primarySource: true
location:
identifier:
system: 'urn:iso:std:iso:3166'
value: GB
system: 'https://fhir.nhs.uk/Id/ods-organization-code'
value: 'X99999'
manufacturer:
display: AstraZeneca Ltd
lotNumber: 4120Z001
Expand Down Expand Up @@ -1343,7 +1348,6 @@ components:
identifier:
- system: 'https://fhir.nhs.uk/Id/nhs-number'
value: '9449306206'
birthDate: '2014-03-25'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does birthDate also need removing from specification/components/schemas/GetResponse.yaml?

Copy link
Contributor Author

@Akol125 Akol125 Jun 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh looks like I misunderstood the question. I would look into it and confirm again if it needs to be removed

search:
mode: include
total: 1
Expand Down
Loading