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/ and changes regularly. See the Directory of published versions
| Active as of 2024-10-07 |
JSON representation of the ModelICVPVaccineDetails logical model.
{
"resourceType" : "StructureDefinition",
"id" : "ModelICVPVaccineDetails",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition"🔗 ,
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition ModelICVPVaccineDetails</b></p><a name=\"ModelICVPVaccineDetails\"> </a><a name=\"hcModelICVPVaccineDetails\"> </a><a name=\"ModelICVPVaccineDetails-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-ModelICVPVaccineDetails-definitions.html#ModelICVPVaccineDetails\" title=\"Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis.\">ModelICVPVaccineDetails</a><a name=\"ModelICVPVaccineDetails\"> </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-ModelVaccineDetails.html\">ModelVaccineDetails</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-ModelVaccineDetails.html\" title=\"Dose Number\">doseNumber</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Name of disease or condition vaccinated or received prophylaxis against\">disease</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Vaccine or prophylaxis classification code\">vaccineClassification</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Vaccine trade item id\">vaccineTradeItem</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Date of vaccine\">date</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre\">clinicianName</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center\">issuer</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Manufacturer ID\">manufacturerId</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Name Manufacturer of vaccine\">manufacturer</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Batch No\">batchNo</a>, <a href=\"StructureDefinition-ModelVaccineDetails.html\" title=\"Certificate validity period\">validityPeriod</a><br/>ICVP - Vaccine Details<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_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_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ModelICVPVaccineDetails-definitions.html#ModelICVPVaccineDetails.disease\">disease</a><a name=\"ModelICVPVaccineDetails.disease\"> </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><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">1</span></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=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</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\">Disease</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-ICVPDiseaseTargeted.html\" title=\"http://smart.who.int/icvp/ValueSet/ICVPDiseaseTargeted\">ICVP Disease Targeted</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 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_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: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-ModelICVPVaccineDetails-definitions.html#ModelICVPVaccineDetails.vaccineClassification\">vaccineClassification</a><a name=\"ModelICVPVaccineDetails.vaccineClassification\"> </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\">1</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#CodeableConcept\">CodeableConcept</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 code</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-ICVPVaccineCodes.html\" title=\"http://smart.who.int/icvp/ValueSet/ICVPVaccineCodes\">ICVP - Vaccine Codes</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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"valueBoolean" : true
}
],
"url" : "http://smart.who.int/icvp/StructureDefinition/ModelICVPVaccineDetails",
"version" : "0.1.0",
"name" : "ModelICVPVaccineDetails",
"title" : "ICVP - Vaccine Details",
"status" : "active",
"experimental" : true,
"date" : "2024-10-07T07:08:56+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis.",
"fhirVersion" : "4.0.1",
"kind" : "logical",
"abstract" : false,
"type" : "http://smart.who.int/icvp/StructureDefinition/ModelICVPVaccineDetails",
"baseDefinition" : "http://smart.who.int/icvp/StructureDefinition/ModelVaccineDetails",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "ModelICVPVaccineDetails",
"path" : "ModelICVPVaccineDetails",
"short" : "ICVP - Vaccine Details",
"definition" : "Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false
},
{
"id" : "ModelICVPVaccineDetails.doseNumber",
"path" : "ModelICVPVaccineDetails.doseNumber",
"short" : "Dose Number",
"definition" : "Dose Number",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.doseNumber",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/icvp/ValueSet/doseNumber"
}
},
{
"id" : "ModelICVPVaccineDetails.disease",
"path" : "ModelICVPVaccineDetails.disease",
"short" : "Disease",
"definition" : "Name of disease or condition vaccinated or received prophylaxis against",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.disease",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Coding"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/icvp/ValueSet/ICVPDiseaseTargeted"
}
},
{
"id" : "ModelICVPVaccineDetails.vaccineClassification",
"path" : "ModelICVPVaccineDetails.vaccineClassification",
"short" : "Vaccine code",
"definition" : "Vaccine or prophylaxis classification code",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.vaccineClassification",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/icvp/ValueSet/ICVPVaccineCodes"
}
},
{
"id" : "ModelICVPVaccineDetails.vaccineTradeItem",
"path" : "ModelICVPVaccineDetails.vaccineTradeItem",
"short" : "vaccine trade item id",
"definition" : "Vaccine trade item id",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.vaccineTradeItem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "ModelICVPVaccineDetails.date",
"path" : "ModelICVPVaccineDetails.date",
"short" : "Date",
"definition" : "Date of vaccine",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.date",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
]
},
{
"id" : "ModelICVPVaccineDetails.clinicianName",
"path" : "ModelICVPVaccineDetails.clinicianName",
"short" : "Name of supervising clinician",
"definition" : "Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.clinicianName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVPVaccineDetails.issuer",
"path" : "ModelICVPVaccineDetails.issuer",
"short" : "Issuing Organization",
"definition" : "Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.issuer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Organization"
]
}
]
},
{
"id" : "ModelICVPVaccineDetails.manufacturerId",
"path" : "ModelICVPVaccineDetails.manufacturerId",
"short" : "Manufacture ID",
"definition" : "Manufacturer ID",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.manufacturerId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
]
},
{
"id" : "ModelICVPVaccineDetails.manufacturer",
"path" : "ModelICVPVaccineDetails.manufacturer",
"short" : "Name of Manufacturer of vaccine",
"definition" : "Name Manufacturer of vaccine",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.manufacturer",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVPVaccineDetails.batchNo",
"path" : "ModelICVPVaccineDetails.batchNo",
"short" : "Batch No",
"definition" : "Batch No",
"min" : 1,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.batchNo",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
]
},
{
"id" : "ModelICVPVaccineDetails.validityPeriod",
"path" : "ModelICVPVaccineDetails.validityPeriod",
"short" : "Certificate validity period",
"definition" : "Certificate validity period",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ModelVaccineDetails.validityPeriod",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "ModelICVPVaccineDetails",
"path" : "ModelICVPVaccineDetails",
"short" : "ICVP - Vaccine Details",
"definition" : "Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis."
},
{
"id" : "ModelICVPVaccineDetails.disease",
"path" : "ModelICVPVaccineDetails.disease",
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/icvp/ValueSet/ICVPDiseaseTargeted"
}
},
{
"id" : "ModelICVPVaccineDetails.vaccineClassification",
"path" : "ModelICVPVaccineDetails.vaccineClassification",
"binding" : {
"strength" : "required",
"valueSet" : "http://smart.who.int/icvp/ValueSet/ICVPVaccineCodes"
}
}
]
}
}