{
"description": null,
"_filename": "Profile-DataStandardsWales-Immunization.json",
"package_name": "fhir.r4.wales",
"date": "2025-04-30",
"derivation": "constraint",
"publisher": "NHS Wales",
"fhirVersion": "4.0.1",
"name": "DataStandardsWalesImmunization",
"abstract": false,
"copyright": "2024 NHS Wales.",
"type": "Immunization",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Data Standards Wales Immunization",
"package_version": "2.4.0",
"status": "active",
"id": "c8cd2303-35f8-4cf4-b0c1-6c195a59c99d",
"kind": "resource",
"url": "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Immunization",
"version": "1.1.0",
"differential": {
"element": [ {
"id": "Immunization.extension:parentPresent",
"path": "Immunization.extension",
"sliceName": "parentPresent",
"mustSupport": false
}, {
"id": "Immunization.extension:vaccinationProcedure",
"path": "Immunization.extension",
"binding": {
"strength": "required",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure"
},
"sliceName": "vaccinationProcedure",
"mustSupport": true
}, {
"id": "Immunization.extension:DataStandardsWalesImmunizationBasedOn",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn" ]
} ],
"sliceName": "DataStandardsWalesImmunizationBasedOn",
"isModifier": false
}, {
"id": "Immunization.extension:DataStandardsWalesAdministeredProduct",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-AdministeredProduct" ]
} ],
"sliceName": "DataStandardsWalesAdministeredProduct",
"isModifier": false
}, {
"id": "Immunization.extension:DataStandardsWalesForecastCreationSource",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-ForecastCreationSource" ]
} ],
"sliceName": "DataStandardsWalesForecastCreationSource",
"isModifier": false
}, {
"id": "Immunization.extension:DataStandardsWalesDateProcedureLastUpdated",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DateProcedureLastUpdated" ]
} ],
"sliceName": "DataStandardsWalesDateProcedureLastUpdated",
"isModifier": false
}, {
"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.statusReason",
"path": "Immunization.statusReason",
"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.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" ]
} ]
}, {
"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.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",
"min": 1,
"path": "Immunization.manufacturer.display"
}, {
"id": "Immunization.expirationDate",
"path": "Immunization.expirationDate",
"mustSupport": true
}, {
"id": "Immunization.site",
"path": "Immunization.site",
"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",
"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.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",
"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.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",
"binding": {
"strength": "example",
"description": "(work in progress) The vaccine preventable disease the dose is being administered for."
},
"mustSupport": true
} ]
},
"baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Immunization"
}