{
  "resourceType": "StructureDefinition",
  "id": "DataStandardsWales-Immunization",
  "url": "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Immunization",
  "version": "1.2.0",
  "name": "DataStandardsWalesImmunization",
  "title": "Data Standards Wales Immunization",
  "status": "active",
  "experimental": false,
  "date": "2026-02-06",
  "publisher": "NHS Wales",
  "copyright": "2026 NHS Wales.",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization.extension:parentPresent",
        "path": "Immunization.extension",
        "sliceName": "parentPresent",
        "mustSupport": false
      },
      {
        "id": "Immunization.extension:vaccinationProcedure",
        "path": "Immunization.extension",
        "sliceName": "vaccinationProcedure",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure"
        }
      },
      {
        "id": "Immunization.extension:immunizationBasedOnR5",
        "path": "Immunization.extension",
        "sliceName": "immunizationBasedOnR5",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-Immunization.basedOn"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.extension:administeredProduct",
        "path": "Immunization.extension",
        "sliceName": "administeredProduct",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-AdministeredProduct"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.extension:forecastCreationSource",
        "path": "Immunization.extension",
        "sliceName": "forecastCreationSource",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-ForecastCreationSource"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.extension:dateProcedureLastUpdated",
        "path": "Immunization.extension",
        "sliceName": "dateProcedureLastUpdated",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DateProcedureLastUpdated"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "mustSupport": true
      },
      {
        "id": "Immunization.identifier.system",
        "path": "Immunization.identifier.system",
        "min": 1
      },
      {
        "id": "Immunization.identifier.value",
        "path": "Immunization.identifier.value",
        "min": 1
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason.coding",
        "path": "Immunization.statusReason.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.statusReason.coding.system",
        "path": "Immunization.statusReason.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.statusReason.coding.code",
        "path": "Immunization.statusReason.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.statusReason.coding.display",
        "path": "Immunization.statusReason.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding",
        "path": "Immunization.vaccineCode.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.vaccineCode.coding.system",
        "path": "Immunization.vaccineCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.code",
        "path": "Immunization.vaccineCode.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.vaccineCode.coding.display",
        "path": "Immunization.vaccineCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Patient"
            ]
          }
        ]
      },
      {
        "id": "Immunization.patient.identifier.system",
        "path": "Immunization.patient.identifier.system",
        "min": 1,
        "fixedUri": "https://fhir.nhs.uk/Id/nhs-number"
      },
      {
        "id": "Immunization.patient.identifier.value",
        "path": "Immunization.patient.identifier.value",
        "min": 1
      },
      {
        "id": "Immunization.encounter",
        "path": "Immunization.encounter",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Encounter"
            ]
          }
        ]
      },
      {
        "id": "Immunization.occurrence[x]",
        "path": "Immunization.occurrence[x]",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "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.manufacturer",
        "path": "Immunization.manufacturer",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Organization"
            ]
          }
        ]
      },
      {
        "id": "Immunization.manufacturer.display",
        "path": "Immunization.manufacturer.display",
        "min": 1
      },
      {
        "id": "Immunization.expirationDate",
        "path": "Immunization.expirationDate",
        "mustSupport": true
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "mustSupport": true
      },
      {
        "id": "Immunization.site.coding",
        "path": "Immunization.site.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.site.coding.code",
        "path": "Immunization.site.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.site.coding.display",
        "path": "Immunization.site.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "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",
        "path": "Immunization.performer.actor.type",
        "min": 1
      },
      {
        "id": "Immunization.performer.actor.identifier.system",
        "path": "Immunization.performer.actor.identifier.system",
        "min": 1
      },
      {
        "id": "Immunization.performer.actor.identifier.value",
        "path": "Immunization.performer.actor.identifier.value",
        "min": 1
      },
      {
        "id": "Immunization.note.author[x]",
        "path": "Immunization.note.author[x]",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Practitioner",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Patient",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Organization",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-RelatedPerson"
            ]
          },
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Immunization.reasonCode",
        "path": "Immunization.reasonCode",
        "mustSupport": true
      },
      {
        "id": "Immunization.reasonCode.coding",
        "path": "Immunization.reasonCode.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Immunization.reasonCode.coding.system",
        "path": "Immunization.reasonCode.coding.system",
        "min": 1
      },
      {
        "id": "Immunization.reasonCode.coding.code",
        "path": "Immunization.reasonCode.coding.code",
        "min": 1
      },
      {
        "id": "Immunization.reasonCode.coding.display",
        "path": "Immunization.reasonCode.coding.display",
        "min": 1
      },
      {
        "id": "Immunization.reasonReference",
        "path": "Immunization.reasonReference",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Condition",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Observation",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-DiagnosticReport",
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-ImmunizationRecommendation"
            ]
          }
        ]
      },
      {
        "id": "Immunization.reaction.detail",
        "path": "Immunization.reaction.detail",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Observation"
            ]
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied",
        "path": "Immunization.protocolApplied",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.authority",
        "path": "Immunization.protocolApplied.authority",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Organization"
            ]
          }
        ]
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "mustSupport": true,
        "binding": {
          "strength": "example",
          "description": "(work in progress) The vaccine preventable disease the dose is being administered for."
        }
      }
    ]
  }
}