{
"description": "BeModelVaccination",
"_filename": "StructureDefinition-be-model-vaccination.json",
"package_name": "hl7.fhir.be.vaccination",
"date": "2023-02-16T14:12:15+01:00",
"derivation": "specialization",
"publisher": "eHealth Platform",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "BE",
"system": "urn:iso:std:iso:3166",
"display": "Belgium"
} ]
} ],
"name": "BeModelVaccination",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-vaccination",
"name": "BeModelVaccinationToBVaccination",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"abstract": false,
"type": "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "BeModelVaccination",
"package_version": "1.0.2",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "be-model-vaccination",
"min": 0,
"definition": "BeModelVaccination",
"isModifier": false,
"short": "BeModelVaccination",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "BeVaccination",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"max": "*",
"id": "be-model-vaccination",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Element"
}
}, {
"path": "be-model-vaccination.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "be-model-vaccination.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "be-model-vaccination.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "be-model-vaccination.extension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "be-model-vaccination.recorded",
"min": 1,
"definition": "The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.",
"short": "The date and time when the administration of the vaccine was recorded",
"mapping": [ {
"map": "recorded",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "be-model-vaccination.recorded",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.recorded"
}
}, {
"path": "be-model-vaccination.patient",
"min": 1,
"definition": "The patient that has received the vaccination.",
"short": "The patient that received vaccination.",
"mapping": [ {
"map": "patient",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"max": "1",
"id": "be-model-vaccination.patient",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.patient"
}
}, {
"path": "be-model-vaccination.vaccinationRequest",
"min": 0,
"definition": "The patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines.",
"short": "The patient-specific order or recommendation for the vaccination",
"mapping": [ {
"map": "extension.be-ext-vaccination-originalorder",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference"
} ],
"max": "1",
"id": "be-model-vaccination.vaccinationRequest",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.vaccinationRequest"
}
}, {
"path": "be-model-vaccination.recorder",
"min": 1,
"definition": "The professional that recorded the administration of the vaccine.",
"short": "The professional that recorded the administration of the vaccine",
"mapping": [ {
"map": "extension.be-ext-recorder",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"max": "1",
"id": "be-model-vaccination.recorder",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.recorder"
}
}, {
"path": "be-model-vaccination.performer",
"min": 0,
"definition": "The professional that administered the medication. Use code \"unknown\" if not known.",
"short": "The professional that administered the medication",
"mapping": [ {
"map": "performer",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"max": "1",
"id": "be-model-vaccination.performer",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.performer"
}
}, {
"path": "be-model-vaccination.vaccineCode",
"min": 1,
"definition": "The vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value.",
"short": "The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa",
"mapping": [ {
"map": "vaccineCode",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "be-model-vaccination.vaccineCode",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.vaccineCode"
}
}, {
"path": "be-model-vaccination.vaccinationDate[x]",
"min": 0,
"definition": "The date and/or time when the vaccine administration has been administered or presumed to be administered",
"short": "The date and time when the vaccination has been administered",
"mapping": [ {
"map": "occurrence",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "dateTime"
}, {
"code": "string"
} ],
"max": "1",
"id": "be-model-vaccination.vaccinationDate[x]",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.vaccinationDate[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "be-model-vaccination.administeredProduct",
"min": 0,
"definition": "The details of the product that was administered",
"short": "The details of the product that was administered.",
"mapping": [ {
"map": "extension.be-ext-administeredProduct",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "be-model-vaccination.administeredProduct",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct"
}
}, {
"path": "be-model-vaccination.administeredProduct.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "be-model-vaccination.administeredProduct.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "be-model-vaccination.administeredProduct.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "be-model-vaccination.administeredProduct.extension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "be-model-vaccination.administeredProduct.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "be-model-vaccination.administeredProduct.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "be-model-vaccination.administeredProduct.product[x]",
"min": 0,
"definition": "The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)",
"short": "The actual product that was administered. This should be a product code or a reference to an actual Medication resource",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.code",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference"
}, {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "be-model-vaccination.administeredProduct.product[x]",
"comment": "In the case where the product is not known, use code \"unknown\"",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct.product[x]"
}
}, {
"path": "be-model-vaccination.administeredProduct.lotNumber",
"min": 0,
"definition": "The lot number",
"short": "The lot number",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.batch.lotNumber",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "be-model-vaccination.administeredProduct.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct.lotNumber"
}
}, {
"path": "be-model-vaccination.administeredProduct.expirationDate",
"min": 0,
"definition": "The expiration date of the product.",
"short": "The expiration date of the product.",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.batch.expirationDate",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "be-model-vaccination.administeredProduct.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct.expirationDate"
}
}, {
"path": "be-model-vaccination.route",
"min": 0,
"definition": "The route of administration for the vaccine. This can be free text (not desired) or a code",
"short": "The route of administration.",
"mapping": [ {
"map": "route",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "be-model-vaccination.route",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.route"
}
}, {
"path": "be-model-vaccination.status",
"min": 1,
"definition": "The status of the vaccination record entry - whether it is active, entered in error, etc.",
"short": "The status of this vaccination record entry",
"mapping": [ {
"map": "status",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "be-model-vaccination.status",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.status"
}
}, {
"path": "be-model-vaccination.statusReason",
"min": 0,
"definition": "Supporting reason for status information.",
"short": "The reason for the status e.g. 'not completed because...'",
"mapping": [ {
"map": "statusReason",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason",
"description": "Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine"
},
"max": "1",
"id": "be-model-vaccination.statusReason",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.statusReason"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "be-model-vaccination.reaction",
"min": 0,
"definition": "Reaction to the immunization - cfr. AllergyIntolerance",
"short": "Reaction to the immunization - cfr. AllergyIntolerance",
"mapping": [ {
"map": "reaction",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "be-model-vaccination.reaction",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.reaction"
}
}, {
"path": "be-model-vaccination.reaction.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "be-model-vaccination.reaction.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "be-model-vaccination.reaction.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "be-model-vaccination.reaction.extension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "be-model-vaccination.reaction.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "be-model-vaccination.reaction.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "be-model-vaccination.reaction.reactionDate",
"min": 1,
"definition": "date of the reaction",
"short": "date of the reaction",
"mapping": [ {
"map": "reaction.date",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "be-model-vaccination.reaction.reactionDate",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.reaction.reactionDate"
}
}, {
"path": "be-model-vaccination.reaction.manifestation",
"min": 0,
"definition": "reference to the observation of the reaction",
"short": "reference to the observation of the reaction",
"mapping": [ {
"map": "reaction.detail",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference"
} ],
"max": "1",
"id": "be-model-vaccination.reaction.manifestation",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.reaction.manifestation"
}
}, {
"path": "be-model-vaccination.doseQuantity",
"min": 0,
"definition": "The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.",
"short": "The number or quantity of product(s) that was administered - e.g. 1/2 dose",
"mapping": [ {
"map": "doseQuantity",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "be-model-vaccination.doseQuantity",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.doseQuantity"
}
}, {
"path": "be-model-vaccination.note",
"min": 0,
"definition": "Additional notes for the vaccination",
"short": "Additional notes for the vaccination.",
"mapping": [ {
"map": "note",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "1",
"id": "be-model-vaccination.note",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.note"
}
}, {
"path": "be-model-vaccination.site",
"min": 1,
"definition": "The body site where the vaccination entered the body",
"short": "The body site where the vaccination entered the body",
"mapping": [ {
"map": "site",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "be-model-vaccination.site",
"base": {
"max": "1",
"min": 1,
"path": "be-model-vaccination.site"
}
}, {
"path": "be-model-vaccination.identifier",
"min": 0,
"definition": "The business identifier(s) for the vaccination entry - This is an optional attribute, used for example to track an entry throughout its lifecycle, or across vaults.",
"short": "The business identifier(s) for the vaccination entry",
"mapping": [ {
"map": "identifier",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "be-model-vaccination.identifier",
"base": {
"max": "*",
"min": 0,
"path": "be-model-vaccination.identifier"
}
}, {
"id": "be-model-vaccination.bodyLaterality",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.bodyLaterality"
},
"path": "be-model-vaccination.bodyLaterality",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The side of the body (for sites that occur on both sides of the body)",
"definition": "The side of the body (for sites that occur on both sides of the body)"
}, {
"path": "be-model-vaccination.location",
"min": 0,
"definition": "a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' ",
"short": "The location where the immunization is performed.",
"mapping": [ {
"map": "extension.be-ext-vaccination-location",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference"
} ],
"max": "1",
"id": "be-model-vaccination.location",
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.location"
}
}, {
"id": "be-model-vaccination.locationType",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.locationType"
},
"path": "be-model-vaccination.locationType",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'",
"definition": "The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'"
}, {
"id": "be-model-vaccination.cause",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "be-model-vaccination.cause"
},
"path": "be-model-vaccination.cause",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Is the vaccination due to pre or post exposition prophylaxis?"
} ]
},
"status": "active",
"id": "d03305e3-c53a-40fb-9092-98069608ac06",
"kind": "logical",
"url": "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination",
"version": "1.0.2",
"differential": {
"element": [ {
"id": "be-model-vaccination",
"path": "be-model-vaccination",
"short": "BeModelVaccination",
"mapping": [ {
"map": "BeVaccination",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "BeModelVaccination"
}, {
"id": "be-model-vaccination.recorded",
"max": "1",
"min": 1,
"path": "be-model-vaccination.recorded",
"type": [ {
"code": "dateTime"
} ],
"short": "The date and time when the administration of the vaccine was recorded",
"mapping": [ {
"map": "recorded",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori."
}, {
"id": "be-model-vaccination.patient",
"max": "1",
"min": 1,
"path": "be-model-vaccination.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"short": "The patient that received vaccination.",
"mapping": [ {
"map": "patient",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The patient that has received the vaccination."
}, {
"id": "be-model-vaccination.vaccinationRequest",
"max": "1",
"min": 0,
"path": "be-model-vaccination.vaccinationRequest",
"type": [ {
"code": "Reference"
} ],
"short": "The patient-specific order or recommendation for the vaccination",
"mapping": [ {
"map": "extension.be-ext-vaccination-originalorder",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines."
}, {
"id": "be-model-vaccination.recorder",
"max": "1",
"min": 1,
"path": "be-model-vaccination.recorder",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"short": "The professional that recorded the administration of the vaccine",
"mapping": [ {
"map": "extension.be-ext-recorder",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The professional that recorded the administration of the vaccine."
}, {
"id": "be-model-vaccination.performer",
"max": "1",
"min": 0,
"path": "be-model-vaccination.performer",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner" ]
} ],
"short": "The professional that administered the medication",
"mapping": [ {
"map": "performer",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The professional that administered the medication. Use code \"unknown\" if not known."
}, {
"id": "be-model-vaccination.vaccineCode",
"max": "1",
"min": 1,
"path": "be-model-vaccination.vaccineCode",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa",
"mapping": [ {
"map": "vaccineCode",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value."
}, {
"id": "be-model-vaccination.vaccinationDate[x]",
"max": "1",
"min": 0,
"path": "be-model-vaccination.vaccinationDate[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "string"
} ],
"short": "The date and time when the vaccination has been administered",
"mapping": [ {
"map": "occurrence",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The date and/or time when the vaccine administration has been administered or presumed to be administered"
}, {
"id": "be-model-vaccination.administeredProduct",
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct",
"type": [ {
"code": "BackboneElement"
} ],
"short": "The details of the product that was administered.",
"mapping": [ {
"map": "extension.be-ext-administeredProduct",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The details of the product that was administered"
}, {
"path": "be-model-vaccination.administeredProduct.product[x]",
"min": 0,
"definition": "The actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392)",
"short": "The actual product that was administered. This should be a product code or a reference to an actual Medication resource",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.code",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "Reference"
}, {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "be-model-vaccination.administeredProduct.product[x]",
"comment": "In the case where the product is not known, use code \"unknown\""
}, {
"id": "be-model-vaccination.administeredProduct.lotNumber",
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct.lotNumber",
"type": [ {
"code": "string"
} ],
"short": "The lot number",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.batch.lotNumber",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The lot number"
}, {
"id": "be-model-vaccination.administeredProduct.expirationDate",
"max": "1",
"min": 0,
"path": "be-model-vaccination.administeredProduct.expirationDate",
"type": [ {
"code": "date"
} ],
"short": "The expiration date of the product.",
"mapping": [ {
"map": "extension.be-ext-administeredProduct.batch.expirationDate",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The expiration date of the product."
}, {
"id": "be-model-vaccination.route",
"max": "1",
"min": 0,
"path": "be-model-vaccination.route",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The route of administration.",
"mapping": [ {
"map": "route",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The route of administration for the vaccine. This can be free text (not desired) or a code"
}, {
"id": "be-model-vaccination.status",
"max": "1",
"min": 1,
"path": "be-model-vaccination.status",
"type": [ {
"code": "code"
} ],
"short": "The status of this vaccination record entry",
"mapping": [ {
"map": "status",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The status of the vaccination record entry - whether it is active, entered in error, etc."
}, {
"path": "be-model-vaccination.statusReason",
"min": 0,
"definition": "Supporting reason for status information.",
"short": "The reason for the status e.g. 'not completed because...'",
"mapping": [ {
"map": "statusReason",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"valueSet": "https://www.ehealth.fgov.be/standards/fhir/vaccination/ValueSet/be-vs-vaccination-status-reason",
"description": "Belgium codes to describe reasons considered for status of vaccination actions, e.g. reasons for not administering vaccine"
},
"max": "1",
"id": "be-model-vaccination.statusReason"
}, {
"id": "be-model-vaccination.reaction",
"max": "1",
"min": 0,
"path": "be-model-vaccination.reaction",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Reaction to the immunization - cfr. AllergyIntolerance",
"mapping": [ {
"map": "reaction",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "Reaction to the immunization - cfr. AllergyIntolerance"
}, {
"id": "be-model-vaccination.reaction.reactionDate",
"max": "1",
"min": 1,
"path": "be-model-vaccination.reaction.reactionDate",
"type": [ {
"code": "dateTime"
} ],
"short": "date of the reaction",
"mapping": [ {
"map": "reaction.date",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "date of the reaction"
}, {
"id": "be-model-vaccination.reaction.manifestation",
"max": "1",
"min": 0,
"path": "be-model-vaccination.reaction.manifestation",
"type": [ {
"code": "Reference"
} ],
"short": "reference to the observation of the reaction",
"mapping": [ {
"map": "reaction.detail",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "reference to the observation of the reaction"
}, {
"id": "be-model-vaccination.doseQuantity",
"max": "1",
"min": 0,
"path": "be-model-vaccination.doseQuantity",
"type": [ {
"code": "BackboneElement"
} ],
"short": "The number or quantity of product(s) that was administered - e.g. 1/2 dose",
"mapping": [ {
"map": "doseQuantity",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc."
}, {
"id": "be-model-vaccination.note",
"max": "1",
"min": 0,
"path": "be-model-vaccination.note",
"type": [ {
"code": "Attachment"
} ],
"short": "Additional notes for the vaccination.",
"mapping": [ {
"map": "note",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "Additional notes for the vaccination"
}, {
"id": "be-model-vaccination.site",
"max": "1",
"min": 1,
"path": "be-model-vaccination.site",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The body site where the vaccination entered the body",
"mapping": [ {
"map": "site",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The body site where the vaccination entered the body"
}, {
"id": "be-model-vaccination.identifier",
"max": "*",
"min": 0,
"path": "be-model-vaccination.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "The business identifier(s) for the vaccination entry",
"mapping": [ {
"map": "identifier",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "The business identifier(s) for the vaccination entry - This is an optional attribute, used for example to track an entry throughout its lifecycle, or across vaults."
}, {
"id": "be-model-vaccination.bodyLaterality",
"max": "1",
"min": 0,
"path": "be-model-vaccination.bodyLaterality",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The side of the body (for sites that occur on both sides of the body)",
"definition": "The side of the body (for sites that occur on both sides of the body)"
}, {
"id": "be-model-vaccination.location",
"max": "1",
"min": 0,
"path": "be-model-vaccination.location",
"type": [ {
"code": "Reference"
} ],
"short": "The location where the immunization is performed.",
"mapping": [ {
"map": "extension.be-ext-vaccination-location",
"identity": "map-be-model-vaccination-to-be-vaccination"
} ],
"definition": "a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' "
}, {
"id": "be-model-vaccination.locationType",
"max": "1",
"min": 0,
"path": "be-model-vaccination.locationType",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'",
"definition": "The location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home'"
}, {
"id": "be-model-vaccination.cause",
"max": "1",
"min": 0,
"path": "be-model-vaccination.cause",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Is the vaccination due to pre or post exposition prophylaxis?"
} ]
},
"contact": [ {
"name": "eHealth Platform",
"telecom": [ {
"value": "http://www.ehealth.fgov.be/",
"system": "url"
}, {
"value": "support@be-ehealth-standards.atlassian.net",
"system": "email"
} ]
}, {
"name": "Message Structure",
"telecom": [ {
"use": "work",
"value": "support@be-ehealth-standards.atlassian.net",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element"
}