SMART ICVP
0.1.0 - ci-build
SMART ICVP, published by 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-icvp/tree/main and changes regularly. See the Directory of published versions
| Draft as of 2024-12-11 |
JSON representation of the ICVPEvent logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ICVPEvent",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition ICVPEvent</b></p><a name=\"ICVPEvent\"> </a><a name=\"hcICVPEvent\"> </a><a name=\"ICVPEvent-en-US\"> </a><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 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-ICVPEvent-definitions.html#ModelICVP\">ModelICVP</a><a name=\"ModelICVP\"> </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-ModelICVP.html\">ModelICVP</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-ModelDVC.html\" title=\"The full name of the client\">name</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Date of Birth\">dob</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Sex\">sex</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Nationality\">nationality</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"National Identification Document\">nid</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Name of Parent or Guardian\">guardian</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Document issuer\">issuer</a>, <a href=\"StructureDefinition-ModelDVC.html\" title=\"Vaccine Details\">vaccineDetails</a>, <a href=\"StructureDefinition-ModelICVP.html\">vaccineDetails</a><br/><span style=\"opacity: 0.5\">ICVP</span><br/><span style=\"font-weight:bold\">Instances of this logical model can 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_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_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ICVPEvent-definitions.html#ModelICVP.vaccineDetails\">vaccineDetails</a><a name=\"ModelICVP.vaccineDetails\"> </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\"><span style=\"opacity: 0.5\">1</span>..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 style=\"opacity: 0.5\" href=\"StructureDefinition-ModelICVPVaccineDetails.html\">ModelICVPVaccineDetails</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Vaccine Details</span></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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"valueBoolean" : true
}
],
"url" : "http://smart.who.int/icvp/StructureDefinition/ICVPEvent",
"version" : "0.1.0",
"name" : "ICVPEvent",
"title" : "ICVP Event",
"status" : "draft",
"date" : "2024-12-11T15:43:16+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "ICVP for a single immunization event",
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "http://smart.who.int/icvp/StructureDefinition/ModelICVP",
"baseDefinition" : "http://smart.who.int/icvp/StructureDefinition/ModelICVP",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "ModelICVP",
"path" : "ModelICVP",
"short" : "ICVP",
"definition" : "Data elements for the Model International Certificate of Vaccination or Prophylaxis.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "mustHaveIssuerOrClinician",
"severity" : "error",
"human" : "Either issuer or clinicianName must be present",
"expression" : "vaccineDetails.issuer.exists() or vaccineDetails.clinicianName.exists()",
"source" : "http://smart.who.int/icvp/StructureDefinition/ModelDVC"
}
],
"isModifier" : false
},
{
"id" : "ModelICVP.name",
"path" : "ModelICVP.name",
"short" : "Name",
"definition" : "The full name of the client",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelDVC.name",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVP.dob",
"path" : "ModelICVP.dob",
"short" : "Date of Birth",
"definition" : "Date of Birth",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelDVC.dob",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
]
},
{
"id" : "ModelICVP.sex",
"path" : "ModelICVP.sex",
"short" : "Sex",
"definition" : "Sex",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelDVC.sex",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "ModelICVP.nationality",
"path" : "ModelICVP.nationality",
"short" : "Nationality",
"definition" : "Nationality",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelDVC.nationality",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
]
},
{
"id" : "ModelICVP.nid",
"path" : "ModelICVP.nid",
"short" : "National Identification Document",
"definition" : "National Identification Document",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelDVC.nid",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVP.guardian",
"path" : "ModelICVP.guardian",
"short" : "Parent/Guardian",
"definition" : "Name of Parent or Guardian",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelDVC.guardian",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVP.issuer",
"path" : "ModelICVP.issuer",
"short" : "Document issuer",
"definition" : "Document issuer",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelDVC.issuer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Organization"
]
}
]
},
{
"id" : "ModelICVP.vaccineDetails",
"path" : "ModelICVP.vaccineDetails",
"short" : "Vaccine Details",
"definition" : "Vaccine Details",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelDVC.vaccineDetails",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "http://smart.who.int/icvp/StructureDefinition/ModelICVPVaccineDetails"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ModelICVP",
"path" : "ModelICVP"
},
{
"id" : "ModelICVP.vaccineDetails",
"path" : "ModelICVP.vaccineDetails",
"max" : "1"
}
]
}
}