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

Logical Model: ICVPEvent - XML Profile

Draft as of 2024-12-11

XML representation of the ICVPEvent logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ICVPEvent"/>
  <text>
    <status value="extensions"/>
    <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 &amp; 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>
<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>
<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>
  </text>
  <extension
             url="http://hl7.org/fhir/tools/StructureDefinition/logical-target">
    <valueBoolean value="true"/>
  </extension>
  <url value="http://smart.who.int/icvp/StructureDefinition/ICVPEvent"/>
  <version value="0.1.0"/>
  <name value="ICVPEvent"/>
  <title value="ICVP Event"/>
  <status value="draft"/>
  <date value="2024-12-11T15:44:25+00:00"/>
  <publisher value="WHO"/>
  <contact>
    <name value="WHO"/>
    <telecom>
      <system value="url"/>
      <value value="http://who.int"/>
    </telecom>
  </contact>
  <description value="ICVP for a single immunization event"/>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type value="http://smart.who.int/icvp/StructureDefinition/ModelICVP"/>
  <baseDefinition
                  value="http://smart.who.int/icvp/StructureDefinition/ModelICVP"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="ModelICVP">
      <path value="ModelICVP"/>
      <short value="ICVP"/>
      <definition
                  value="Data elements for the Model International Certificate of Vaccination or Prophylaxis."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <constraint>
        <key value="mustHaveIssuerOrClinician"/>
        <severity value="error"/>
        <human value="Either issuer or clinicianName must be present"/>
        <expression
                    value="vaccineDetails.issuer.exists() or vaccineDetails.clinicianName.exists()"/>
        <source
                value="http://smart.who.int/icvp/StructureDefinition/ModelDVC"/>
      </constraint>
      <isModifier value="false"/>
    </element>
    <element id="ModelICVP.name">
      <path value="ModelICVP.name"/>
      <short value="Name"/>
      <definition value="The full name of the client"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.name"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVP.dob">
      <path value="ModelICVP.dob"/>
      <short value="Date of Birth"/>
      <definition value="Date of Birth"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.dob"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="date"/>
      </type>
    </element>
    <element id="ModelICVP.sex">
      <path value="ModelICVP.sex"/>
      <short value="Sex"/>
      <definition value="Sex"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.sex"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element id="ModelICVP.nationality">
      <path value="ModelICVP.nationality"/>
      <short value="Nationality"/>
      <definition value="Nationality"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.nationality"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
    </element>
    <element id="ModelICVP.nid">
      <path value="ModelICVP.nid"/>
      <short value="National Identification Document"/>
      <definition value="National Identification Document"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.nid"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVP.guardian">
      <path value="ModelICVP.guardian"/>
      <short value="Parent/Guardian"/>
      <definition value="Name of Parent or Guardian"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.guardian"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVP.issuer">
      <path value="ModelICVP.issuer"/>
      <short value="Document issuer"/>
      <definition value="Document issuer"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.issuer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
    </element>
    <element id="ModelICVP.vaccineDetails">
      <path value="ModelICVP.vaccineDetails"/>
      <short value="Vaccine Details"/>
      <definition value="Vaccine Details"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelDVC.vaccineDetails"/>
        <min value="1"/>
        <max value="*"/>
      </base>
      <type>
        <code
              value="http://smart.who.int/icvp/StructureDefinition/ModelICVPVaccineDetails"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="ModelICVP">
      <path value="ModelICVP"/>
    </element>
    <element id="ModelICVP.vaccineDetails">
      <path value="ModelICVP.vaccineDetails"/>
      <max value="1"/>
    </element>
  </differential>
</StructureDefinition>