IMMZD18SPolioBirthDoseLogic - 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
: IMMZD18SPolioBirthDoseLogic - XML Representation

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

<Library xmlns="http://hl7.org/fhir">
  <id value="IMMZD18SPolioBirthDoseLogic"/>
  <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;">IMMZD18SPolioBirthDoseLogic</td>
        </tr>
        

        
        
        <tr>
            <th scope="row"><b>Id: </b></th>
            <td style="padding-left: 4px;">IMMZD18SPolioBirthDoseLogic</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-IMMZD18SPolioBirthDoseLogic.html">IMMZD18SPolioBirthDoseLogic</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.Polio.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-IMMZD2DTPolioEncounterElements.html">IMMZD2DTPolioEncounterElements</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>Polio birth dose (a zero dose) was administered</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>bOPV birth dose (a zero dose) Expiration</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>bOPV birth dose (a zero dose)</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>bOPV birth dose (a zero dose) Due Date</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>bOPV birth dose (a zero dose) Overdue</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
              
                <tr><th>bOPV birth dose (a zero dose) Create</th><th>string</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: IMMZD18SPolioBirthDoseLogic (IMMZ.D18.S.Polio.Birth dose schedule)
 * Schedule Table: Birth dose schedule (in countries that are poliomyelitis (polio)-endemic countries or countries at high risk for importation and subsequent spread of polio that follow the combined bivalent oral polio vaccine [bOPV]–inactivated polio vaccine [IPV] schedule)
 */
library IMMZD18SPolioBirthDoseLogic

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 IMMZD2DTPolioEncounterElements called Encounter

parameter Today Date default Today()


context Patient


/*
@output: bOPV birth dose (a zero dose)
@description: Provision of bOPV birth dose (a zero dose)
@trigger: Child's birth
@pseudo: 
@triggerDate: &quot;Date of birth&quot;
*/
define &quot;bOPV birth dose (a zero dose)&quot;:
  not &quot;Polio birth dose (a zero dose) was administered&quot;
  and &quot;bOPV birth dose (a zero dose) Expiration&quot; after day of Today


/*
@output: bOPV birth dose (a zero dose) Create
@create: bOPV birth dose (a zero dose) should be provided within the first week of life and if the client is in a polio-endemic country or a country at high risk for importation and subsequent spread of polio
*/
define &quot;bOPV birth dose (a zero dose) Create&quot;:
  if &quot;bOPV birth dose (a zero dose)&quot;
  then 'bOPV birth dose (a zero dose) should be provided within the first week of life and if the client is in a polio-endemic country or a country at high risk for importation and subsequent spread of polio' + '
Due Date: ' + ToString(&quot;bOPV birth dose (a zero dose) Due Date&quot;) + '
Overdue: ' + ToString(&quot;bOPV birth dose (a zero dose) Overdue&quot;) + '
Expiration: ' + ToString(&quot;bOPV birth dose (a zero dose) Expiration&quot;)
  else ''


/*
@dynamicValue: bOPV birth dose (a zero dose) Due Date
@pseudocode: &quot;Date of birth&quot;
*/
define &quot;bOPV birth dose (a zero dose) Due Date&quot;:
  if &quot;bOPV birth dose (a zero dose)&quot; then Patient.birthDate
  else null


/*
@dynamicValue: bOPV birth dose (a zero dose) Overdue
@pseudocode: &quot;Date of birth&quot; + 1 day
*/
define &quot;bOPV birth dose (a zero dose) Overdue&quot;:
  if &quot;bOPV birth dose (a zero dose)&quot; then Patient.birthDate + 1 day
  else null


/*
@dynamicValue: bOPV birth dose (a zero dose) Expiration
@pseudocode: &quot;Date of birth&quot; + 1 week
*/
define &quot;bOPV birth dose (a zero dose) Expiration&quot;:
  Patient.birthDate + 1 week

  
/*
@complete: Polio birth dose (a zero dose) was administered
@pseudocode: Count of vaccines administered (where &quot;Vaccine type&quot; = &quot;Poliovirus-containing vaccines&quot; and &quot;Type of dose&quot; = &quot;Dose 0&quot; AND &quot;Birth dose&quot; = TRUE) = 1
*/
define &quot;Polio birth dose (a zero dose) was administered&quot;:
  Encounter.&quot;bOPV birth dose (a zero dose) was administered&quot;



/*
@test: Test expected results based on example patients
*/
define &quot;Test Validation&quot;:
  case
    when Patient.id = 'Polio08.2' then &quot;bOPV birth dose (a zero dose)&quot;
    when Patient.id = 'Polio09.2' then not &quot;bOPV birth dose (a zero dose)&quot;
    when Patient.id = 'Polio10.1' then not &quot;bOPV birth dose (a zero dose)&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/IMMZD18SPolioBirthDoseLogic"/>
  <version value="1.0.0"/>
  <name value="IMMZD18SPolioBirthDoseLogic"/>
  <title value="IMMZD18SPolioBirthDoseLogic"/>
  <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.Polio.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/IMMZD2DTPolioEncounterElements"/>
  </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="Polio birth dose (a zero dose) was administered"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="bOPV birth dose (a zero dose) Expiration"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="bOPV birth dose (a zero dose)"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="boolean"/>
  </parameter>
  <parameter>
    <name value="bOPV birth dose (a zero dose) Due Date"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="bOPV birth dose (a zero dose) Overdue"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="date"/>
  </parameter>
  <parameter>
    <name value="bOPV birth dose (a zero dose) Create"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <type value="string"/>
  </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="LyoKICogTGlicmFyeTogSU1NWkQxOFNQb2xpb0JpcnRoRG9zZUxvZ2ljIChJTU1aLkQxOC5TLlBvbGlvLkJpcnRoIGRvc2Ugc2NoZWR1bGUpCiAqIFNjaGVkdWxlIFRhYmxlOiBCaXJ0aCBkb3NlIHNjaGVkdWxlIChpbiBjb3VudHJpZXMgdGhhdCBhcmUgcG9saW9teWVsaXRpcyAocG9saW8pLWVuZGVtaWMgY291bnRyaWVzIG9yIGNvdW50cmllcyBhdCBoaWdoIHJpc2sgZm9yIGltcG9ydGF0aW9uIGFuZCBzdWJzZXF1ZW50IHNwcmVhZCBvZiBwb2xpbyB0aGF0IGZvbGxvdyB0aGUgY29tYmluZWQgYml2YWxlbnQgb3JhbCBwb2xpbyB2YWNjaW5lIFtiT1BWXeKAk2luYWN0aXZhdGVkIHBvbGlvIHZhY2NpbmUgW0lQVl0gc2NoZWR1bGUpCiAqLwpsaWJyYXJ5IElNTVpEMThTUG9saW9CaXJ0aERvc2VMb2dpYwoKdXNpbmcgRkhJUiB2ZXJzaW9uICc0LjAuMScKaW5jbHVkZSBGSElSSGVscGVycyB2ZXJzaW9uICc0LjAuMScKCmluY2x1ZGUgV0hPQ29tbW9uIGNhbGxlZCBXQwoKaW5jbHVkZSBJTU1aQ29tbW9uIGNhbGxlZCBDb21tb24KaW5jbHVkZSBJTU1aQ29uY2VwdHMgY2FsbGVkIENvbmNlcHRzCgppbmNsdWRlIElNTVpFbmNvdW50ZXJFbGVtZW50cyBjYWxsZWQgSUUKaW5jbHVkZSBJTU1aRDJEVFBvbGlvRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgoKY29udGV4dCBQYXRpZW50CgoKLyoKQG91dHB1dDogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkKQGRlc2NyaXB0aW9uOiBQcm92aXNpb24gb2YgYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkKQHRyaWdnZXI6IENoaWxkJ3MgYmlydGgKQHBzZXVkbzogCkB0cmlnZ2VyRGF0ZTogIkRhdGUgb2YgYmlydGgiCiovCmRlZmluZSAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkiOgogIG5vdCAiUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQiCiAgYW5kICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBFeHBpcmF0aW9uIiBhZnRlciBkYXkgb2YgVG9kYXkKCgovKgpAb3V0cHV0OiBiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBDcmVhdGUKQGNyZWF0ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgc2hvdWxkIGJlIHByb3ZpZGVkIHdpdGhpbiB0aGUgZmlyc3Qgd2VlayBvZiBsaWZlIGFuZCBpZiB0aGUgY2xpZW50IGlzIGluIGEgcG9saW8tZW5kZW1pYyBjb3VudHJ5IG9yIGEgY291bnRyeSBhdCBoaWdoIHJpc2sgZm9yIGltcG9ydGF0aW9uIGFuZCBzdWJzZXF1ZW50IHNwcmVhZCBvZiBwb2xpbwoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIENyZWF0ZSI6CiAgaWYgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIgogIHRoZW4gJ2JPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHNob3VsZCBiZSBwcm92aWRlZCB3aXRoaW4gdGhlIGZpcnN0IHdlZWsgb2YgbGlmZSBhbmQgaWYgdGhlIGNsaWVudCBpcyBpbiBhIHBvbGlvLWVuZGVtaWMgY291bnRyeSBvciBhIGNvdW50cnkgYXQgaGlnaCByaXNrIGZvciBpbXBvcnRhdGlvbiBhbmQgc3Vic2VxdWVudCBzcHJlYWQgb2YgcG9saW8nICsgJwpEdWUgRGF0ZTogJyArIFRvU3RyaW5nKCJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBEdWUgRGF0ZSIpICsgJwpPdmVyZHVlOiAnICsgVG9TdHJpbmcoImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIE92ZXJkdWUiKSArICcKRXhwaXJhdGlvbjogJyArIFRvU3RyaW5nKCJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBFeHBpcmF0aW9uIikKICBlbHNlICcnCgoKLyoKQGR5bmFtaWNWYWx1ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRHVlIERhdGUKQHBzZXVkb2NvZGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIER1ZSBEYXRlIjoKICBpZiAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkiIHRoZW4gUGF0aWVudC5iaXJ0aERhdGUKICBlbHNlIG51bGwKCgovKgpAZHluYW1pY1ZhbHVlOiBiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBPdmVyZHVlCkBwc2V1ZG9jb2RlOiAiRGF0ZSBvZiBiaXJ0aCIgKyAxIGRheQoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIE92ZXJkdWUiOgogIGlmICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIgdGhlbiBQYXRpZW50LmJpcnRoRGF0ZSArIDEgZGF5CiAgZWxzZSBudWxsCgoKLyoKQGR5bmFtaWNWYWx1ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRXhwaXJhdGlvbgpAcHNldWRvY29kZTogIkRhdGUgb2YgYmlydGgiICsgMSB3ZWVrCiovCmRlZmluZSAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRXhwaXJhdGlvbiI6CiAgUGF0aWVudC5iaXJ0aERhdGUgKyAxIHdlZWsKCiAgCi8qCkBjb21wbGV0ZTogUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQKQHBzZXVkb2NvZGU6IENvdW50IG9mIHZhY2NpbmVzIGFkbWluaXN0ZXJlZCAod2hlcmUgIlZhY2NpbmUgdHlwZSIgPSAiUG9saW92aXJ1cy1jb250YWluaW5nIHZhY2NpbmVzIiBhbmQgIlR5cGUgb2YgZG9zZSIgPSAiRG9zZSAwIiBBTkQgIkJpcnRoIGRvc2UiID0gVFJVRSkgPSAxCiovCmRlZmluZSAiUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQiOgogIEVuY291bnRlci4iYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgd2FzIGFkbWluaXN0ZXJlZCIKCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnUG9saW8wOC4yJyB0aGVuICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdQb2xpbzA5LjInIHRoZW4gbm90ICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdQb2xpbzEwLjEnIHRoZW4gbm90ICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIGVsc2UgJ05vIHRlc3QgY2FzZSBzZXQnCiAgZW5kCg=="/>
  </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