WHO Immunization Implementation Guide
1.0.0 - release
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
| Draft as of 2026-03-31 |
<Library xmlns="http://hl7.org/fhir">
<id value="IMMZD2DTHepatitisBBirthDoseLogic"/>
<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;">IMMZD2DTHepatitisBBirthDoseLogic</td>
</tr>
<tr>
<th scope="row"><b>Id: </b></th>
<td style="padding-left: 4px;">IMMZD2DTHepatitisBBirthDoseLogic</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-IMMZD2DTHepatitisBBirthDoseLogic.html">IMMZD2DTHepatitisBBirthDoseLogic</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.D2.DT.Hepatitis B.Birth dose decision 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-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>Client is due for hepatitis B monovalent vaccine</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Client is due for hepatitis B monovalent vaccine Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Client should follow delayed-start decision logic</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Client should follow delayed-start decision logic Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Client is not due for the hepatitis B birth dose</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Client is not due for the hepatitis B birth dose Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Has Guidance</th><th>boolean</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: IMMZD2DTHepatitisBBirthDoseLogic (IMMZ.D2.DT.Hepatitis B.Birth dose)
* Rule: Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule
* Decision Table: Birth dose administration
* Trigger: IMMZ.D2 Determine required vaccination(s) if any
*/
library IMMZD2DTHepatitisBBirthDoseLogic
using FHIR version '4.0.1'
include FHIRHelpers version '4.0.1'
include IMMZD2DTHepatitisBEncounterElements called Encounter
parameter Today Date default Today()
context Patient
/*
@dynamicValue: Guidance
*/
define "Guidance":
case
when "Client is due for hepatitis B monovalent vaccine" then "Client is due for hepatitis B monovalent vaccine Guidance"
when "Client should follow delayed-start decision logic" then "Client should follow delayed-start decision logic Guidance"
when "Client is not due for the hepatitis B birth dose" then "Client is not due for the hepatitis B birth dose Guidance"
else ''
end
define "Has Guidance":
"Guidance" is not null and "Guidance" != ''
/*
@output: Client is due for hepatitis B monovalent vaccine
@pseudocode: "Immunization recommendation status" = "Due" (where "Type of hepatitis B dose" = "Hepatitis B monovalent vaccine")
*/
define "Client is due for hepatitis B monovalent vaccine":
Encounter."Hepatitis B birth dose was not administered"
and Encounter."Client's age is less than {Member States defined upper limit}"
/*
@output: Client is due for hepatitis B monovalent vaccine Guidance
@guidance: Should vaccinate client with hepatitis B birth dose, as a monovalent dose. Check for contraindications.
*/
define "Client is due for hepatitis B monovalent vaccine Guidance":
'Should vaccinate client with hepatitis B birth dose, as a monovalent dose. Check for contraindications.'
/*
@output: Client should follow delayed-start decision logic
@pseudocode:
*/
define "Client should follow delayed-start decision logic":
Encounter."Hepatitis B birth dose was not administered"
and Encounter."Client's age is more than {Member States defined upper limit}"
/*
@output: Client should follow delayed-start decision logic Guidance
@guidance: The client has a delayed start. Please follow the delayed start schedule.
*/
define "Client should follow delayed-start decision logic Guidance":
'The client has a delayed start. Please follow the delayed start schedule.'
/*
@output: Client is not due for the hepatitis B birth dose
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for the hepatitis B birth dose":
Encounter."Hepatitis B birth dose was administered"
/*
@output: Client is not due for the hepatitis B birth dose Guidance
@guidance: Hepatitis B birth dose was already administered. Check hepatitis B immunization schedule.
*/
define "Client is not due for the hepatitis B birth dose Guidance":
'Hepatitis B birth dose was already administered. Check hepatitis B immunization schedule.'
/*
@test: Test expected results based on example patients
*/
define "Test Validation":
case
when Patient.id = 'HepatitisB08.2' then "Client is due for hepatitis B monovalent vaccine" and "Guidance" = 'Should vaccinate client with hepatitis B birth dose, as a monovalent dose. Check for contraindications.'
when Patient.id = 'HepatitisB09.2' then "Client should follow delayed-start decision logic" and "Guidance" = 'The client has a delayed start. Please follow the delayed start schedule.'
when Patient.id = 'HepatitisB10.1' then "Client is not due for the hepatitis B birth dose" and "Guidance" = 'Hepatitis B birth dose was already administered. Check hepatitis B immunization schedule.'
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/IMMZD2DTHepatitisBBirthDoseLogic"/>
<version value="1.0.0"/>
<name value="IMMZD2DTHepatitisBBirthDoseLogic"/>
<title value="IMMZD2DTHepatitisBBirthDoseLogic"/>
<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.D2.DT.Hepatitis B.Birth dose decision table in the Immunization CPG"/>
<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="Client is due for hepatitis B monovalent vaccine"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="Client is due for hepatitis B monovalent vaccine Guidance"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="Client should follow delayed-start decision logic"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="Client should follow delayed-start decision logic Guidance"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="Client is not due for the hepatitis B birth dose"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="Client is not due for the hepatitis B birth dose Guidance"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="Guidance"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name value="Has Guidance"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</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="LyoKICogTGlicmFyeTogSU1NWkQyRFRIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMgKElNTVouRDIuRFQuSGVwYXRpdGlzIEIuQmlydGggZG9zZSkKICogUnVsZTogRGV0ZXJtaW5lIGlmIHRoZSBjbGllbnQgaXMgZHVlIGZvciBhIGhlcGF0aXRpcyBCIHZhY2NpbmF0aW9uIGFjY29yZGluZyB0byB0aGUgbmF0aW9uYWwgaW1tdW5pemF0aW9uIHNjaGVkdWxlCiAqIERlY2lzaW9uIFRhYmxlOiBCaXJ0aCBkb3NlIGFkbWluaXN0cmF0aW9uCiAqIFRyaWdnZXI6IElNTVouRDIgRGV0ZXJtaW5lIHJlcXVpcmVkIHZhY2NpbmF0aW9uKHMpIGlmIGFueQogKi8KbGlicmFyeSBJTU1aRDJEVEhlcGF0aXRpc0JCaXJ0aERvc2VMb2dpYwoKdXNpbmcgRkhJUiB2ZXJzaW9uICc0LjAuMScKaW5jbHVkZSBGSElSSGVscGVycyB2ZXJzaW9uICc0LjAuMScKCmluY2x1ZGUgSU1NWkQyRFRIZXBhdGl0aXNCRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgpjb250ZXh0IFBhdGllbnQKCgovKgpAZHluYW1pY1ZhbHVlOiBHdWlkYW5jZQoqLwpkZWZpbmUgIkd1aWRhbmNlIjoKICBjYXNlIAogICAgd2hlbiAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIiB0aGVuICJDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUgR3VpZGFuY2UiCiAgICB3aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIiB0aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIEd1aWRhbmNlIgogICAgd2hlbiAiQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiB0aGVuICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgR3VpZGFuY2UiIAogICAgZWxzZSAnJwogIGVuZAogIApkZWZpbmUgIkhhcyBHdWlkYW5jZSI6CiAgIkd1aWRhbmNlIiBpcyBub3QgbnVsbCBhbmQgIkd1aWRhbmNlIiAhPSAnJwoKLyoKQG91dHB1dDogQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lCkBwc2V1ZG9jb2RlOiAiSW1tdW5pemF0aW9uIHJlY29tbWVuZGF0aW9uIHN0YXR1cyIgPSAiRHVlIiAod2hlcmUgIlR5cGUgb2YgaGVwYXRpdGlzIEIgZG9zZSIgPSAiSGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIikKKi8KZGVmaW5lICJDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgbm90IGFkbWluaXN0ZXJlZCIKICAgIGFuZCBFbmNvdW50ZXIuIkNsaWVudCdzIGFnZSBpcyBsZXNzIHRoYW4ge01lbWJlciBTdGF0ZXMgZGVmaW5lZCB1cHBlciBsaW1pdH0iCgovKgpAb3V0cHV0OiBDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUgR3VpZGFuY2UKQGd1aWRhbmNlOiBTaG91bGQgdmFjY2luYXRlIGNsaWVudCB3aXRoIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UsIGFzIGEgbW9ub3ZhbGVudCBkb3NlLiBDaGVjayBmb3IgY29udHJhaW5kaWNhdGlvbnMuCiovCmRlZmluZSAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIEd1aWRhbmNlIjoKICAnU2hvdWxkIHZhY2NpbmF0ZSBjbGllbnQgd2l0aCBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlLCBhcyBhIG1vbm92YWxlbnQgZG9zZS4gQ2hlY2sgZm9yIGNvbnRyYWluZGljYXRpb25zLicKCi8qCkBvdXRwdXQ6IENsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMKQHBzZXVkb2NvZGU6IAoqLwpkZWZpbmUgIkNsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgbm90IGFkbWluaXN0ZXJlZCIKICAgIGFuZCBFbmNvdW50ZXIuIkNsaWVudCdzIGFnZSBpcyBtb3JlIHRoYW4ge01lbWJlciBTdGF0ZXMgZGVmaW5lZCB1cHBlciBsaW1pdH0iCgovKgpAb3V0cHV0OiBDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIEd1aWRhbmNlCkBndWlkYW5jZTogVGhlIGNsaWVudCBoYXMgYSBkZWxheWVkIHN0YXJ0LiBQbGVhc2UgZm9sbG93IHRoZSBkZWxheWVkIHN0YXJ0IHNjaGVkdWxlLgoqLwpkZWZpbmUgIkNsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMgR3VpZGFuY2UiOgogICdUaGUgY2xpZW50IGhhcyBhIGRlbGF5ZWQgc3RhcnQuIFBsZWFzZSBmb2xsb3cgdGhlIGRlbGF5ZWQgc3RhcnQgc2NoZWR1bGUuJwoKLyoKQG91dHB1dDogQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlCkBwc2V1ZG9jb2RlOiAiSW1tdW5pemF0aW9uIHJlY29tbWVuZGF0aW9uIHN0YXR1cyIgPSAiTm90IGR1ZSIKKi8KZGVmaW5lICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIgoKLyoKQG91dHB1dDogQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIEd1aWRhbmNlCkBndWlkYW5jZTogSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWxyZWFkeSBhZG1pbmlzdGVyZWQuIENoZWNrIGhlcGF0aXRpcyBCIGltbXVuaXphdGlvbiBzY2hlZHVsZS4KKi8KZGVmaW5lICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgR3VpZGFuY2UiOgogICdIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIHdhcyBhbHJlYWR5IGFkbWluaXN0ZXJlZC4gQ2hlY2sgaGVwYXRpdGlzIEIgaW1tdW5pemF0aW9uIHNjaGVkdWxlLicKCgovKgpAdGVzdDogVGVzdCBleHBlY3RlZCByZXN1bHRzIGJhc2VkIG9uIGV4YW1wbGUgcGF0aWVudHMKKi8KZGVmaW5lICJUZXN0IFZhbGlkYXRpb24iOgogIGNhc2UKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdIZXBhdGl0aXNCMDguMicgdGhlbiAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIiBhbmQgIkd1aWRhbmNlIiA9ICdTaG91bGQgdmFjY2luYXRlIGNsaWVudCB3aXRoIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UsIGFzIGEgbW9ub3ZhbGVudCBkb3NlLiBDaGVjayBmb3IgY29udHJhaW5kaWNhdGlvbnMuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0IwOS4yJyB0aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIiBhbmQgIkd1aWRhbmNlIiA9ICdUaGUgY2xpZW50IGhhcyBhIGRlbGF5ZWQgc3RhcnQuIFBsZWFzZSBmb2xsb3cgdGhlIGRlbGF5ZWQgc3RhcnQgc2NoZWR1bGUuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0IxMC4xJyB0aGVuICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiIGFuZCAiR3VpZGFuY2UiID0gJ0hlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFscmVhZHkgYWRtaW5pc3RlcmVkLiBDaGVjayBoZXBhdGl0aXMgQiBpbW11bml6YXRpb24gc2NoZWR1bGUuJwogICAgZWxzZSAnTm8gdGVzdCBjYXNlIHNldCcKICBlbmQK"/>
</content>
</Library>