Schema: Immunization

Introduction

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

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

Immunization Elements

id

The logical identifier of the Immunization profile.

meta.profile

The Immunization profile URL.

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

extension[parentPresent]

Indicates whether a parent was present at the immunisation.

extension[recordedDate]

This is the date the immunisation record (given or not given) was entered on the clinical system. This may be an audit trail date or equivalent for the record.

extension[vaccinationProcedure]

The procedure code describing the vaccine that was administered or the situation code for a vaccination that was intended to be administered but was not done. See the profile for the valid codes.

identifier

This will be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data).

status

Fixed to the value completed for all Care Connect profiles.

notGiven

Value of false for vaccinations which have been given (or reported as given). Value of true for vaccinations which were intended but not given.

vaccineCode

Vaccine product administered or intended to be administered.

Where the vaccine product that was administered is not known then the null flavour value code UNK will be populated.

patient

A reference to the patient due to be immunised.

encounter

The consultation within which this immunisation record was captured. This may represent when the vaccination was administered, intended to be administered or when the registered practice was informed of an immunisation administered elsewhere.

date

The date (and time if applicable) when the immunization was administered or intended to be administered. If the immunisation was administered elsewhere, this may be an estimated or partial date.

primarySource

This indicates whether the record is based on information from the person who administered or intended to administer the vaccine.

This will be true where the immunisation record was recorded by the person who administered the vaccine or directly on behalf of the administrator of the vaccine (this includes recording the immunisation based on a complete, original, verifiable document from the administration of the vaccine). This will be false where it is a secondary report of a vaccination for example the recollection of the patient, the patient’s parent, carer or guardian or a secondary document.

If it is not known whether the record of the vaccination was made from a primary or secondary source, then return the default value of true.

reportOrigin

This indicates the source of a secondary reported record.

This provides additional context to the source of the immunisation record where it is not based on information from the person who administered the vaccine. The reportOrigin element can be absent if the record is NOT from a primary source, but the origin of the record is otherwise not recorded / known.

This will be absent where primarySource is true.

location

The GP practice, branch surgery or other location where the vaccination occurred or was intended to occur, if known.

If the immunisation record in the GP Clinical System does not record a location for the vaccination, but is linked to a consultation then

• if the vaccine was administered or was intended to be administered during the consultation the location will be populated with the location of the consultation

• if the vaccine was NOT administered or intended to be administered during the consultation and the location for the vaccination is therefore unknown, then a location will be absent

manufacturer

The manufacturer of the vaccine.

lotNumber

The batch number of the vaccine.

expirationDate

The expiry date of the batch the vaccine is from.

site

The site on the body where the vaccine was administered. This will be absent for an intended vaccination which was not given.

route

The route through which the vaccine entered the body. This will be absent for an intended vaccination which was not given.

doseQuantity

The amount of the vaccine administered. This will be absent for an intended vaccination which was not given.

practitioner

The person who recorded the vaccine as having been administered (or reason for not administering an intended vaccination) will be included. This will also include the practitioner who administered the vaccine if different to who recorded the vaccination.

practitioner.role

The role of the referenced practitioner, if known. Where the role is unknown this will be absent.

The code EP (Entering Provider) will be used to designate the practitioner as having recorded the vaccination (or reason not given).

The code AP (Administering Provider) will be used to designate the practitioner as having administered the vaccination or intending to if the vaccine was not given.

Note: EP is not included in the extensible value set for immunization.practitioner.role (which includes only OP and AP codes). EP has been selected from the parent valueset as a more suitable code. Please use the display name ‘Entering Provider’ with this code, not the longer description from the value set

practitioner.actor

A reference to the practitioner profile for who administered and / or recorded the vaccine.

Where there is only a single practitioner recorded against the immunisation record:

• if the practitioner recording the vaccination also administered it (or intended to), then associate a practitioner.role code AP (Administering Provider) with practitioner profile

• if the GP Clinical System cannot determine whether the practitioner administered the vaccine or just recorded the vaccination event or both, then do not return a practitioner.role

This is mandatory where the practitioner.role is populated.

note

Notes about the immunization.

explanation.reason

The reason why the immunization was given, for example, travel, occupation, and so on. This will be absent if notGiven is true.

explanation.reasonNotGiven

The reason why the immunization was not given, such as declined, contra-indicated, unfit or did not attend. This will be absent if notGiven is false.

vaccinationProtocol

The protocol for the vaccination. This will be absent if notGiven is true.

vaccinationProtocol.doseSequence

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

vaccinationProtocol.description

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

vaccinationProtocol.seriesDoses

The number of doses in the series which are required for vaccination given (at the time it was given / not given).

vaccinationProtocol.targetDisease

The disease or diseases the patient is being immunised against.

vaccinationProtocol.doseStatus

Fixed value count