{
  "description": null,
  "_filename": "Profile-DataStandardsWales-Immunization.json",
  "package_name": "fhir.r4.wales.stu1",
  "date": "2023-05-24",
  "derivation": "constraint",
  "publisher": "NHS Wales",
  "fhirVersion": "4.0.1",
  "name": "DataStandardsWalesImmunization",
  "abstract": false,
  "copyright": "© 2023 NHS Wales.",
  "type": "Immunization",
  "experimental": "true",
  "resourceType": "StructureDefinition",
  "title": "Data Standards Wales Immunization",
  "package_version": "0.1.1-ballot",
  "status": "draft",
  "id": "9b3d8d1b-8687-4049-bcff-76a9187bede5",
  "kind": "resource",
  "url": "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Immunization",
  "version": "0.0.5",
  "differential": {
    "element": [ {
      "id": "Immunization",
      "path": "Immunization",
      "constraint": [ {
        "key": "ukcore-imm-1",
        "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",
      "min": 0,
      "path": "Immunization.extension",
      "slicing": {
        "rules": "open",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      }
    }, {
      "id": "Immunization.extension:parentPresent",
      "min": 0,
      "path": "Immunization.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent" ]
      } ],
      "sliceName": "parentPresent",
      "mustSupport": false
    }, {
      "id": "Immunization.extension:vaccinationProcedure",
      "min": 0,
      "path": "Immunization.extension",
      "type": [ {
        "code": "Extension",
        "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure" ]
      } ],
      "binding": {
        "strength": "required",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure"
      },
      "sliceName": "vaccinationProcedure",
      "mustSupport": true
    }, {
      "id": "Immunization.identifier",
      "path": "Immunization.identifier",
      "mustSupport": true
    }, {
      "id": "Immunization.identifier.system",
      "min": 1,
      "path": "Immunization.identifier.system"
    }, {
      "id": "Immunization.identifier.value",
      "min": 1,
      "path": "Immunization.identifier.value"
    }, {
      "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",
      "mustSupport": true
    }, {
      "id": "Immunization.statusReason",
      "path": "Immunization.statusReason",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReasonImmunizationNotAdministered"
      },
      "mustSupport": true
    }, {
      "id": "Immunization.statusReason.coding",
      "max": "1",
      "min": 1,
      "path": "Immunization.statusReason.coding"
    }, {
      "id": "Immunization.statusReason.coding.system",
      "min": 1,
      "path": "Immunization.statusReason.coding.system"
    }, {
      "id": "Immunization.statusReason.coding.code",
      "min": 1,
      "path": "Immunization.statusReason.coding.code"
    }, {
      "id": "Immunization.statusReason.coding.display",
      "min": 1,
      "path": "Immunization.statusReason.coding.display"
    }, {
      "id": "Immunization.vaccineCode",
      "path": "Immunization.vaccineCode",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode"
      }
    }, {
      "id": "Immunization.vaccineCode.coding",
      "path": "Immunization.vaccineCode.coding",
      "mustSupport": true
    }, {
      "id": "Immunization.vaccineCode.coding.system",
      "min": 1,
      "path": "Immunization.vaccineCode.coding.system"
    }, {
      "id": "Immunization.vaccineCode.coding.code",
      "min": 1,
      "path": "Immunization.vaccineCode.coding.code"
    }, {
      "id": "Immunization.vaccineCode.coding.display",
      "min": 1,
      "path": "Immunization.vaccineCode.coding.display"
    }, {
      "id": "Immunization.patient",
      "path": "Immunization.patient",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Patient" ]
      } ],
      "mustSupport": true
    }, {
      "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.system",
      "min": 1,
      "path": "Immunization.patient.identifier.system",
      "fixedUri": "https://fhir.nhs.uk/Id/nhs-number"
    }, {
      "id": "Immunization.patient.identifier.value",
      "min": 1,
      "path": "Immunization.patient.identifier.value"
    }, {
      "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.nhs.wales/StructureDefinition/DataStandardsWales-Encounter" ]
      } ],
      "definition": "The visit or admission or other contact between patient and healthcare provider the immunization was performed as part of."
    }, {
      "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.occurrence[x]",
      "path": "Immunization.occurrence[x]",
      "type": [ {
        "code": "dateTime"
      } ],
      "mustSupport": true
    }, {
      "id": "Immunization.recorded",
      "path": "Immunization.recorded",
      "mustSupport": true
    }, {
      "id": "Immunization.reportOrigin",
      "path": "Immunization.reportOrigin",
      "mustSupport": true
    }, {
      "id": "Immunization.location",
      "path": "Immunization.location",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Location" ]
      } ],
      "mustSupport": true
    }, {
      "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.nhs.wales/StructureDefinition/DataStandardsWales-Organization" ]
      } ],
      "mustSupport": true
    }, {
      "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.manufacturer.display",
      "min": 1,
      "path": "Immunization.manufacturer.display"
    }, {
      "id": "Immunization.lotNumber",
      "path": "Immunization.lotNumber",
      "mustSupport": true
    }, {
      "id": "Immunization.expirationDate",
      "path": "Immunization.expirationDate",
      "mustSupport": true
    }, {
      "id": "Immunization.site",
      "path": "Immunization.site",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite"
      },
      "mustSupport": true
    }, {
      "id": "Immunization.site.coding",
      "max": "1",
      "min": 1,
      "path": "Immunization.site.coding"
    }, {
      "id": "Immunization.site.coding.code",
      "min": 1,
      "path": "Immunization.site.coding.code"
    }, {
      "id": "Immunization.site.coding.display",
      "min": 1,
      "path": "Immunization.site.coding.display"
    }, {
      "id": "Immunization.route",
      "path": "Immunization.route",
      "binding": {
        "strength": "preferred",
        "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute"
      },
      "mustSupport": true
    }, {
      "id": "Immunization.doseQuantity",
      "path": "Immunization.doseQuantity",
      "mustSupport": true
    }, {
      "id": "Immunization.performer",
      "path": "Immunization.performer",
      "mustSupport": true
    }, {
      "id": "Immunization.performer.actor",
      "path": "Immunization.performer.actor",
      "type": [ {
        "code": "Reference",
        "targetProfile": [ "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Practitioner", "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-PractitionerRole", "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Organization" ]
      } ]
    }, {
      "id": "Immunization.performer.actor.type",
      "min": 1,
      "path": "Immunization.performer.actor.type"
    }, {
      "id": "Immunization.performer.actor.identifier.system",
      "min": 1,
      "path": "Immunization.performer.actor.identifier.system"
    }, {
      "id": "Immunization.performer.actor.identifier.value",
      "min": 1,
      "path": "Immunization.performer.actor.identifier.value"
    }, {
      "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"
      },
      "mustSupport": true
    }, {
      "id": "Immunization.reasonCode.coding",
      "max": "1",
      "min": 1,
      "path": "Immunization.reasonCode.coding"
    }, {
      "id": "Immunization.reasonCode.coding.system",
      "min": 1,
      "path": "Immunization.reasonCode.coding.system"
    }, {
      "id": "Immunization.reasonCode.coding.code",
      "min": 1,
      "path": "Immunization.reasonCode.coding.code"
    }, {
      "id": "Immunization.reasonCode.coding.display",
      "min": 1,
      "path": "Immunization.reasonCode.coding.display"
    }, {
      "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",
      "path": "Immunization.protocolApplied",
      "mustSupport": true
    }, {
      "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" ]
      } ]
    }, {
      "id": "Immunization.protocolApplied.targetDisease",
      "path": "Immunization.protocolApplied.targetDisease",
      "binding": {
        "strength": "required",
        "valueSet": "http://hl7.eu/fhir/ig/dgc/ValueSet/covid-19-diseases",
        "description": "(work in progress) The vaccine preventable disease the dose is being administered for."
      },
      "mustSupport": true
    } ]
  },
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}