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: ModelICVPVaccineDetails - XML Profile

Active as of 2024-10-07

XML representation of the ModelICVPVaccineDetails logical model.

Raw xml | Download


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="ModelICVPVaccineDetails"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablestructuredefinition"/>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablestructuredefinition"/>
  </meta>
  <text>
    <status value="extensions"/>
    <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 &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-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>
<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>
<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>
<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/ModelICVPVaccineDetails"/>
  <version value="0.1.0"/>
  <name value="ModelICVPVaccineDetails"/>
  <title value="ICVP - Vaccine Details"/>
  <status value="active"/>
  <experimental value="true"/>
  <date value="2024-10-07T07:08:56+00:00"/>
  <publisher value="WHO"/>
  <contact>
    <name value="WHO"/>
    <telecom>
      <system value="url"/>
      <value value="http://who.int"/>
    </telecom>
  </contact>
  <description
               value="Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis."/>
  <fhirVersion value="4.0.1"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <type
        value="http://smart.who.int/icvp/StructureDefinition/ModelICVPVaccineDetails"/>
  <baseDefinition
                  value="http://smart.who.int/icvp/StructureDefinition/ModelVaccineDetails"/>
  <derivation value="specialization"/>
  <snapshot>
    <element id="ModelICVPVaccineDetails">
      <path value="ModelICVPVaccineDetails"/>
      <short value="ICVP - Vaccine Details"/>
      <definition
                  value="Vaccine 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>
      <isModifier value="false"/>
    </element>
    <element id="ModelICVPVaccineDetails.doseNumber">
      <path value="ModelICVPVaccineDetails.doseNumber"/>
      <short value="Dose Number"/>
      <definition value="Dose Number"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.doseNumber"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet value="http://smart.who.int/icvp/ValueSet/doseNumber"/>
      </binding>
    </element>
    <element id="ModelICVPVaccineDetails.disease">
      <path value="ModelICVPVaccineDetails.disease"/>
      <short value="Disease"/>
      <definition
                  value="Name of disease or condition vaccinated or received prophylaxis against"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.disease"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Coding"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://smart.who.int/icvp/ValueSet/ICVPDiseaseTargeted"/>
      </binding>
    </element>
    <element id="ModelICVPVaccineDetails.vaccineClassification">
      <path value="ModelICVPVaccineDetails.vaccineClassification"/>
      <short value="Vaccine code"/>
      <definition value="Vaccine or prophylaxis classification code"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.vaccineClassification"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://smart.who.int/icvp/ValueSet/ICVPVaccineCodes"/>
      </binding>
    </element>
    <element id="ModelICVPVaccineDetails.vaccineTradeItem">
      <path value="ModelICVPVaccineDetails.vaccineTradeItem"/>
      <short value="vaccine trade item id"/>
      <definition value="Vaccine trade item id"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.vaccineTradeItem"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.date">
      <path value="ModelICVPVaccineDetails.date"/>
      <short value="Date"/>
      <definition value="Date of vaccine"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.date"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="date"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.clinicianName">
      <path value="ModelICVPVaccineDetails.clinicianName"/>
      <short value="Name of supervising clinician"/>
      <definition
                  value="Name of supervising clinician, or relevant authority responsible for issuing this certificate, or for overseeing the administering centre"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.clinicianName"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.issuer">
      <path value="ModelICVPVaccineDetails.issuer"/>
      <short value="Issuing Organization"/>
      <definition
                  value="Relevant authoring reponsible for issuing the certificate, or for overseeing the administration center"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.issuer"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <targetProfile
                       value="http://hl7.org/fhir/StructureDefinition/Organization"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.manufacturerId">
      <path value="ModelICVPVaccineDetails.manufacturerId"/>
      <short value="Manufacture ID"/>
      <definition value="Manufacturer ID"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.manufacturerId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Identifier"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.manufacturer">
      <path value="ModelICVPVaccineDetails.manufacturer"/>
      <short value="Name of Manufacturer of vaccine"/>
      <definition value="Name Manufacturer of vaccine"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.manufacturer"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.batchNo">
      <path value="ModelICVPVaccineDetails.batchNo"/>
      <short value="Batch No"/>
      <definition value="Batch No"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.batchNo"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
    </element>
    <element id="ModelICVPVaccineDetails.validityPeriod">
      <path value="ModelICVPVaccineDetails.validityPeriod"/>
      <short value="Certificate validity period"/>
      <definition value="Certificate validity period"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="ModelVaccineDetails.validityPeriod"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Period"/>
      </type>
    </element>
  </snapshot>
  <differential>
    <element id="ModelICVPVaccineDetails">
      <path value="ModelICVPVaccineDetails"/>
      <short value="ICVP - Vaccine Details"/>
      <definition
                  value="Vaccine Data elements for the Model International Certificate of Vaccination or Prophylaxis."/>
    </element>
    <element id="ModelICVPVaccineDetails.disease">
      <path value="ModelICVPVaccineDetails.disease"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://smart.who.int/icvp/ValueSet/ICVPDiseaseTargeted"/>
      </binding>
    </element>
    <element id="ModelICVPVaccineDetails.vaccineClassification">
      <path value="ModelICVPVaccineDetails.vaccineClassification"/>
      <binding>
        <strength value="required"/>
        <valueSet
                  value="http://smart.who.int/icvp/ValueSet/ICVPVaccineCodes"/>
      </binding>
    </element>
  </differential>
</StructureDefinition>