HL7 Belgium FHIR specifications
0.1 - QA review
HL7 Belgium FHIR specifications
0.1 - QA review
This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
JSON representation of the be-model-immunization Profile.
{
"resourceType" : "StructureDefinition",
"id" : "be-model-immunization",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Minimum and Maximum # of times the the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization\">BEImmunization</a><a name=\"BEImmunization\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..*</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A record of an immunization or vaccination<br/></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.identifier\" title=\"The business identifier(s) for the immunization entry - This is an optional attribute, used for example to track an entry throughout its lifecycle, or across vaults.\">identifier</a><a name=\"BEImmunization.identifier\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The business identifier(s) for the immunization entry</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.status\" title=\"The status of the immunization record entry - whether it is active, entered in error, etc.\">status</a><a name=\"BEImmunization.status\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\" title=\"code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The status of this immunization record entry</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.statusReason\" title=\"Supporting reason for status information.....\">statusReason</a><a name=\"BEImmunization.statusReason\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\" title=\"CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The reason for the status e.g. entered in error because ...</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.patient\" title=\"The patient that has received the immunization.\">patient</a><a name=\"BEImmunization.patient\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>(<a href=\"StructureDefinition-be-patient.html\">BePatient</a>)</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The patient that received immunization.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.vaccineCode\" title=\"The target of the immunization - the disease that the immunization action is protecting against. This should be a coded value.\">vaccineCode</a><a name=\"BEImmunization.vaccineCode\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.dateTime\" title=\"The date and/or time when the immunization administration has been recorded\">dateTime</a><a name=\"BEImmunization.dateTime\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\" title=\"dateTime\">dateTime</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The dateTime when the immunization has been recorded</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.immunizationPlan\" title=\"The patient-specific order or recommendation for the immunization, for example a prescription or a request for immunization for a patient by a physician, for example for optional vaccines.\">immunizationPlan</a><a name=\"BEImmunization.immunizationPlan\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>()</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The patient-specific order or recommendation for the immunization</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.protocol\" title=\"The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling. For example 'Basisvaccinatieschema'\">protocol</a><a name=\"BEImmunization.protocol\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>()</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.type\" title=\"The type of immunization action - for example first dose or reinforcement.\">type</a><a name=\"BEImmunization.type\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The type of immunization action - for example first dose or reinforcement.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.reporter\" title=\"The professional that recorded the administration of the vaccine.\">reporter</a><a name=\"BEImmunization.reporter\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>(<a href=\"StructureDefinition-be-practitioner.html\">BePractitioner</a>)</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The professional that recorded the administration of the vaccine</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.recorded\" title=\"The date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.\">recorded</a><a name=\"BEImmunization.recorded\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The date and time when the administration of the vaccine was recorded</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.performer\" title=\"The professional that administered the medication.\">performer</a><a name=\"BEImmunization.performer\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">Reference</a>(<a href=\"StructureDefinition-be-practitioner.html\">BePractitioner</a>)</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The professional that administered the medication</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.route\" title=\"The route of administration for the vaccine. This can be free text (not desired) or a code\">route</a><a name=\"BEImmunization.route\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The route of administration.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck11.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.administeredProduct\">administeredProduct</a><a name=\"BEImmunization.administeredProduct\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#BackboneElement\">BackboneElement</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The details of the product that was administered.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.administeredProduct.product\">product</a><a name=\"BEImmunization.administeredProduct.product\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">CodeableReference</a>()</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">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)</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck110.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_primitive.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Primitive Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.administeredProduct.lotNumber\" title=\"The lot number\">lotNumber</a><a name=\"BEImmunization.administeredProduct.lotNumber\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The lot number</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck100.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vline.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_resource.png\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.administeredProduct.expirationDate\" title=\"The expiration date of the product.\">expirationDate</a><a name=\"BEImmunization.administeredProduct.expirationDate\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Date</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The expiration date of the product.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_reference.png\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Reference to another Resource\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.location\" title=\"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' or a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' \">location</a><a name=\"BEImmunization.location\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/references.html\">CodeableReference</a>()</td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">The location of the immunization.</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7;\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_datatype.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Data Type\" class=\"hierarchy\"/> <a href=\"StructureDefinition-be-model-immunization-definitions.html#BEImmunization.note\" title=\"Additional notes for the immunization\">note</a><a name=\"BEImmunization.note\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">0..1</td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#Attachment\" title=\"Attachment\">Attachment</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">Additional notes for the immunization.</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"http://hl7.org/fhir/R4/formats.html#table\" title=\"Legend for this format\"><img src=\"http://hl7.org/fhir/R4/help16.png\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "https://www.hl7belgium.org/fhir/StructureDefinition/be-model-immunization",
"version" : "0.1",
"name" : "BEImmunization",
"status" : "draft",
"date" : "2020-05-17T22:38:14+02:00",
"publisher" : "HL7 Belgium",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://hl7belgium.org"
}
]
}
],
"description" : "This is the logical model of the patient's immunization entries in an immunization or vaccination record. The patient immunization record of several entries as modeled here.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "056"
}
],
"text" : "Belgium"
}
],
"fhirVersion" : "4.0.1",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "BEImmunization",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Resource",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "BEImmunization",
"path" : "BEImmunization",
"short" : "A record of an immunization or vaccination",
"definition" : "This is the base resource type for everything.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Resource",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
}
]
},
{
"id" : "BEImmunization.id",
"path" : "BEImmunization.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.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" : true
},
{
"id" : "BEImmunization.meta",
"path" : "BEImmunization.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"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,
"isSummary" : true
},
{
"id" : "BEImmunization.implicitRules",
"path" : "BEImmunization.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"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" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary" : true
},
{
"id" : "BEImmunization.language",
"path" : "BEImmunization.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"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,
"isSummary" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "preferred",
"description" : "A human language.",
"valueSet" : "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id" : "BEImmunization.identifier",
"path" : "BEImmunization.identifier",
"short" : "The business identifier(s) for the immunization entry",
"definition" : "The business identifier(s) for the immunization 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" : "BEImmunization.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "BEImmunization.status",
"path" : "BEImmunization.status",
"short" : "The status of this immunization record entry",
"definition" : "The status of the immunization record entry - whether it is active, entered in error, etc.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "BEImmunization.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/code"
]
}
]
},
{
"id" : "BEImmunization.statusReason",
"path" : "BEImmunization.statusReason",
"short" : "The reason for the status e.g. entered in error because ...",
"definition" : "Supporting reason for status information.....",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.statusReason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/CodeableConcept"
]
}
]
},
{
"id" : "BEImmunization.patient",
"path" : "BEImmunization.patient",
"short" : "The patient that received immunization.",
"definition" : "The patient that has received the immunization.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "BEImmunization.patient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient"
]
}
]
},
{
"id" : "BEImmunization.vaccineCode",
"path" : "BEImmunization.vaccineCode",
"short" : "The target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV",
"definition" : "The target of the immunization - the disease that the immunization action is protecting against. This should be a coded value.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.vaccineCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
]
},
{
"id" : "BEImmunization.dateTime",
"path" : "BEImmunization.dateTime",
"short" : "The dateTime when the immunization has been recorded",
"definition" : "The date and/or time when the immunization administration has been recorded",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.dateTime",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/dateTime"
]
}
]
},
{
"id" : "BEImmunization.immunizationPlan",
"path" : "BEImmunization.immunizationPlan",
"short" : "The patient-specific order or recommendation for the immunization",
"definition" : "The patient-specific order or recommendation for the immunization, for example a prescription or a request for immunization for a patient by a physician, for example for optional vaccines.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.immunizationPlan",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference"
}
]
},
{
"id" : "BEImmunization.protocol",
"path" : "BEImmunization.protocol",
"short" : "The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling",
"definition" : "The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling. For example 'Basisvaccinatieschema'",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.protocol",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference"
}
]
},
{
"id" : "BEImmunization.type",
"path" : "BEImmunization.type",
"short" : "The type of immunization action - for example first dose or reinforcement.",
"definition" : "The type of immunization action - for example first dose or reinforcement.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "BEImmunization.reporter",
"path" : "BEImmunization.reporter",
"short" : "The professional that recorded the administration of the vaccine",
"definition" : "The professional that recorded the administration of the vaccine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.reporter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner"
]
}
]
},
{
"id" : "BEImmunization.recorded",
"path" : "BEImmunization.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" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.recorded",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
]
},
{
"id" : "BEImmunization.performer",
"path" : "BEImmunization.performer",
"short" : "The professional that administered the medication",
"definition" : "The professional that administered the medication.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.performer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner"
]
}
]
},
{
"id" : "BEImmunization.route",
"path" : "BEImmunization.route",
"short" : "The route of administration.",
"definition" : "The route of administration for the vaccine. This can be free text (not desired) or a code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.route",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
]
},
{
"id" : "BEImmunization.administeredProduct",
"path" : "BEImmunization.administeredProduct",
"short" : "The details of the product that was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.administeredProduct",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "BEImmunization.administeredProduct.product",
"path" : "BEImmunization.administeredProduct.product",
"short" : "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)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.administeredProduct.product",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableReference"
}
]
},
{
"id" : "BEImmunization.administeredProduct.lotNumber",
"path" : "BEImmunization.administeredProduct.lotNumber",
"short" : "The lot number",
"definition" : "The lot number",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.administeredProduct.lotNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "BEImmunization.administeredProduct.expirationDate",
"path" : "BEImmunization.administeredProduct.expirationDate",
"short" : "The expiration date of the product.",
"definition" : "The expiration date of the product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.administeredProduct.expirationDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Date"
}
]
},
{
"id" : "BEImmunization.location",
"path" : "BEImmunization.location",
"short" : "The location of the immunization.",
"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' or a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' ",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableReference"
}
]
},
{
"id" : "BEImmunization.note",
"path" : "BEImmunization.note",
"short" : "Additional notes for the immunization.",
"definition" : "Additional notes for the immunization",
"min" : 0,
"max" : "1",
"base" : {
"path" : "BEImmunization.note",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Attachment",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/Attachment"
]
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "BEImmunization",
"path" : "BEImmunization",
"short" : "A record of an immunization or vaccination",
"min" : 0,
"max" : "*"
},
{
"id" : "BEImmunization.identifier",
"path" : "BEImmunization.identifier",
"short" : "The business identifier(s) for the immunization entry",
"definition" : "The business identifier(s) for the immunization 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" : "BEImmunization.status",
"path" : "BEImmunization.status",
"short" : "The status of this immunization record entry",
"definition" : "The status of the immunization record entry - whether it is active, entered in error, etc.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/code"
]
}
]
},
{
"id" : "BEImmunization.statusReason",
"path" : "BEImmunization.statusReason",
"short" : "The reason for the status e.g. entered in error because ...",
"definition" : "Supporting reason for status information.....",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/CodeableConcept"
]
}
]
},
{
"id" : "BEImmunization.patient",
"path" : "BEImmunization.patient",
"short" : "The patient that received immunization.",
"definition" : "The patient that has received the immunization.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient"
]
}
]
},
{
"id" : "BEImmunization.vaccineCode",
"path" : "BEImmunization.vaccineCode",
"short" : "The target of the immunization - the disease that the immunization action is protecting against - e.g. Polio, Tetanus, HPV",
"definition" : "The target of the immunization - the disease that the immunization action is protecting against. This should be a coded value.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
]
},
{
"id" : "BEImmunization.dateTime",
"path" : "BEImmunization.dateTime",
"short" : "The dateTime when the immunization has been recorded",
"definition" : "The date and/or time when the immunization administration has been recorded",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "dateTime",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/dateTime"
]
}
]
},
{
"id" : "BEImmunization.immunizationPlan",
"path" : "BEImmunization.immunizationPlan",
"short" : "The patient-specific order or recommendation for the immunization",
"definition" : "The patient-specific order or recommendation for the immunization, for example a prescription or a request for immunization for a patient by a physician, for example for optional vaccines.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference"
}
]
},
{
"id" : "BEImmunization.protocol",
"path" : "BEImmunization.protocol",
"short" : "The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling",
"definition" : "The vaccination plan or protocol (not patient-specific) that this immunization is fulfilling. For example 'Basisvaccinatieschema'",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference"
}
]
},
{
"id" : "BEImmunization.type",
"path" : "BEImmunization.type",
"short" : "The type of immunization action - for example first dose or reinforcement.",
"definition" : "The type of immunization action - for example first dose or reinforcement.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "BEImmunization.reporter",
"path" : "BEImmunization.reporter",
"short" : "The professional that recorded the administration of the vaccine",
"definition" : "The professional that recorded the administration of the vaccine.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner"
]
}
]
},
{
"id" : "BEImmunization.recorded",
"path" : "BEImmunization.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" : 0,
"max" : "1",
"type" : [
{
"code" : "dateTime"
}
]
},
{
"id" : "BEImmunization.performer",
"path" : "BEImmunization.performer",
"short" : "The professional that administered the medication",
"definition" : "The professional that administered the medication.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : [
"https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner"
]
}
]
},
{
"id" : "BEImmunization.route",
"path" : "BEImmunization.route",
"short" : "The route of administration.",
"definition" : "The route of administration for the vaccine. This can be free text (not desired) or a code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
]
},
{
"id" : "BEImmunization.administeredProduct",
"path" : "BEImmunization.administeredProduct",
"short" : "The details of the product that was administered.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "BackboneElement"
}
]
},
{
"id" : "BEImmunization.administeredProduct.product",
"path" : "BEImmunization.administeredProduct.product",
"short" : "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)",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableReference"
}
]
},
{
"id" : "BEImmunization.administeredProduct.lotNumber",
"path" : "BEImmunization.administeredProduct.lotNumber",
"short" : "The lot number",
"definition" : "The lot number",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "BEImmunization.administeredProduct.expirationDate",
"path" : "BEImmunization.administeredProduct.expirationDate",
"short" : "The expiration date of the product.",
"definition" : "The expiration date of the product.",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Date"
}
]
},
{
"id" : "BEImmunization.location",
"path" : "BEImmunization.location",
"short" : "The location of the immunization.",
"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' or a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' ",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "CodeableReference"
}
]
},
{
"id" : "BEImmunization.note",
"path" : "BEImmunization.note",
"short" : "Additional notes for the immunization.",
"definition" : "Additional notes for the immunization",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Attachment",
"profile" : [
"http://hl7.org/fhir/StructureDefinition/Attachment"
]
}
]
}
]
}
}
IG © 2020 HL7 Belgium. Package hl7.be.fhir.core#0.1 based on FHIR 4.0.1. Generated 2020-05-17
Links: Table of Contents |
QA Report |
Version History |
|
Propose a change