{
"description": "A profile modelled after the nl-core-Vaccination-event resource to exchange registrations of (Covid-19) vaccinations.",
"_filename": "Vaccination.StructureDefinition.json",
"package_name": "vzvz.covid-vaccinations",
"date": "2022-03-01T10:46:03.8921572+00:00",
"derivation": "constraint",
"meta": {
"versionId": "1",
"lastUpdated": "2022-03-01T10:56:10.922+00:00"
},
"publisher": "VZVZ",
"fhirVersion": "4.0.1",
"purpose": "A profile modelled after the nl-core-Vaccination-event resource to exchange registrations of (Covid-19) vaccinations.",
"name": "Vaccination",
"abstract": false,
"type": "Immunization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.3.1-beta",
"status": "draft",
"id": "5f415720-d0c9-429d-9f0a-896090386095",
"kind": "resource",
"url": "http://vzvz.nl/fhir/StructureDefinition/Vaccination",
"version": null,
"differential": {
"element": [ {
"id": "Immunization",
"path": "Immunization",
"comment": "This profile is modelled after the nl-core-Vaccination-event currently developed by Nictiz. \r\n\r\nPlease note that, contrary to the related zib concepts, `.vaccineCode` and `.occurrence[x]` are mandatory in FHIR and need to be recorded to exchange Immunization resources.",
"definition": "A derived profile from the Immunzation resource to exchange registrations of (Covid-19) vaccinations."
}, {
"id": "Immunization.extension",
"min": 0,
"path": "Immunization.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Immunization.extension:pharmaceuticalProduct",
"max": "1",
"min": 0,
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://nictiz.nl/fhir/StructureDefinition/ext-Vaccination.PharmaceuticalProduct" ]
} ],
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.\r\n\r\nIf this reference to zib PharmaceuticalProduct is used, the MedicationCode in the referenced resource (Medication.code) SHALL be repeated in Immunization.vaccineCode of this resource.",
"sliceName": "pharmaceuticalProduct"
}, {
"id": "Immunization.extension:pharmaceuticalProduct.value[x]",
"path": "Immunization.extension.value[x]",
"definition": "The pharmaceutical product of the administered vaccination\r\n\r\nValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)."
}, {
"id": "Immunization.identifier",
"max": "1",
"min": 1,
"path": "Immunization.identifier"
}, {
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.12--20200901000000"
},
"comment": "It is possible to use a reference to zib PharmaceuticalProduct to identify the used vaccine, using `Immunization.extension:pharmaceuticalProduct'. If this reference is used, the MedicationCode in the referenced resource (Medication.code) SHALL be repeated in this element.",
"definition": "The product code of the vaccine administered.\r\nThe preferred code system for documenting the product code is HPK. In all cases it concerns those products that fall under ATC group J07 (vaccines)."
}, {
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://vzvz.nl/fhir/StructureDefinition/RIVMNLcorePatient" ]
} ]
}, {
"id": "Immunization.performer:administrator",
"path": "Immunization.performer",
"sliceName": "administrator"
}, {
"id": "Immunization.performer:administrator.function",
"min": 1,
"path": "Immunization.performer.function"
}, {
"id": "Immunization.performer:administrator.function.coding.system",
"path": "Immunization.performer.function.coding.system",
"fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0443"
}, {
"id": "Immunization.performer:administrator.function.coding.code",
"path": "Immunization.performer.function.coding.code",
"fixedCode": "AP"
}, {
"id": "Immunization.performer:administrator.function.coding.display",
"path": "Immunization.performer.function.coding.display",
"fixedString": "Administering Provider"
}, {
"id": "Immunization.performer:administrator.actor",
"path": "Immunization.performer.actor",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Organization", "http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" ]
} ]
}, {
"id": "Immunization.reasonCode",
"path": "Immunization.reasonCode",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding.system",
"type": "pattern"
} ]
}
}, {
"path": "Immunization.reasonCode",
"definition": "Criterion used to select patient for vaccination",
"short": "Criterion for selection",
"sliceName": "selectionCriterion",
"binding": {
"strength": "required",
"valueSet": "http://vzvz.nl/fhir/NamingSystem/RIVMNLselectionCriterion"
},
"max": "1",
"id": "Immunization.reasonCode:selectionCriterion",
"example": [ {
"label": "Medisch",
"valueCodeableConcept": {
"coding": [ {
"code": "1",
"system": "http://vzvz.nl/fhir/CodeSystem/RIVMNLselectionCriterion"
} ]
}
} ],
"patternCodeableConcept": {
"coding": [ {
"system": "http://vzvz.nl/fhir/CodeSystem/RIVMNLselectionCriterion"
} ]
}
}, {
"id": "Immunization.reasonCode:selectionCriterion.coding.system",
"path": "Immunization.reasonCode.coding.system",
"fixedUri": "http://vzvz.nl/fhir/NamingSystem/RIVMNLselectionCriterion"
}, {
"id": "Immunization.reasonCode:administrationAttribute",
"max": "1",
"path": "Immunization.reasonCode",
"binding": {
"strength": "required",
"valueSet": "http://vzvz.nl/fhir/NamingSystem/RIVMNLadministrationAttribute"
},
"example": [ {
"label": "eerste booster na basisserie",
"valueCodeableConcept": {
"coding": [ {
"code": "BS01",
"system": "http://vzvz.nl/fhir/CodeSystem/RIVMNLadministrationAttribute"
} ]
}
} ],
"sliceName": "administrationAttribute",
"definition": "Reasons why the vaccine was administered. E.g. booster label",
"patternCodeableConcept": {
"coding": [ {
"system": "http://vzvz.nl/fhir/CodeSystem/RIVMNLadministrationAttribute"
} ]
}
}, {
"id": "Immunization.reasonCode:administrationAttribute.coding.system",
"path": "Immunization.reasonCode.coding.system",
"fixedUri": "http://vzvz.nl/fhir/NamingSystem/RIVMNLadministrationAttribute"
}, {
"id": "Immunization.protocolApplied.targetDisease",
"path": "Immunization.protocolApplied.targetDisease",
"binding": {
"strength": "required",
"valueSet": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.131.11.3--20220301175614"
}
}, {
"id": "Immunization.protocolApplied.doseNumber[x]",
"path": "Immunization.protocolApplied.doseNumber[x]",
"comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).\r\nDefault can be a 0 (zero) to indicate the number cannot be provided."
} ]
},
"contact": [ {
"name": "VZVZ",
"telecom": [ {
"value": "standaardisatie@vzvz.nl",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}