WHO Immunization Implementation Guide
0.1.0 - CI Build
WHO Immunization Implementation Guide
0.1.0 - CI Build
WHO Immunization Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations and changes regularly. See the Directory of published versions
| Draft as of 2024-05-30 |
JSON representation of the IMMZD1ClientHistoryYellowFever logical model.
{
"resourceType" : "StructureDefinition",
"id" : "IMMZD1ClientHistoryYellowFever",
"text" : {
"status" : "extensions",
"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=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" 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=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" 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=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" 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=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" 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=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description & Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" 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-IMMZD1ClientHistoryYellowFever-definitions.html#IMMZD1ClientHistoryYellowFever\" title=\"Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.\">IMMZD1ClientHistoryYellowFever</a><a name=\"IMMZD1ClientHistoryYellowFever\"> </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\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></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=\"StructureDefinition-IMMZD1ClientHistory.html\">IMMZ_D1_Client_History</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The patient who is being checked for contraindications.\">patient</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The type of dose in a series that the client received\">type</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen.\">completedPrimarySeries</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"Indicates if the client has completed the booster series of a product/antigen\">booster</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The date when the client completed the primary vaccination series (per product/antigen)\">dateSeriesCompleted</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The current human immunodeficiency virus (HIV) status of the client\">hivStatus</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The infant was preterm; the mother gave birth to the infant when gestational age was less than 37 weeks\">pretermBirth</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases\">immunocompromised</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"The client is currently receiving antiretroviral therapy (ART)\">onART</a>, <a href=\"StructureDefinition-IMMZD1ClientHistory.html\" title=\"History of previous vaccine doses.\">vaccineHistory</a><br/>IMMZ.D1 Capture Client History for Yellow Fever<br/><span style=\"font-weight:bold\">Instances of this logical model are not marked to be the target of a Reference</span></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_bck01.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_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-IMMZD1ClientHistoryYellowFever-definitions.html#IMMZD1ClientHistoryYellowFever.vaccineHistory\">vaccineHistory</a><a name=\"IMMZD1ClientHistoryYellowFever.vaccineHistory\"> </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\"/><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\"/></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_bck000.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_blank.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.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-IMMZD1ClientHistoryYellowFever-definitions.html#IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType\">vaccineType</a><a name=\"IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType\"> </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\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Vaccine type</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-IMMZ.Z.DE23.html\" title=\"http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE23\">IMMZ.Z.DE23 Yellow fever containing vaccines</a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#required\" title=\"To be conformant, the concept in this element SHALL be from the specified value set.\">required</a>)</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistoryYellowFever",
"version" : "0.1.0",
"name" : "IMMZ_D1_Client_History_YellowFever",
"title" : "IMMZ.D1 Capture Client History for Yellow Fever",
"status" : "draft",
"date" : "2024-05-30T21:26:16+00:00",
"publisher" : "World Health Organization (WHO)",
"contact" : [
{
"name" : "World Health Organization (WHO)",
"telecom" : [
{
"system" : "url",
"value" : "https://www.who.int"
}
]
}
],
"description" : "Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistoryYellowFever",
"baseDefinition" : "http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistory",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "IMMZD1ClientHistoryYellowFever",
"path" : "IMMZD1ClientHistoryYellowFever",
"short" : "IMMZ.D1 Capture Client History for Yellow Fever",
"definition" : "Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "IMMZD1ClientHistoryYellowFever.patient",
"path" : "IMMZD1ClientHistoryYellowFever.patient",
"short" : "Patient",
"definition" : "The patient who is being checked for contraindications.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.patient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.type",
"path" : "IMMZD1ClientHistoryYellowFever.type",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE103"
}
],
"short" : "Type of dose",
"definition" : "The type of dose in a series that the client received",
"min" : 1,
"max" : "*",
"base" : {
"path" : "IMMZD1ClientHistory.type",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103"
}
},
{
"id" : "IMMZD1ClientHistoryYellowFever.completedPrimarySeries",
"path" : "IMMZD1ClientHistoryYellowFever.completedPrimarySeries",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE8"
}
],
"short" : "Completed the primary vaccination series",
"definition" : "Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.completedPrimarySeries",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.booster",
"path" : "IMMZD1ClientHistoryYellowFever.booster",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE102"
}
],
"short" : "Completed the booster series",
"definition" : "Indicates if the client has completed the booster series of a product/antigen",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.booster",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.dateSeriesCompleted",
"path" : "IMMZD1ClientHistoryYellowFever.dateSeriesCompleted",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE81"
}
],
"short" : "Date when primary vaccination series was completed",
"definition" : "The date when the client completed the primary vaccination series (per product/antigen)",
"min" : 1,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.dateSeriesCompleted",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.hivStatus",
"path" : "IMMZD1ClientHistoryYellowFever.hivStatus",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE10"
},
{
"system" : "http://loinc.org",
"code" : "55277-8"
},
{
"system" : "http://snomed.info/sct",
"code" : "278977008"
}
],
"short" : "HIV status",
"definition" : "The current human immunodeficiency virus (HIV) status of the client",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.hivStatus",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10"
}
},
{
"id" : "IMMZD1ClientHistoryYellowFever.pretermBirth",
"path" : "IMMZD1ClientHistoryYellowFever.pretermBirth",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE15"
},
{
"system" : "http://hl7.org/fhir/sid/icd-11",
"code" : "KA21.4"
},
{
"system" : "http://loinc.org",
"code" : "76517-2"
},
{
"system" : "http://snomed.info/sct",
"code" : "395507008"
}
],
"short" : "Preterm birth",
"definition" : "The infant was preterm; the mother gave birth to the infant when gestational age was less than 37 weeks",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.pretermBirth",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.immunocompromised",
"path" : "IMMZD1ClientHistoryYellowFever.immunocompromised",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE16"
},
{
"system" : "http://hl7.org/fhir/sid/icd-11",
"code" : "4B4Z"
},
{
"system" : "http://loinc.org",
"code" : "96381-9"
},
{
"system" : "http://snomed.info/sct",
"code" : "370388006"
}
],
"short" : "Immunocompromised",
"definition" : "The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.immunocompromised",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.onART",
"path" : "IMMZD1ClientHistoryYellowFever.onART",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D1",
"code" : "DE17"
}
],
"short" : "Currently on ART",
"definition" : "The client is currently receiving antiretroviral therapy (ART)",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.onART",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
]
},
{
"id" : "IMMZD1ClientHistoryYellowFever.vaccineHistory",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory",
"short" : "Vaccine History",
"definition" : "History of previous vaccine doses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "IMMZD1ClientHistory.vaccineHistory",
"min" : 0,
"max" : "*"
},
"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" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.id",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.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" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.extension",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.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" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.modifierExtension",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.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" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D",
"code" : "DE19"
},
{
"system" : "http://loinc.org",
"code" : "39236-5"
},
{
"system" : "http://snomed.info/sct",
"code" : "787859002"
}
],
"short" : "Vaccine type",
"definition" : "Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine Library list of codes applies in this data element",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.vaccineHistory.vaccineType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE23"
}
},
{
"id" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineDate",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineDate",
"code" : [
{
"system" : "http://smart.who.int/ig/smart-immunizations/CodeSystem/IMMZ.D",
"code" : "DE20"
},
{
"system" : "http://loinc.org",
"code" : "30952-6"
}
],
"short" : "Date and time of vaccination",
"definition" : "Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client",
"min" : 0,
"max" : "1",
"base" : {
"path" : "IMMZD1ClientHistory.vaccineHistory.vaccineDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "IMMZD1ClientHistoryYellowFever",
"path" : "IMMZD1ClientHistoryYellowFever",
"short" : "IMMZ.D1 Capture Client History for Yellow Fever",
"definition" : "Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever."
},
{
"id" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType",
"path" : "IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType",
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE23"
}
}
]
}
}