Immunization

FHIR resource for population guidance for immunization

Introduction

The headings below list the elements of the Immunization resource and describe how to populate and consume them.

Important: Any element not specifically listed below MUST NOT be populated or consumed. A full list of elements not used is available here.

Tip: You’ll find it helpful to read it in conjunction with the underlying Immunization profile definition.

Immunization elements

id

Data type: Id Optionality: Mandatory Cardinality: 1..1

The logical identifier of the Immunization resource.

meta.profile

Data type: uri Optionality: Mandatory Cardinality: 1..1

The Immunization profile URL.

Fixed value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Immunization-1

extension[parentPresent]

Data type: boolean Optionality: Required Cardinality: 0..1

Indicates whether a parent was present at the immunization.

extension[recordedDate]

Data type: dateTime Optionality: Mandatory Cardinality: 1..1

When the record of the immunization was created on the clinical system.

extension[vaccinationProcedure]

Data type: codableConcept Optionality: Mandatory Cardinality: 1..1

The procedure code describing the vaccine that was administered.

identifier

Data type: Identifier Optionality: Mandatory Cardinality: 1..*

This is for business identifiers.

This is sliced to include a cross-care setting identifier which MUST be populated. The codeSystem for this identifier is https://fhir.nhs.uk/Id/cross-care-setting-identifier.

This MUST be a GUID.

Providing systems MUST ensure this GUID is globally unique and a persistent identifier (that is, it doesn’t change between requests and, therefore, is stored with the source data).

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this GUID at the same time.

status

Data type: Code Optionality: Mandatory Cardinality: 1..1

Fixed to the value completed for all CareConnect profiles.

notGiven

Data type: Boolean Optionality: Mandatory Cardinality: 1..1

Fixed value of false.

vaccineCode

Data type: CodableConcept Optionality: Mandatory Cardinality: 1..1

Vaccine product administered.

Where the vaccine product that was administered is not known then one of the null values defined in the profile MUST be populated.

patient

Data type: Reference(Patient) Optionality: Mandatory Cardinality: 1..1

A reference to the patient who had the immunisation specified.

encounter

Data type: Code Optionality: Required Cardinality: 0..1

The Consultation within which the immunisation was recorded. This may be when the vaccination was administered or when an immunisation administered elsewhere was recorded.

As per base profile guidance.

date

Data type: dateTime Optionality: Required Cardinality: 0..1

The dateTime when the immunization was administered. If the immunisation was administered elsewhere, this may be an estimated date.

primarySource

Data type: Boolean Optionality: Mandatory Cardinality: 1..1

Fixed value of true for all profiles created from the Care Connect Immunization profiles.

Indicates the context that the data was recorded in.

reportOrigin

Data type: CodeableConcept Optionality: Required Cardinality: 0..1

Indicates the source of a secondary reported record.

location

Data type: Reference(Location) Optionality: Required Cardinality: 0..1

The GP practice, branch surgery or other location where the vaccination occurred.

manufacturer

Data type: Reference(Organization) Optionality: Required Cardinality: 0..1

The manufacturer of the vaccine.

lotNumber

Data type: string Optionality: Required Cardinality: 0..1

The batch number of the vaccine.

expirationDate

Data type: date Optionality: Required Cardinality: 0..1

The expiry date of the batch the vaccine is from.

site

Data type: CodableConcept Optionality: Required Cardinality: 0..1

The site on the body where the vaccine was administered.

route

Data type: CodeableConcept Optionality: Required Cardinality: 0..1

The route through which the vaccine entered the body.

doseQuantity

Data type: SimpleQuantity Optionality: Optional Cardinality: 0..1

The amount of the vaccine administered.

practitioner

Data type: BackboneElement

Optionality: Required

Cardinality: 0..*

The details of the person who administered the vaccine are required.

practitioner.role

Data type: Code Optionality:Required Cardinality: 0..1

The role of the referenced practitioner.

practitioner.actor

Data type: Reference (Practitioner) Optionality: Mandatory Cardinality: 1..1

A reference to the practitioner resource that administered the vaccine. This is mandatory where the practitioner role is populated.

note

Data type: Annotation Optionality: Required Cardinality: 0..*

Notes about the immunization.

explanation.reason

Data type: CodeableConcept Optionality: Required Cardinality: 0..*

The reason why the immunization was given, for example, travel, occupation, and so on.

vaccinationProtocol

Data type: BackboneElement Optionality: Required Cardinality: 0..1

The protocol for the vaccination.

vaccinationProtocol.doseSequence

Data type: positiveInt Optionality: Mandatory Cardinality: 1..1

If the immunisation is achieved via a series of vaccinations, this is the position of the vaccine procedure in the series.

vaccinationProtocol.description

Data type: string Optionality: Required Cardinality: 0..1

A description for the vaccination protocol this vaccination is administered under.

vaccinationProtocol.seriesDoses

Data type: positiveInt Optionality: Required Cardinality: 0..1

The number of doses in the series which are required for immunity.

vaccinationProtocol.targetDisease

Data type: CodeableConcept Optionality: Mandatory Cardinality: 1..*

The disease or diseases the patient is being immunised against.

vaccinationProtocol.doseStatus

Data type: CodeableConcept Optionality Mandatory Cardinality 1..1

Fixed value count

Elements not in use

The following elements MUST NOT be populated:

explanation.reasonNotGiven

Data type: CodeableConcept

Only Immunizations where notGiven is set to false are to be sent using the Immunization profile. This means that there will never be cause to use reasonNotGiven.

reaction