{
  "resourceType": "StructureDefinition",
  "id": "UKCore-Immunization",
  "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization",
  "version": "2.1.0",
  "name": "UKCoreImmunization",
  "title": "UK Core Immunization",
  "status": "active",
  "date": "2021-09-10",
  "publisher": "HL7 UK",
  "contact": [
    {
      "name": "HL7 UK",
      "telecom": [
        {
          "system": "email",
          "value": "secretariat@hl7.org.uk",
          "use": "work",
          "rank": 1
        }
      ]
    },
    {
      "name": "NHS Digital",
      "telecom": [
        {
          "system": "email",
          "value": "interoperabilityteam@nhs.net",
          "use": "work",
          "rank": 2
        }
      ]
    }
  ],
  "description": "Defines the UK Core constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve an individual’s immunisation information.",
  "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.",
  "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 MUST = 'not-done', and the Immunization.statusReason MUST 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"
        }
      },
      {
        "id": "Immunization.extension:parentPresent",
        "path": "Immunization.extension",
        "sliceName": "parentPresent",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent"
            ]
          }
        ]
      },
      {
        "id": "Immunization.extension:vaccinationProcedure",
        "path": "Immunization.extension",
        "sliceName": "vaccinationProcedure",
        "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.status",
        "path": "Immunization.status"
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered"
        }
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "binding": {
          "strength": "extensible",
          "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",
        "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": "extensible",
          "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ImmunizationAdministrationBodySite"
        }
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "binding": {
          "strength": "extensible",
          "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": "extensible",
          "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"
            ]
          }
        ]
      }
    ]
  }
}