IMMZD18SHepatitisBBirthDoseLogic - XML Representation - WHO Immunization Implementation Guide v1.0.0

WHO Immunization Implementation Guide
1.0.0 - release
WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.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/tree/132/merge and changes regularly. See the Directory of published versions
: IMMZD18SHepatitisBBirthDoseLogic - XML Representation

Draft as of 2026-03-31
Raw xml | Download

<Library xmlns="http://hl7.org/fhir">
  <id value="IMMZD18SHepatitisBBirthDoseLogic"/>
  <meta>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary"/>
    <profile
             value="http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary"/>
    <profile
             value="http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library"/>
    <profile
             value="http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module"/>
  </meta>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
<div>
    <table class="grid dict">
        
        
        <tr>
            <th scope="row"><b>Title: </b></th>
            <td style="padding-left: 4px;">IMMZD18SHepatitisBBirthDoseLogic</td>
        </tr>
        

        
        
        <tr>
            <th scope="row"><b>Id: </b></th>
            <td style="padding-left: 4px;">IMMZD18SHepatitisBBirthDoseLogic</td>
        </tr>
        

        
        
        <tr>
            <th scope="row"><b>Version: </b></th>
            <td style="padding-left: 4px;">1.0.0</td>
        </tr>
        

        
        <tr>
            <th scope="row"><b>Url: </b></th>
            <td style="padding-left: 4px;"><a href="Library-IMMZD18SHepatitisBBirthDoseLogic.html">IMMZD18SHepatitisBBirthDoseLogic</a></td>
        </tr>
        

        

        

        
        <tr>
            <th scope="row"><b>Status: </b></th>
            <td style="padding-left: 4px;">draft</td>
        </tr>
        

        

        
        <tr>
            <th scope="row"><b>Type: </b></th>
            <td style="padding-left: 4px;">
                
                    
                        
                        <p style="margin-bottom: 5px;">
                            <b>system: </b> <span><a href="http://terminology.hl7.org/7.1.0/CodeSystem-library-type.html">http://terminology.hl7.org/CodeSystem/library-type</a></span>
                        </p>
                        
                        
                        <p style="margin-bottom: 5px;">
                            <b>code: </b> <span>logic-library</span>
                        </p>
                        
                        
                    
                
                
            </td>
        </tr>
        

        

        
        <tr>
            <th scope="row"><b>Date: </b></th>
            <td style="padding-left: 4px;">2026-03-31 13:54:17+0000</td>
        </tr>
        

        
        <tr>
            <th scope="row"><b>Publisher: </b></th>
            <td style="padding-left: 4px;">WHO</td>
        </tr>
        

        
        <tr>
            <th scope="row"><b>Description: </b></th>
            <td style="padding-left: 4px;"><div><p>This library defines decision support logic for the IMMZ.D18.S.Hepatitis B.Birth dose schedule table in the Immunization CPG</p>
</div></td>
        </tr>
        

        

        

        

        

        

        

        

        

        

        

        
        <tr>
            <th scope="row"><b>Related Artifacts: </b></th>
            <td style="padding-left: 4px;">
                
                
                
                <p><b>Dependencies</b></p>
                <ul>
                  
                    <li><a href="Library-WHOCommon.html">WHOCommon</a></li>
                  
                    <li><a href="Library-IMMZCommon.html">IMMZCommon</a></li>
                  
                    <li><a href="Library-IMMZConcepts.html">IMMZConcepts</a></li>
                  
                    <li><a href="Library-IMMZEncounterElements.html">IMMZEncounterElements</a></li>
                  
                    <li><a href="Library-IMMZD2DTHepatitisBEncounterElements.html">IMMZD2DTHepatitisBEncounterElements</a></li>
                  
                </ul>
                
                
                
                
                
            </td>
        </tr>
        

        
        <tr>
          <th scope="row"><b>Parameters: </b></th>
          <td style="padding-left: 4px;">
            <table class="grid-dict">
              <tr><th><b>Name</b></th><th><b>Type</b></th><th><b>Min</b></th><th><b>Max</b></th><th><b>In/Out</b></th></tr>
              
                <tr><th>Today</th><th>date</th><th>0</th><th>1</th><th>In</th></tr>
              
                <tr><th>Patient</th><th>Patient</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose was administered</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose Due Date</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose Overdue</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose Create</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Hepatitis B birth dose Expiration</th><th>Resource</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>Test Validation</th><th>Resource</th><th>0</th><th>1</th><th>Out</th></tr>
              
            </table>
          </td>
        </tr>
        

        

        
        
        <tr>
          <td colspan="2">
            <table>
              <tr><th><a id="cql-content"><b>Content: </b></a> text/cql</th></tr>
              <tr><td><pre><code class="language-cql">/*
 * Library: IMMZD18SHepatitisBBirthDoseLogic (IMMZ.D18.S.Hepatitis B.Birth dose schedule)
 * Schedule Table: Birth dose schedule
 */
library IMMZD18SHepatitisBBirthDoseLogic

using FHIR version '4.0.1'
include FHIRHelpers version '4.0.1'

include WHOCommon called WC

include IMMZCommon called Common
include IMMZConcepts called Concepts

include IMMZEncounterElements called IE
include IMMZD2DTHepatitisBEncounterElements called Encounter

parameter Today Date default Today()


context Patient


/*
@output: Hepatitis B birth dose
@description: Provision of hepatitis B birth dose
@trigger: Child's birth
@pseudo: 
@triggerDate: &quot;Date of birth&quot;
*/
define &quot;Hepatitis B birth dose&quot;:
  not &quot;Hepatitis B birth dose was administered&quot;


/*
@output: Hepatitis B birth dose Create
@create: All infants should receive a first dose of the hepatitis B-containing vaccine as soon as possible after birth, ideally within 24 hours
*/
define &quot;Hepatitis B birth dose Create&quot;:
  if &quot;Hepatitis B birth dose&quot;
  then 'All infants should receive a first dose of the hepatitis B-containing vaccine as soon as possible after birth, ideally within 24 hours' + '
Due Date: ' + ToString(&quot;Hepatitis B birth dose Due Date&quot;) + '
Overdue: ' + ToString(&quot;Hepatitis B birth dose Overdue&quot;)
  else ''


/*
@dynamicValue: Hepatitis B birth dose Due Date
@pseudocode: &quot;Date of birth&quot;
*/
define &quot;Hepatitis B birth dose Due Date&quot;:
  if &quot;Hepatitis B birth dose&quot; then Patient.birthDate
  else null


/*
@dynamicValue: Hepatitis B birth dose Overdue
@pseudocode: &quot;Date of birth&quot; + 24 hours
*/
define &quot;Hepatitis B birth dose Overdue&quot;:
  if &quot;Hepatitis B birth dose&quot; then Patient.birthDate + 24 hours
  else null


/*
@dynamicValue: Hepatitis B birth dose Expiration
@pseudocode: To be determined by Member States
*/
define &quot;Hepatitis B birth dose Expiration&quot;:
  null

  
/*
@complete: Hepatitis B birth dose was administered
@pseudocode: Count of vaccines administered (where &quot;Vaccine type&quot; = &quot;Hepatitis B-containing vaccines&quot; and &quot;Birth Dose&quot; = TRUE) = 1
*/
define &quot;Hepatitis B birth dose was administered&quot;:
  Encounter.&quot;Hepatitis B birth dose was administered&quot;



/*
@test: Test expected results based on example patients
*/
define &quot;Test Validation&quot;:
  case
    when Patient.id = 'HepatitisB08.2' then &quot;Hepatitis B birth dose&quot;
    when Patient.id = 'HepatitisB09.2' then &quot;Hepatitis B birth dose&quot;
    when Patient.id = 'HepatitisB10.1' then not &quot;Hepatitis B birth dose&quot; and &quot;Hepatitis B birth dose was administered&quot;
    else 'No test case set'
  end
</code></pre></td></tr>
            </table>
          </td>
        </tr>
        
        
        
    </table>
</div>
</div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability">
    <valueCode value="computable"/>
  </extension>
  <url
       value="http://smart.who.int/immunizations/Library/IMMZD18SHepatitisBBirthDoseLogic"/>
  <version value="1.0.0"/>
  <name value="IMMZD18SHepatitisBBirthDoseLogic"/>
  <title value="IMMZD18SHepatitisBBirthDoseLogic"/>
  <status value="draft"/>
  <experimental value="false"/>
  <type>
    <coding>
      <system value="http://terminology.hl7.org/CodeSystem/library-type"/>
      <code value="logic-library"/>
    </coding>
  </type>
  <date value="2026-03-31T13:54:17+00:00"/>
  <publisher value="WHO"/>
  <contact>
    <name value="WHO"/>
    <telecom>
      <system value="url"/>
      <value value="http://who.int"/>
    </telecom>
  </contact>
  <description
               value="This library defines decision support logic for the IMMZ.D18.S.Hepatitis B.Birth dose schedule table in the Immunization CPG"/>
  <relatedArtifact>
    <type value="depends-on"/>
    <display value="Library WC"/>
    <resource value="http://smart.who.int/immunizations/Library/WHOCommon"/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="depends-on"/>
    <display value="Library Common"/>
    <resource value="http://smart.who.int/immunizations/Library/IMMZCommon"/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="depends-on"/>
    <display value="Library Concepts"/>
    <resource
              value="http://smart.who.int/immunizations/Library/IMMZConcepts"/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="depends-on"/>
    <display value="Library IE"/>
    <resource
              value="http://smart.who.int/immunizations/Library/IMMZEncounterElements"/>
  </relatedArtifact>
  <relatedArtifact>
    <type value="depends-on"/>
    <display value="Library Encounter"/>
    <resource
              value="http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisBEncounterElements"/>
  </relatedArtifact>
  <parameter>
    <name value="Today"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="Patient"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose was administered"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose Due Date"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose Overdue"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose Create"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="Hepatitis B birth dose Expiration"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="Test Validation"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="Resource"/>
  </parameter>
  <content>
    <contentType value="text/cql"/>
    <data
          value="LyoKICogTGlicmFyeTogSU1NWkQxOFNIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMgKElNTVouRDE4LlMuSGVwYXRpdGlzIEIuQmlydGggZG9zZSBzY2hlZHVsZSkKICogU2NoZWR1bGUgVGFibGU6IEJpcnRoIGRvc2Ugc2NoZWR1bGUKICovCmxpYnJhcnkgSU1NWkQxOFNIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMKCnVzaW5nIEZISVIgdmVyc2lvbiAnNC4wLjEnCmluY2x1ZGUgRkhJUkhlbHBlcnMgdmVyc2lvbiAnNC4wLjEnCgppbmNsdWRlIFdIT0NvbW1vbiBjYWxsZWQgV0MKCmluY2x1ZGUgSU1NWkNvbW1vbiBjYWxsZWQgQ29tbW9uCmluY2x1ZGUgSU1NWkNvbmNlcHRzIGNhbGxlZCBDb25jZXB0cwoKaW5jbHVkZSBJTU1aRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIElFCmluY2x1ZGUgSU1NWkQyRFRIZXBhdGl0aXNCRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgoKY29udGV4dCBQYXRpZW50CgoKLyoKQG91dHB1dDogSGVwYXRpdGlzIEIgYmlydGggZG9zZQpAZGVzY3JpcHRpb246IFByb3Zpc2lvbiBvZiBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlCkB0cmlnZ2VyOiBDaGlsZCdzIGJpcnRoCkBwc2V1ZG86IApAdHJpZ2dlckRhdGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiOgogIG5vdCAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIgoKCi8qCkBvdXRwdXQ6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgQ3JlYXRlCkBjcmVhdGU6IEFsbCBpbmZhbnRzIHNob3VsZCByZWNlaXZlIGEgZmlyc3QgZG9zZSBvZiB0aGUgaGVwYXRpdGlzIEItY29udGFpbmluZyB2YWNjaW5lIGFzIHNvb24gYXMgcG9zc2libGUgYWZ0ZXIgYmlydGgsIGlkZWFsbHkgd2l0aGluIDI0IGhvdXJzCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBDcmVhdGUiOgogIGlmICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIgogIHRoZW4gJ0FsbCBpbmZhbnRzIHNob3VsZCByZWNlaXZlIGEgZmlyc3QgZG9zZSBvZiB0aGUgaGVwYXRpdGlzIEItY29udGFpbmluZyB2YWNjaW5lIGFzIHNvb24gYXMgcG9zc2libGUgYWZ0ZXIgYmlydGgsIGlkZWFsbHkgd2l0aGluIDI0IGhvdXJzJyArICcKRHVlIERhdGU6ICcgKyBUb1N0cmluZygiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBEdWUgRGF0ZSIpICsgJwpPdmVyZHVlOiAnICsgVG9TdHJpbmcoIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgT3ZlcmR1ZSIpCiAgZWxzZSAnJwoKCi8qCkBkeW5hbWljVmFsdWU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRHVlIERhdGUKQHBzZXVkb2NvZGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRHVlIERhdGUiOgogIGlmICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiB0aGVuIFBhdGllbnQuYmlydGhEYXRlCiAgZWxzZSBudWxsCgoKLyoKQGR5bmFtaWNWYWx1ZTogSGVwYXRpdGlzIEIgYmlydGggZG9zZSBPdmVyZHVlCkBwc2V1ZG9jb2RlOiAiRGF0ZSBvZiBiaXJ0aCIgKyAyNCBob3VycwoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgT3ZlcmR1ZSI6CiAgaWYgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiIHRoZW4gUGF0aWVudC5iaXJ0aERhdGUgKyAyNCBob3VycwogIGVsc2UgbnVsbAoKCi8qCkBkeW5hbWljVmFsdWU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRXhwaXJhdGlvbgpAcHNldWRvY29kZTogVG8gYmUgZGV0ZXJtaW5lZCBieSBNZW1iZXIgU3RhdGVzCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBFeHBpcmF0aW9uIjoKICBudWxsCgogIAovKgpAY29tcGxldGU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZApAcHNldWRvY29kZTogQ291bnQgb2YgdmFjY2luZXMgYWRtaW5pc3RlcmVkICh3aGVyZSAiVmFjY2luZSB0eXBlIiA9ICJIZXBhdGl0aXMgQi1jb250YWluaW5nIHZhY2NpbmVzIiBhbmQgIkJpcnRoIERvc2UiID0gVFJVRSkgPSAxCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIjoKICBFbmNvdW50ZXIuIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjA4LjInIHRoZW4gIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjA5LjInIHRoZW4gIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjEwLjEnIHRoZW4gbm90ICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiBhbmQgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKICAgIGVsc2UgJ05vIHRlc3QgY2FzZSBzZXQnCiAgZW5kCg=="/>
  </content>
</Library>
IG © 2023+ WHO. Package smart.who.int.immunizations#1.0.0 based on FHIR 4.0.1. Generated 2026-03-31
Links: Table of Contents | QA Report | Version History | License