| Package | hl7.fhir.be.vaccination |
| Type | StructureDefinition |
| Id | be-model-vaccination-reduced |
| FHIR Version | R4 |
| Source | https://www.ehealth.fgov.be/standards/fhir/vaccination/https://www.ehealth.fgov.be/standards/fhir/vaccination/1.1.1/StructureDefinition-be-model-vaccination-reduced.html |
| URL | https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced |
| Version | 1.1.1 |
| Status | active |
| Date | 2025-03-24T15:54:48+01:00 |
| Name | BeModelVaccinationReduced |
| Realm | be |
| Authority | hl7 |
| Description | Reduced Logical Model for vaccination |
| Type | https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition be-model-vaccination-reduced
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  be-model-vaccination-reduced | 0..* | Element | Elements defined in Ancestors:@id, extension BeModelVaccinationReduced | |
  patient | 1..1 | Reference(Patient) | The patient that received vaccination. | |
| performer | 1..1 | Reference(Practitioner) | The professional that administered the medication | |
 administeredProduct | 1..1 | BackboneElement | The details of the product that was administered. | |
 product | 1..1 | Coding | The code of the product that was administered. | |
 description | 1..1 | string | The description of the product that was administered. | |
 lotNumber | 0..1 | string | The lot number | |
| identifier | 0..1 | Identifier | The business identifier(s) for the vaccination entry | |
 vaccinationDate[x] | 0..1 | The date and time when the vaccination has been administered | ||
| vaccinationDateDateTime | dateTime | |||
| vaccinationDateString | string | |||
| recorded | 1..1 | dateTime | The date and time when the administration of the vaccine was recorded | |
| doseQuantity | 0..1 | BackboneElement | The number or quantity of product(s) that was administered - e.g. 1/2 dose | |
| targetDisease | 1..1 | CodeableConcept | The target disease for this vaccination. | |
| sideEffects | 0..1 | Attachment | Any noted side effect from this vaccination. | |
| cause | 0..1 | CodeableConcept | Is the vaccination due to pre or post exposition prophylaxis? | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "be-model-vaccination-reduced",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced",
"version": "1.1.1",
"name": "BeModelVaccinationReduced",
"status": "active",
"date": "2025-03-24T15:54:48+01:00",
"publisher": "eHealth Platform",
"contact": [
{
"name": "eHealth Platform",
"telecom": [
{
"system": "url",
"value": "http://www.ehealth.fgov.be/"
},
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net"
}
]
},
{
"name": "Message Structure",
"telecom": [
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net",
"use": "work"
}
]
}
],
"description": "Reduced Logical Model for vaccination",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "BE",
"display": "Belgium"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "https://www.ehealth.fgov.be/standards/fhir/vaccination/StructureDefinition/be-model-vaccination-reduced",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "be-model-vaccination-reduced",
"path": "be-model-vaccination-reduced",
"short": "BeModelVaccinationReduced",
"definition": "BeModelVaccinationReduced",
"min": 0,
"max": "*",
"base": {
"path": "Element",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "be-model-vaccination-reduced.id",
"path": "be-model-vaccination-reduced.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "be-model-vaccination-reduced.extension",
"path": "be-model-vaccination-reduced.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "be-model-vaccination-reduced.patient",
"path": "be-model-vaccination-reduced.patient",
"short": "The patient that received vaccination.",
"definition": "The patient that has received the vaccination.",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "be-model-vaccination-reduced.performer",
"path": "be-model-vaccination-reduced.performer",
"short": "The professional that administered the medication",
"definition": "The professional that administered the medication. Use code \"unknown\" if not known.",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.performer",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct",
"path": "be-model-vaccination-reduced.administeredProduct",
"short": "The details of the product that was administered.",
"definition": "The details of the product that was administered",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.administeredProduct",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.id",
"path": "be-model-vaccination-reduced.administeredProduct.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.extension",
"path": "be-model-vaccination-reduced.administeredProduct.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.modifierExtension",
"path": "be-model-vaccination-reduced.administeredProduct.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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).",
"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.",
"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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.product",
"path": "be-model-vaccination-reduced.administeredProduct.product",
"short": "The code of the product that was administered.",
"definition": "The code of the product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml).",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.administeredProduct.product",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.description",
"path": "be-model-vaccination-reduced.administeredProduct.description",
"short": "The description of the product that was administered.",
"definition": "The description of the product that was administered.",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.administeredProduct.description",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.lotNumber",
"path": "be-model-vaccination-reduced.administeredProduct.lotNumber",
"short": "The lot number",
"definition": "The lot number",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.administeredProduct.lotNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.identifier",
"path": "be-model-vaccination-reduced.identifier",
"short": "The business identifier(s) for the vaccination entry",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "be-model-vaccination-reduced.vaccinationDate[x]",
"path": "be-model-vaccination-reduced.vaccinationDate[x]",
"short": "The date and time when the vaccination has been administered",
"definition": "The date and/or time when the vaccine administration has been administered or presumed to be administered",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.vaccinationDate[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
},
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.recorded",
"path": "be-model-vaccination-reduced.recorded",
"short": "The date and time when the administration of the vaccine was recorded",
"definition": "The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.recorded",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "be-model-vaccination-reduced.doseQuantity",
"path": "be-model-vaccination-reduced.doseQuantity",
"short": "The number or quantity of product(s) that was administered - e.g. 1/2 dose",
"definition": "The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.doseQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "be-model-vaccination-reduced.targetDisease",
"path": "be-model-vaccination-reduced.targetDisease",
"short": "The target disease for this vaccination.",
"definition": "The target disease for this vaccination.",
"min": 1,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.targetDisease",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "be-model-vaccination-reduced.sideEffects",
"path": "be-model-vaccination-reduced.sideEffects",
"short": "Any noted side effect from this vaccination.",
"definition": "Any noted side effect from this vaccination.",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.sideEffects",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Attachment"
}
]
},
{
"id": "be-model-vaccination-reduced.cause",
"path": "be-model-vaccination-reduced.cause",
"short": "Is the vaccination due to pre or post exposition prophylaxis?",
"definition": "Is the vaccination due to pre or post exposition prophylaxis?",
"min": 0,
"max": "1",
"base": {
"path": "be-model-vaccination-reduced.cause",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
}
]
},
"differential": {
"element": [
{
"id": "be-model-vaccination-reduced",
"path": "be-model-vaccination-reduced",
"short": "BeModelVaccinationReduced",
"definition": "BeModelVaccinationReduced"
},
{
"id": "be-model-vaccination-reduced.patient",
"path": "be-model-vaccination-reduced.patient",
"short": "The patient that received vaccination.",
"definition": "The patient that has received the vaccination.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
]
},
{
"id": "be-model-vaccination-reduced.performer",
"path": "be-model-vaccination-reduced.performer",
"short": "The professional that administered the medication",
"definition": "The professional that administered the medication. Use code \"unknown\" if not known.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct",
"path": "be-model-vaccination-reduced.administeredProduct",
"short": "The details of the product that was administered.",
"definition": "The details of the product that was administered",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.product",
"path": "be-model-vaccination-reduced.administeredProduct.product",
"short": "The code of the product that was administered.",
"definition": "The code of the product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml).",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.description",
"path": "be-model-vaccination-reduced.administeredProduct.description",
"short": "The description of the product that was administered.",
"definition": "The description of the product that was administered.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.administeredProduct.lotNumber",
"path": "be-model-vaccination-reduced.administeredProduct.lotNumber",
"short": "The lot number",
"definition": "The lot number",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.identifier",
"path": "be-model-vaccination-reduced.identifier",
"short": "The business identifier(s) for the vaccination entry",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "be-model-vaccination-reduced.vaccinationDate[x]",
"path": "be-model-vaccination-reduced.vaccinationDate[x]",
"short": "The date and time when the vaccination has been administered",
"definition": "The date and/or time when the vaccine administration has been administered or presumed to be administered",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "string"
}
]
},
{
"id": "be-model-vaccination-reduced.recorded",
"path": "be-model-vaccination-reduced.recorded",
"short": "The date and time when the administration of the vaccine was recorded",
"definition": "The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "be-model-vaccination-reduced.doseQuantity",
"path": "be-model-vaccination-reduced.doseQuantity",
"short": "The number or quantity of product(s) that was administered - e.g. 1/2 dose",
"definition": "The number or quantity of product(s) that was administered - e.g. 1/2 dose, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "be-model-vaccination-reduced.targetDisease",
"path": "be-model-vaccination-reduced.targetDisease",
"short": "The target disease for this vaccination.",
"definition": "The target disease for this vaccination.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "be-model-vaccination-reduced.sideEffects",
"path": "be-model-vaccination-reduced.sideEffects",
"short": "Any noted side effect from this vaccination.",
"definition": "Any noted side effect from this vaccination.",
"min": 0,
"max": "1",
"type": [
{
"code": "Attachment"
}
]
},
{
"id": "be-model-vaccination-reduced.cause",
"path": "be-model-vaccination-reduced.cause",
"short": "Is the vaccination due to pre or post exposition prophylaxis?",
"definition": "Is the vaccination due to pre or post exposition prophylaxis?",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
}
]
}
}