{
  "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Immunization](https://hl7.org/fhir/R4/Immunization.html).",
  "_filename": "UKCore-Immunization.json",
  "package_name": "fhir.r4.ukcore.stu3.currentbuild",
  "date": "2023-12-12",
  "derivation": "constraint",
  "publisher": "HL7 UK",
  "fhirVersion": "4.0.1",
  "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. \r\n\r\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.",
  "name": "UKCoreImmunization",
  "abstract": false,
  "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.",
  "type": "Immunization",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "UK Core Immunization",
  "package_version": "0.0.9-pre-release",
  "status": "active",
  "id": "27cca70c-fabd-416b-bdeb-59a1f37c13ff",
  "kind": "resource",
  "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization",
  "version": "2.4.0",
  "differential": {
    "element": [ {
      "id": "Immunization",
      "path": "Immunization",
      "constraint": [ {
        "key": "ukcore-imm-001",
        "human": "If the immunization was not given then `Immunization.status` value SHALL = 'not-done', and the `Immunization.statusReason` SHALL be populated",
        "severity": "error",
        "expression": "(status != 'not-done') or (status = 'not-done' and statusReason.exists())"
      } ]
    }, {
      "id": "Immunization.extension:parentPresent",
      "path": "Immunization.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" ]
      } ],
      "short": "Indicates if a parent was present at an immunisation.",
      "sliceName": "parentPresent"
    }, {
      "id": "Immunization.extension:vaccinationProcedure",
      "path": "Immunization.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" ]
      } ],
      "short": "Used to hold an immunisation procedure code. \r\n\r\nThis extension SHOULD be used when `Immunization.status`=`completed`. \r\n\r\nThis relates to the vaccine that was administered (procedure) and SHOULD be a SNOMED CT from `ValueSet-UKCore-VaccinationProcedure`.",
      "sliceName": "vaccinationProcedure"
    }, {
      "id": "Immunization.status",
      "path": "Immunization.status",
      "short": "Indicates the current status of the immunization event.",
      "mustSupport": true
    }, {
      "id": "Immunization.statusReason",
      "path": "Immunization.statusReason",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered"
      }
    }, {
      "id": "Immunization.vaccineCode",
      "path": "Immunization.vaccineCode",
      "short": "Vaccine that was administered or was to be administered.",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode"
      },
      "mustSupport": true
    }, {
      "id": "Immunization.patient",
      "path": "Immunization.patient",
      "short": "The patient who either received or did not receive the immunization.",
      "mustSupport": true
    }, {
      "id": "Immunization.occurrence[x]",
      "path": "Immunization.occurrence[x]",
      "short": "When the vaccine was administered or was to be administered.",
      "mustSupport": true
    }, {
      "id": "Immunization.manufacturer",
      "path": "Immunization.manufacturer",
      "short": "Name of vaccine manufacturer.",
      "mustSupport": true
    }, {
      "id": "Immunization.lotNumber",
      "path": "Immunization.lotNumber",
      "short": "Lot number of the vaccine.",
      "mustSupport": true
    }, {
      "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.doseQuantity",
      "path": "Immunization.doseQuantity",
      "short": ">How much of the vaccine was administered.",
      "mustSupport": true
    }, {
      "id": "Immunization.reasonCode",
      "path": "Immunization.reasonCode",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationExplanationReason"
      }
    } ]
  },
  "contact": [ {
    "name": "HL7 UK",
    "telecom": [ {
      "use": "work",
      "rank": 1,
      "value": "ukcore@hl7.org.uk",
      "system": "email"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}