FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagefhir.r4.wales.discovery
Resource TypeStructureDefinition
IdProfile-DataStandardsWales-Immunization.json
FHIR VersionR4

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "StructureDefinition",
  "id": "DataStandardsWales-Immunization",
  "url": "https://fhir.nhs.wales/StructureDefinition/DataStandardsWales-Immunization",
  "name": "DataStandardsWalesImmunization",
  "title": "Data Standards Wales Immunization",
  "status": "draft",
  "publisher": "NHS Wales",
  "fhirVersion": "4.0.1",
  "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 SHALL = 'not-done', and the Immunization.statusReason SHALL be populated",
            "expression": "(status != 'not-done') or (status = 'not-done' and statusReason.exists())"
          }
        ]
      },
      {
        "id": "Immunization.extension",
        "path": "Immunization.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        },
        "min": 0
      },
      {
        "id": "Immunization.extension:parentPresent",
        "path": "Immunization.extension",
        "sliceName": "parentPresent",
        "min": 0,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ParentPresent"
            ]
          }
        ],
        "mustSupport": false
      },
      {
        "id": "Immunization.extension:vaccinationProcedure",
        "path": "Immunization.extension",
        "sliceName": "vaccinationProcedure",
        "min": 0,
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure"
            ]
          }
        ],
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://fhir.nhs.wales/ValueSet/DataStandardsWales-VaccinationProcedure"
        }
      },
      {
        "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.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",
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.nhs.wales/ValueSet/DataStandardsWales-ReasonImmunizationNotAdministered"
        }
      },
      {
        "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",
        "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",
        "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.hl7.org.uk/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",
        "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.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",
        "definition": "The visit or admission or other contact between patient and healthcare provider the immunization was performed as part of.",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://fhir.hl7.org.uk/StructureDefinition/DataStandardsWales-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.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.hl7.org.uk/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.hl7.org.uk/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",
        "path": "Immunization.manufacturer.display",
        "min": 1
      },
      {
        "id": "Immunization.lotNumber",
        "path": "Immunization.lotNumber",
        "mustSupport": true
      },
      {
        "id": "Immunization.expirationDate",
        "path": "Immunization.expirationDate",
        "mustSupport": true
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite"
        }
      },
      {
        "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,
        "binding": {
          "strength": "preferred",
          "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SubstanceOrProductAdministrationRoute"
        }
      },
      {
        "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.hl7.org.uk/StructureDefinition/DataStandardsWales-Practitioner",
              "https://fhir.hl7.org.uk/StructureDefinition/DataStandardsWales-PractitionerRole",
              "https://fhir.hl7.org.uk/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.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",
        "mustSupport": true,
        "binding": {
          "strength": "extensible",
          "valueSet": "https://fhir.nhs.wales/ValueSet/DataStandardsWales-ImmunizationExplanationReason"
        }
      },
      {
        "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.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",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "description": "(work in progress) The vaccine preventable disease the dose is being administered for.",
          "valueSet": "http://hl7.eu/fhir/ig/dgc/ValueSet/covid-19-diseases"
        }
      }
    ]
  }
}