StructureDefinition-UKCore-Immunization

Canonical_URLCurrent_VersionLast_UpdatedDescription
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization2.3.02022-12-16

This profile defines the UK constraints and extensions on the International FHIR resource Immunization.


Profile_Purpose

This profile is intended to cover the recording of current and historical administration of vaccines to individuals across all healthcare disciplines in all care settings and all regions.

This profile does not support the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms "immunisation" and "vaccination" are not clinically identical, for the purposes of the FHIR profile, the terms are used synonymously.

Snapshot View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Differential View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Hybrid View

parentPresentI0..1Extension(boolean)
vaccinationProcedureI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConceptBinding
vaccineCodeΣ1..1CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
lotNumber0..1string
expirationDate0..1date
site0..1CodeableConceptBinding
route0..1CodeableConceptBinding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)
authorStringstring
authorReferenceReference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization)
timeΣ0..1dateTime
textΣ1..1markdown
reasonCode0..*CodeableConceptBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
reported0..1boolean
series0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
targetDisease0..*CodeableConcept
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Table View

Immunization..
Immunization.extension0..
Immunization.extensionExtension0..
Immunization.extensionExtension0..
Immunization.identifier..
Immunization.identifier.assignerReference(UK Core Organization)..
Immunization.statusReason..
Immunization.vaccineCode..
Immunization.patientReference(UK Core Patient)..
Immunization.patient.type..
Immunization.patient.identifier..
Immunization.patient.identifier.assignerReference(UK Core Organization)..
Immunization.encounterReference(UK Core Encounter)..
Immunization.encounter.type..
Immunization.encounter.identifier..
Immunization.encounter.identifier.assignerReference(UK Core Organization)..
Immunization.locationReference(UK Core Location)..
Immunization.location.type..
Immunization.location.identifier..
Immunization.location.identifier.assignerReference(UK Core Organization)..
Immunization.manufacturerReference(UK Core Organization)..
Immunization.manufacturer.type..
Immunization.manufacturer.identifier..
Immunization.manufacturer.identifier.assignerReference(UK Core Organization)..
Immunization.site..
Immunization.route..
Immunization.performer..
Immunization.performer.actorReference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization)..
Immunization.note..
Immunization.note.author[x]Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization), string..
Immunization.reasonCode..
Immunization.reasonReferenceReference(UK Core Condition | UK Core Observation | UK Core DiagnosticReport)..
Immunization.reasonReference.type..
Immunization.reasonReference.identifier..
Immunization.reasonReference.identifier.assignerReference(UK Core Organization)..
Immunization.reaction..
Immunization.reaction.detailReference(UK Core Observation)..
Immunization.reaction.detail.type..
Immunization.reaction.detail.identifier..
Immunization.reaction.detail.identifier.assignerReference(UK Core Organization)..
Immunization.protocolApplied..
Immunization.protocolApplied.authorityReference(UK Core Organization)..
Immunization.protocolApplied.authority.type..
Immunization.protocolApplied.authority.identifier..
Immunization.protocolApplied.authority.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization" />
    <version value="2.3.0" />
    <name value="UKCoreImmunization" />
    <title value="UK Core Immunization" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Immunization](https://hl7.org/fhir/R4/Immunization.html)." />
    <purpose value="This profile is intended to cover the recording of current and historical administration of vaccines to individuals across all healthcare disciplines in all care settings and all regions. \n\nThis profile does not support the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms &quot;immunisation&quot; and &quot;vaccination&quot; are not clinically identical, for the purposes of the FHIR profile, the terms are used synonymously." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="workflow" />
        <uri value="http://hl7.org/fhir/workflow" />
        <name value="Workflow Pattern" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="cda" />
        <uri value="http://hl7.org/v3/cda" />
        <name value="CDA (R2)" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Immunization" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization" />
    <derivation value="constraint" />
    <differential>
        <element id="Immunization">
            <path value="Immunization" />
            <constraint>
                <key value="ukcore-imm-1" />
                <severity value="error" />
                <human value="If the immunization was not given then Immunization.status value SHALL = &#39;not-done&#39;, and the Immunization.statusReason SHALL be populated" />
                <expression value="(status != &#39;not-done&#39;) or (status = &#39;not-done&#39; and statusReason.exists())" />
                <source value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization" />
            </constraint>
        </element>
        <element id="Immunization.extension">
            <path value="Immunization.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Immunization.extension:parentPresent">
            <path value="Immunization.extension" />
            <sliceName value="parentPresent" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" />
            </type>
        </element>
        <element id="Immunization.extension:vaccinationProcedure">
            <path value="Immunization.extension" />
            <sliceName value="vaccinationProcedure" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" />
            </type>
        </element>
        <element id="Immunization.identifier.assigner">
            <path value="Immunization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.statusReason">
            <path value="Immunization.statusReason" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered" />
            </binding>
        </element>
        <element id="Immunization.vaccineCode">
            <path value="Immunization.vaccineCode" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode" />
            </binding>
        </element>
        <element id="Immunization.patient">
            <path value="Immunization.patient" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
            </type>
        </element>
        <element id="Immunization.patient.type">
            <path value="Immunization.patient.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.patient.identifier.assigner">
            <path value="Immunization.patient.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.encounter">
            <path value="Immunization.encounter" />
            <definition value="The visit or admission or other contact between patient and healthcare provider the immunization was performed as part of." />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter" />
            </type>
        </element>
        <element id="Immunization.encounter.type">
            <path value="Immunization.encounter.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.encounter.identifier.assigner">
            <path value="Immunization.encounter.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.location">
            <path value="Immunization.location" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location" />
            </type>
        </element>
        <element id="Immunization.location.type">
            <path value="Immunization.location.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.location.identifier.assigner">
            <path value="Immunization.location.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.manufacturer">
            <path value="Immunization.manufacturer" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.manufacturer.type">
            <path value="Immunization.manufacturer.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.manufacturer.identifier.assigner">
            <path value="Immunization.manufacturer.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.site">
            <path value="Immunization.site" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationAdministrationBodySite" />
            </binding>
        </element>
        <element id="Immunization.route">
            <path value="Immunization.route" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute" />
            </binding>
        </element>
        <element id="Immunization.performer.actor">
            <path value="Immunization.performer.actor" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.note.author[x]">
            <path value="Immunization.note.author[x]" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
            <type>
                <code value="string" />
            </type>
        </element>
        <element id="Immunization.reasonCode">
            <path value="Immunization.reasonCode" />
            <binding>
                <strength value="preferred" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationExplanationReason" />
            </binding>
        </element>
        <element id="Immunization.reasonReference">
            <path value="Immunization.reasonReference" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport" />
            </type>
        </element>
        <element id="Immunization.reasonReference.type">
            <path value="Immunization.reasonReference.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.reasonReference.identifier.assigner">
            <path value="Immunization.reasonReference.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.reaction.detail">
            <path value="Immunization.reaction.detail" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation" />
            </type>
        </element>
        <element id="Immunization.reaction.detail.type">
            <path value="Immunization.reaction.detail.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.reaction.detail.identifier.assigner">
            <path value="Immunization.reaction.detail.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.protocolApplied.authority">
            <path value="Immunization.protocolApplied.authority" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Immunization.protocolApplied.authority.type">
            <path value="Immunization.protocolApplied.authority.type" />
            <binding>
                <strength value="extensible" />
                <description value="A resource (or, for logical models, the URI of the logical model)." />
            </binding>
        </element>
        <element id="Immunization.protocolApplied.authority.identifier.assigner">
            <path value="Immunization.protocolApplied.authority.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Immunization",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization",
    "version": "2.3.0",
    "name": "UKCoreImmunization",
    "title": "UK Core Immunization",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Immunization](https://hl7.org/fhir/R4/Immunization.html).",
    "purpose": "This profile is intended to cover the recording of current and historical administration of vaccines to individuals across all healthcare disciplines in all care settings and all regions. \n\nThis profile does not support the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms \"immunisation\" and \"vaccination\" are not clinically identical, for the purposes of the FHIR profile, the terms are used synonymously.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "workflow",
            "uri": "http://hl7.org/fhir/workflow",
            "name": "Workflow Pattern"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "cda",
            "uri": "http://hl7.org/v3/cda",
            "name": "CDA (R2)"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Immunization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Immunization",
                "path": "Immunization",
                "constraint":  [
                    {
                        "key": "ukcore-imm-1",
                        "severity": "error",
                        "human": "If the immunization was not given then Immunization.status value SHALL = 'not-done', and the Immunization.statusReason SHALL be populated",
                        "expression": "(status != 'not-done') or (status = 'not-done' and statusReason.exists())",
                        "source": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
                    }
                ]
            },
            {
                "id": "Immunization.extension",
                "path": "Immunization.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Immunization.extension:parentPresent",
                "path": "Immunization.extension",
                "sliceName": "parentPresent",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.extension:vaccinationProcedure",
                "path": "Immunization.extension",
                "sliceName": "vaccinationProcedure",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.identifier.assigner",
                "path": "Immunization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.statusReason",
                "path": "Immunization.statusReason",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered"
                }
            },
            {
                "id": "Immunization.vaccineCode",
                "path": "Immunization.vaccineCode",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode"
                }
            },
            {
                "id": "Immunization.patient",
                "path": "Immunization.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.patient.type",
                "path": "Immunization.patient.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.patient.identifier.assigner",
                "path": "Immunization.patient.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.encounter",
                "path": "Immunization.encounter",
                "definition": "The visit or admission or other contact between patient and healthcare provider the immunization was performed as part of.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Encounter"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.encounter.type",
                "path": "Immunization.encounter.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.encounter.identifier.assigner",
                "path": "Immunization.encounter.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.location",
                "path": "Immunization.location",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Location"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.location.type",
                "path": "Immunization.location.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.location.identifier.assigner",
                "path": "Immunization.location.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.manufacturer",
                "path": "Immunization.manufacturer",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.manufacturer.type",
                "path": "Immunization.manufacturer.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.manufacturer.identifier.assigner",
                "path": "Immunization.manufacturer.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.site",
                "path": "Immunization.site",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationAdministrationBodySite"
                }
            },
            {
                "id": "Immunization.route",
                "path": "Immunization.route",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute"
                }
            },
            {
                "id": "Immunization.performer.actor",
                "path": "Immunization.performer.actor",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.note.author[x]",
                "path": "Immunization.note.author[x]",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    },
                    {
                        "code": "string"
                    }
                ]
            },
            {
                "id": "Immunization.reasonCode",
                "path": "Immunization.reasonCode",
                "binding": {
                    "strength": "preferred",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationExplanationReason"
                }
            },
            {
                "id": "Immunization.reasonReference",
                "path": "Immunization.reasonReference",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Condition",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.reasonReference.type",
                "path": "Immunization.reasonReference.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.reasonReference.identifier.assigner",
                "path": "Immunization.reasonReference.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.reaction.detail",
                "path": "Immunization.reaction.detail",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.reaction.detail.type",
                "path": "Immunization.reaction.detail.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.reaction.detail.identifier.assigner",
                "path": "Immunization.reaction.detail.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.protocolApplied.authority",
                "path": "Immunization.protocolApplied.authority",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.protocolApplied.authority.type",
                "path": "Immunization.protocolApplied.authority.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A resource (or, for logical models, the URI of the logical model)."
                }
            },
            {
                "id": "Immunization.protocolApplied.authority.identifier.assigner",
                "path": "Immunization.protocolApplied.authority.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Influenza virus vaccine - An example to illustrate an Influenza virus vaccine.
Example UKCore-Immunization

Extension - ParentPresent - An example to illustrate the ParentPresent extension.
Example UKCore-Immunization-Extension-ParentPresent

Extension - VaccinationProcedure - An example to illustrate the VaccinationProcedure extension, with a vaccination procedure for an administered Influenza virus vaccine.
Example UKCore-Immunization-Extension-VaccinationProcedure

Extension - VaccinationProcedureCovid - An example to illustrate the VaccinationProcedureCovid extension, with a vaccination procedure for the COVID-19 Vaccine Vaxzevria.
Example UKCore-Immunization-Extension-VaccinationProcedureCovid

Example Usage Scenarios

The following are example usage scenarios for the UK Core Immunization profile:

  • Query and retrieve an individual’s immunisations (vaccinations)
  • Record or update an individual’s immunisations (vaccinations).

Profile Specific Implementation Guidance:


Extensions

More information about the extensions can be found using the links below.

Extension Context Link Comment
parentPresent Immunization Extension UKCore-ParentPresent Indicates if a parent was present at an immunisation.
vaccinationProcedure Immunization Extension UKCore-VaccinationProcedure to hold an immunisation procedure code.

This extension SHOULD be used when Immunization.status=completed.

This relates to the vaccine that was administered (procedure) and SHOULD be a SNOMED CT from ValueSet UKCore-VaccinationProcedure


Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
Immunization.extension:vaccinationProcedure Preferred ValueSet UKCore-VaccinationProcedure
Immunization.reasonCode Preferred ValueSet UKCore-ImmunizationExplanationReason
Immunization.route Preferred ValueSet UKCore-SubstanceOrProductAdministrationRoute
Immunization.site Preferred ValueSet UKCore-ImmunizationAdministrationBodySite
Immunization.statusReason Preferred ValueSet UKCore-ReasonImmunizationNotAdministered
Immunization.vaccineCode Preferred ValueSet UKCore-VaccineCode


Constraints (differential)

More information about the constraints on the UKCore-Immunization profile can be found below.

Key Severity Expression Human Description
ukcore-imm-1 error (status != 'not-done') or
(status = 'not-done' and statusReason.exists())
If the immunization was not given then
Immunization.status value SHALL = 'not-done',
and the Immunization.statusReason SHALL be populated

status

Indicates the current status of the immunisation event.

For a vaccination that has been administered, the status will be completed. This status does not indicate a vaccination course has been completed. When the vaccination has not been administered, the status will be not-done and a Immunization.statusReason SHALL be populated.


vaccineCode

Vaccine that was administered or was to be administered.

This indicates vaccine product administered. This SHOULD be a dm+d code from ValueSet UKCore-VaccineCode. AMPP codes SHOULD NOT be used.

Example of Immunization.vaccineCode usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-AstraZenecaVaccine-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-AstraZenecaVaccine-Example" />
    <status value="completed" />
    <!--  **************snippet start**************  -->
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <!--  **************snippet end**************  -->
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-AstraZenecaVaccine-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20"
}

patient

A reference to the patient who either received or did not receive the immunisation. The resource being referenced SHALL conform to Profile UKCore-Patient.

Example of Immunization.patient usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-PatientConformVaccination-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.patient[0].type[0]Patient
Immunization.patient[0].identifier[0].system[0]https://fhir.nhs.uk/Id/nhs-number
Immunization.patient[0].identifier[0].value[0]9912003888
Immunization.occurrence[0]2021-07-20

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-PatientConformVaccination-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <!--   **************snippet start**************   -->
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
        <type value="Patient" />
        <identifier>
            <system value="https://fhir.nhs.uk/Id/nhs-number" />
            <value value="9912003888" />
        </identifier>
    </patient>
    <!--   **************snippet end**************   -->
    <occurrenceDateTime value="2021-07-20" />
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-PatientConformVaccination-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example",
        "type": "Patient",
        "identifier": {
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9912003888"
        }
    },
    "occurrenceDateTime": "2021-07-20"
}

encounter

The resource being referenced SHALL conform to Profile UKCore-Encounter.


primarySource

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Set as true when the content of the record is based on information from the person performing the vaccine or who has clinical responsibility for the vaccination, and the system can be considered a primary source of the vaccination event. Set as false when the information has not come directly from people performing the vaccine (e.g. a patient or patient’s carer), and the system should not be treated as a primary source for this record. This is used to help identify and eliminate duplicate records held centrally.


location

The service delivery location where the vaccine administration occurred by reference to the location.

The resource being referenced SHALL conform to Profile UKCore-Location.


manufacturer

Name of vaccine manufacturer by reference to the organisation. The resource being referenced SHALL conform to Profile UKCore-Organization.

Example of Immunization.manufacturer usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-Manufacturer-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.manufacturer[0].display[0]DREAMLAND Pharmaceuticals Ltd

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-Manufacturer-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <manufacturer>
        <display value="DREAMLAND Pharmaceuticals Ltd" />
    </manufacturer>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-Manufacturer-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "manufacturer": {
        "display": "DREAMLAND Pharmaceuticals Ltd"
    }
}

lotNumber

Lot number of the vaccine product.

Where Immunization.status=completed this SHOULD be present.

This should be captured at source ideally via use of automated scanning technology (GS1 GTIN / NTIN standard).

Example of Immunization.lotNumber usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-LotNumber-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.lotNumber[0]R04X

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-LotNumber-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <lotNumber value="R04X" />
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-LotNumber-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "lotNumber": "R04X"
}

site

Body site where vaccine was administered.

A SNOMED CT Concept ID value from UK published reference set “Vaccine body site of administration simple reference set” (1127941000000100) SHOULD be used ValueSet UKCore-ImmunizationAdministrationBodySite.

Example of Immunization.site usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-LeftUpperArmStructure-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.site[0].coding[0].system[0]http://snomed.info/sct
Immunization.site[0].coding[0].code[0]368208006
Immunization.site[0].coding[0].display[0]Left upper arm structure (body structure)

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-LeftUpperArmStructure-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <site>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="368208006" />
            <display value="Left upper arm structure (body structure)" />
        </coding>
    </site>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-LeftUpperArmStructure-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "site": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "368208006",
                "display": "Left upper arm structure (body structure)"
            }
        ]
    }
}

route

The path by which the vaccine product is taken into the body.

A SNOMED CT concept ID value from either of the following SHOULD be used:
UK “ePrescribing route of administration simple reference set (foundation metadata concept)” (999000051000001100) ValueSet UKCore-SubstanceOrProductAdministrationRoute
or:
UK published reference set “Vaccine route of administration simple reference set” (115231000001104).

Example of Immunization.route usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-IntramuscularRoute-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.route[0].coding[0].system[0]http://snomed.info/sct
Immunization.route[0].coding[0].code[0]78421000
Immunization.route[0].coding[0].display[0]Intramuscular route (qualifier value)

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-IntramuscularRoute-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <route>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="78421000" />
            <display value="Intramuscular route (qualifier value)" />
        </coding>
    </route>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-IntramuscularRoute-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "route": {
        "coding":  [
            {
                "system": "http://snomed.info/sct",
                "code": "78421000",
                "display": "Intramuscular route (qualifier value)"
            }
        ]
    }
}

doseQuantity

The quantity of vaccine product that was administered.

By preference, use UCUM units of measure. Examples of when a UCUM unit of measure would be used are “gram” or “milliliter” or “percent”.

Where a UCUM unit of measure is not defined, use a SNOMED CT unit of measure. Examples of when a SNOMED CT unit of measure would typically be used are “tablet”, “capsule” or “ampule”.

Example of Immunization.doseQuantity usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-UnitsOfMeasure-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.doseQuantity[0].value[0]0.5
Immunization.doseQuantity[0].unit[0]milliliter
Immunization.doseQuantity[0].system[0]http://unitsofmeasure.org
Immunization.doseQuantity[0].code[0]ml

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-UnitsOfMeasure-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <doseQuantity>
        <value value="0.5" />
        <unit value="milliliter" />
        <system value="http://unitsofmeasure.org" />
        <code value="ml" />
    </doseQuantity>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-UnitsOfMeasure-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "doseQuantity": {
        "value": 0.5,
        "unit": "milliliter",
        "system": "http://unitsofmeasure.org",
        "code": "ml"
    }
}

performer

Indicates who performed the immunisation event by reference. The resource being referenced SHALL conform to one of the following:

Example of Immunization.performer usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-Performer-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.performer[0].actor[0].type[0]Practitioner
Immunization.performer[0].actor[0].identifier[0].system[0]https://fhir.hl7.org.uk/Id/nmc-number
Immunization.performer[0].actor[0].identifier[0].value[0]5566789
Immunization.performer[0].actor[0].display[0]HOLDING, Rafferty
Immunization.performer[1].actor[0].type[0]Organization
Immunization.performer[1].actor[0].identifier[0].system[0]https://fhir.nhs.uk/Id/ods-organization-code
Immunization.performer[1].actor[0].identifier[0].value[0]C4B2A
Immunization.performer[1].actor[0].display[0]ELLAND ROAD STADIUM - COVID VACCINATION CENTRE

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-Performer-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <performer>
        <actor>
            <type value="Practitioner" />
            <identifier>
                <system value="https://fhir.hl7.org.uk/Id/nmc-number" />
                <value value="5566789" />
            </identifier>
            <display value="HOLDING, Rafferty" />
        </actor>
    </performer>
    <performer>
        <actor>
            <type value="Organization" />
            <identifier>
                <system value="https://fhir.nhs.uk/Id/ods-organization-code" />
                <value value="C4B2A" />
            </identifier>
            <display value="ELLAND ROAD STADIUM - COVID VACCINATION CENTRE" />
        </actor>
    </performer>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-Performer-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "performer":  [
        {
            "actor": {
                "type": "Practitioner",
                "identifier": {
                    "system": "https://fhir.hl7.org.uk/Id/nmc-number",
                    "value": "5566789"
                },
                "display": "HOLDING, Rafferty"
            }
        },
        {
            "actor": {
                "type": "Organization",
                "identifier": {
                    "system": "https://fhir.nhs.uk/Id/ods-organization-code",
                    "value": "C4B2A"
                },
                "display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
            }
        }
    ]
}

reasonReference

Why immunisation occurred by reference to Condition, Observation or DiagnosticReport.

The resource being referenced SHALL conform to one of the following:


protocolApplied

The protocol (set of recommendations) being followed by the provider who administered the dose.

protocolApplied.targetDisease

It is recommended for international/EU interoperability that Immunization.protocolApplied.targetDisease is populated. The SNOMED CT concept SHOULD be from EU COVID-19 Diseases or Vaccine Target Diseases (GPS) - IPS

Disease UK SNOMED self
COVID-19 840539006
Others See "Vaccine Target Diseases (GPS) - IPS"

protocolApplied.doseNumberPositiveInt

Nominal position in a series of vaccines, N.B. This field will not always be reliable, therefore for Covid vaccinations, the vaccination procedure code or situation code SHOULD be used as that includes the dose number.

Example of Immunization.protocolApplied usage:

Table View

Immunization.id[0]UKCore-Immunization-Sn-ProtocolApplied-Example
Immunization.status[0]completed
Immunization.vaccineCode[0].coding[0].system[0]https://dmd.nhs.uk
Immunization.vaccineCode[0].coding[0].code[0]39114911000001105
Immunization.vaccineCode[0].coding[0].display[0]COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)
Immunization.patient[0].reference[0]Patient/UKCore-Patient-RichardSmith-Example
Immunization.occurrence[0]2021-07-20
Immunization.protocolApplied[0].targetDisease[0].coding[0].system[0]http://snomed.info/sct
Immunization.protocolApplied[0].targetDisease[0].coding[0].code[0]840539006
Immunization.protocolApplied[0].targetDisease[0].coding[0].display[0]COVID-19
Immunization.protocolApplied[0].doseNumber[0]1

Tree View

Immunization

XML View

<Immunization xmlns="http://hl7.org/fhir">
    <id value="UKCore-Immunization-Sn-ProtocolApplied-Example" />
    <status value="completed" />
    <vaccineCode>
        <coding>
            <system value="https://dmd.nhs.uk" />
            <code value="39114911000001105" />
            <display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
        </coding>
    </vaccineCode>
    <patient>
        <reference value="Patient/UKCore-Patient-RichardSmith-Example" />
    </patient>
    <occurrenceDateTime value="2021-07-20" />
    <!--  **************snippet start**************  -->
    <protocolApplied>
        <targetDisease>
            <coding>
                <system value="http://snomed.info/sct" />
                <code value="840539006" />
                <display value="COVID-19" />
            </coding>
        </targetDisease>
        <doseNumberPositiveInt value="1" />
    </protocolApplied>
    <!--  **************snippet end**************  -->
</Immunization>

JSON View

{
    "resourceType": "Immunization",
    "id": "UKCore-Immunization-Sn-ProtocolApplied-Example",
    "status": "completed",
    "vaccineCode": {
        "coding":  [
            {
                "system": "https://dmd.nhs.uk",
                "code": "39114911000001105",
                "display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
            }
        ]
    },
    "patient": {
        "reference": "Patient/UKCore-Patient-RichardSmith-Example"
    },
    "occurrenceDateTime": "2021-07-20",
    "protocolApplied":  [
        {
            "targetDisease":  [
                {
                    "coding":  [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "840539006",
                            "display": "COVID-19"
                        }
                    ]
                }
            ],
            "doseNumberPositiveInt": 1
        }
    ]
}

back to top