<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. 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." /> <copyright value="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 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 = 'not-done', and the Immunization.statusReason SHALL be populated" /> <expression value="(status != 'not-done') or (status = 'not-done' 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>