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="IMMZD18SMeaslesSupplementaryDoseLogic"/>
<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;">IMMZD18SMeaslesSupplementaryDoseLogic</td>
</tr>
<tr>
<th scope="row"><b>Id: </b></th>
<td style="padding-left: 4px;">IMMZD18SMeaslesSupplementaryDoseLogic</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-IMMZD18SMeaslesSupplementaryDoseLogic.html">IMMZD18SMeaslesSupplementaryDoseLogic</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.Measles.Supplementary 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-IMMZD2DTMeaslesEncounterElements.html">IMMZD2DTMeaslesEncounterElements</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>MCV supplementary dose was administered</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Measles-containing vaccine (MCV) supplementary dose</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Measles-containing vaccine (MCV) supplementary dose Due Date</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Measles-containing vaccine (MCV) supplementary dose Create</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Measles-containing vaccine (MCV) supplementary dose Overdue</th><th>Resource</th><th>0</th><th>1</th><th>Out</th></tr>
<tr><th>Measles-containing vaccine (MCV) supplementary 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: IMMZD18SMeaslesSupplementaryDoseLogic (IMMZ.D18.S.Measles.Supplementary dose schedule)
* Schedule Table: Measles supplementary dose schedule
*/
library IMMZD18SMeaslesSupplementaryDoseLogic
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 IMMZD2DTMeaslesEncounterElements called Encounter
parameter Today Date default Today()
context Patient
/*
@output: Measles-containing vaccine (MCV) supplementary dose
@description: Provision of a MCV supplementary dose
@trigger: Routine measles immunization schedule is complete
@pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Measles-containing vaccines") AND Member States defined logic for supplementary dose applied
@triggerDate: "Date when the primary vaccination series was completed"
*/
define "Measles-containing vaccine (MCV) supplementary dose":
not "MCV supplementary dose was administered" and Encounter."Measles routine immunization schedule is complete"
/*
@output: Measles-containing vaccine (MCV) supplementary dose Create
@create: Child is due for a MCV supplementary dose if child is HIV-positive, on antiretroviral therapy (ART) and immune reconstitution has been achieved.
*/
define "Measles-containing vaccine (MCV) supplementary dose Create":
if "Measles-containing vaccine (MCV) supplementary dose"
then 'Child is due for a MCV supplementary dose if child is HIV-positive, on antiretroviral therapy (ART) and immune reconstitution has been achieved.' + '
Due Date: ' + ToString("Measles-containing vaccine (MCV) supplementary dose Due Date")
else ''
/*
@dynamicValue: Measles-containing vaccine (MCV) supplementary dose Due Date
@pseudocode: "Date when the primary vaccination series completed" + 4 weeks
*/
define "Measles-containing vaccine (MCV) supplementary dose Due Date":
if "Measles-containing vaccine (MCV) supplementary dose" then Encounter."Date when the primary vaccination series completed" + 4 weeks
else null
/*
@dynamicValue: Measles-containing vaccine (MCV) supplementary dose Overdue
@pseudocode: To be determined by Member States; however, there is no recommended overdue date and individuals are always eligible to be vaccinated.
*/
define "Measles-containing vaccine (MCV) supplementary dose Overdue":
null
/*
@dynamicValue: Measles-containing vaccine (MCV) supplementary dose Expiration
@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.
*/
define "Measles-containing vaccine (MCV) supplementary dose Expiration":
null
/*
@complete: MCV supplementary dose was administered
@pseudocode: Count of vaccines administered (where "Vaccine type" = "Measles-containing vaccines" and "Type of dose" = "Supplementary dose") = 1
*/
define "MCV supplementary dose was administered":
Encounter."Measles supplementary dose was administered"
/*
@test: Test expected results based on example patients
*/
define "Test Validation":
case
when Patient.id = 'Measles48.3' then "Measles-containing vaccine (MCV) supplementary dose"
when Patient.id = 'Measles49.3' then "Measles-containing vaccine (MCV) supplementary dose"
when Patient.id = 'Measles50.1' then "MCV supplementary dose was administered"
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/IMMZD18SMeaslesSupplementaryDoseLogic"/>
<version value="1.0.0"/>
<name value="IMMZD18SMeaslesSupplementaryDoseLogic"/>
<title value="IMMZD18SMeaslesSupplementaryDoseLogic"/>
<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.Measles.Supplementary 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/IMMZD2DTMeaslesEncounterElements"/>
</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="MCV supplementary dose was administered"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="Measles-containing vaccine (MCV) supplementary dose"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="boolean"/>
</parameter>
<parameter>
<name
value="Measles-containing vaccine (MCV) supplementary dose Due Date"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="date"/>
</parameter>
<parameter>
<name value="Measles-containing vaccine (MCV) supplementary dose Create"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="string"/>
</parameter>
<parameter>
<name
value="Measles-containing vaccine (MCV) supplementary dose Overdue"/>
<use value="out"/>
<min value="0"/>
<max value="1"/>
<type value="Resource"/>
</parameter>
<parameter>
<name
value="Measles-containing vaccine (MCV) supplementary 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="LyoKICogTGlicmFyeTogSU1NWkQxOFNNZWFzbGVzU3VwcGxlbWVudGFyeURvc2VMb2dpYyAoSU1NWi5EMTguUy5NZWFzbGVzLlN1cHBsZW1lbnRhcnkgZG9zZSBzY2hlZHVsZSkKICogU2NoZWR1bGUgVGFibGU6IE1lYXNsZXMgc3VwcGxlbWVudGFyeSBkb3NlIHNjaGVkdWxlCiAqLwpsaWJyYXJ5IElNTVpEMThTTWVhc2xlc1N1cHBsZW1lbnRhcnlEb3NlTG9naWMKCnVzaW5nIEZISVIgdmVyc2lvbiAnNC4wLjEnCmluY2x1ZGUgRkhJUkhlbHBlcnMgdmVyc2lvbiAnNC4wLjEnCgppbmNsdWRlIFdIT0NvbW1vbiBjYWxsZWQgV0MKCmluY2x1ZGUgSU1NWkNvbW1vbiBjYWxsZWQgQ29tbW9uCmluY2x1ZGUgSU1NWkNvbmNlcHRzIGNhbGxlZCBDb25jZXB0cwoKaW5jbHVkZSBJTU1aRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIElFCmluY2x1ZGUgSU1NWkQyRFRNZWFzbGVzRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgoKY29udGV4dCBQYXRpZW50CgoKLyoKQG91dHB1dDogTWVhc2xlcy1jb250YWluaW5nIHZhY2NpbmUgKE1DVikgc3VwcGxlbWVudGFyeSBkb3NlCkBkZXNjcmlwdGlvbjogUHJvdmlzaW9uIG9mIGEgTUNWIHN1cHBsZW1lbnRhcnkgZG9zZQpAdHJpZ2dlcjogUm91dGluZSBtZWFzbGVzIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZQpAcHNldWRvOiAiQ29tcGxldGVkIHRoZSBwcmltYXJ5IHZhY2NpbmF0aW9uIHNlcmllcyIgPSBUUlVFICh3aGVyZSAiVmFjY2luZSB0eXBlIiA9ICJNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZXMiKSBBTkQgTWVtYmVyIFN0YXRlcyBkZWZpbmVkIGxvZ2ljIGZvciBzdXBwbGVtZW50YXJ5IGRvc2UgYXBwbGllZApAdHJpZ2dlckRhdGU6ICJEYXRlIHdoZW4gdGhlIHByaW1hcnkgdmFjY2luYXRpb24gc2VyaWVzIHdhcyBjb21wbGV0ZWQiCiovCmRlZmluZSAiTWVhc2xlcy1jb250YWluaW5nIHZhY2NpbmUgKE1DVikgc3VwcGxlbWVudGFyeSBkb3NlIjoKICBub3QgIk1DViBzdXBwbGVtZW50YXJ5IGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIgYW5kIEVuY291bnRlci4iTWVhc2xlcyByb3V0aW5lIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZSIKCgovKgpAb3V0cHV0OiBNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZSAoTUNWKSBzdXBwbGVtZW50YXJ5IGRvc2UgQ3JlYXRlCkBjcmVhdGU6IENoaWxkIGlzIGR1ZSBmb3IgYSBNQ1Ygc3VwcGxlbWVudGFyeSBkb3NlIGlmIGNoaWxkIGlzIEhJVi1wb3NpdGl2ZSwgb24gYW50aXJldHJvdmlyYWwgdGhlcmFweSAoQVJUKSBhbmQgaW1tdW5lIHJlY29uc3RpdHV0aW9uIGhhcyBiZWVuIGFjaGlldmVkLgoqLwpkZWZpbmUgIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSBDcmVhdGUiOgogIGlmICJNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZSAoTUNWKSBzdXBwbGVtZW50YXJ5IGRvc2UiCiAgdGhlbiAnQ2hpbGQgaXMgZHVlIGZvciBhIE1DViBzdXBwbGVtZW50YXJ5IGRvc2UgaWYgY2hpbGQgaXMgSElWLXBvc2l0aXZlLCBvbiBhbnRpcmV0cm92aXJhbCB0aGVyYXB5IChBUlQpIGFuZCBpbW11bmUgcmVjb25zdGl0dXRpb24gaGFzIGJlZW4gYWNoaWV2ZWQuJyArICcKRHVlIERhdGU6ICcgKyBUb1N0cmluZygiTWVhc2xlcy1jb250YWluaW5nIHZhY2NpbmUgKE1DVikgc3VwcGxlbWVudGFyeSBkb3NlIER1ZSBEYXRlIikKICBlbHNlICcnCgoKLyoKQGR5bmFtaWNWYWx1ZTogTWVhc2xlcy1jb250YWluaW5nIHZhY2NpbmUgKE1DVikgc3VwcGxlbWVudGFyeSBkb3NlIER1ZSBEYXRlCkBwc2V1ZG9jb2RlOiAiRGF0ZSB3aGVuIHRoZSBwcmltYXJ5IHZhY2NpbmF0aW9uIHNlcmllcyBjb21wbGV0ZWQiICsgNCB3ZWVrcwoqLwpkZWZpbmUgIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSBEdWUgRGF0ZSI6CiAgaWYgIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSIgdGhlbiBFbmNvdW50ZXIuIkRhdGUgd2hlbiB0aGUgcHJpbWFyeSB2YWNjaW5hdGlvbiBzZXJpZXMgY29tcGxldGVkIiArIDQgd2Vla3MKICBlbHNlIG51bGwKCgovKgpAZHluYW1pY1ZhbHVlOiBNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZSAoTUNWKSBzdXBwbGVtZW50YXJ5IGRvc2UgT3ZlcmR1ZQpAcHNldWRvY29kZTogVG8gYmUgZGV0ZXJtaW5lZCBieSBNZW1iZXIgU3RhdGVzOyBob3dldmVyLCB0aGVyZSBpcyBubyByZWNvbW1lbmRlZCBvdmVyZHVlIGRhdGUgYW5kIGluZGl2aWR1YWxzIGFyZSBhbHdheXMgZWxpZ2libGUgdG8gYmUgdmFjY2luYXRlZC4KKi8KZGVmaW5lICJNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZSAoTUNWKSBzdXBwbGVtZW50YXJ5IGRvc2UgT3ZlcmR1ZSI6CiAgbnVsbAoKCi8qCkBkeW5hbWljVmFsdWU6IE1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSBFeHBpcmF0aW9uCkBwc2V1ZG9jb2RlOiBUbyBiZSBkZXRlcm1pbmVkIGJ5IE1lbWJlciBTdGF0ZXM7IGhvd2V2ZXIsIHRoZXJlIGlzIG5vIHJlY29tbWVuZGVkIGV4cGlyYXRpb24gZGF0ZSBhbmQgaW5kaXZpZHVhbHMgYXJlIGFsd2F5cyBlbGlnaWJsZSB0byBiZSB2YWNjaW5hdGVkLgoqLwpkZWZpbmUgIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSBFeHBpcmF0aW9uIjoKICBudWxsCgogIAovKgpAY29tcGxldGU6IE1DViBzdXBwbGVtZW50YXJ5IGRvc2Ugd2FzIGFkbWluaXN0ZXJlZApAcHNldWRvY29kZTogQ291bnQgb2YgdmFjY2luZXMgYWRtaW5pc3RlcmVkICh3aGVyZSAiVmFjY2luZSB0eXBlIiA9ICJNZWFzbGVzLWNvbnRhaW5pbmcgdmFjY2luZXMiIGFuZCAiVHlwZSBvZiBkb3NlIiA9ICJTdXBwbGVtZW50YXJ5IGRvc2UiKSA9IDEKKi8KZGVmaW5lICJNQ1Ygc3VwcGxlbWVudGFyeSBkb3NlIHdhcyBhZG1pbmlzdGVyZWQiOgogIEVuY291bnRlci4iTWVhc2xlcyBzdXBwbGVtZW50YXJ5IGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnTWVhc2xlczQ4LjMnIHRoZW4gIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSIgCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnTWVhc2xlczQ5LjMnIHRoZW4gIk1lYXNsZXMtY29udGFpbmluZyB2YWNjaW5lIChNQ1YpIHN1cHBsZW1lbnRhcnkgZG9zZSIgCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnTWVhc2xlczUwLjEnIHRoZW4gIk1DViBzdXBwbGVtZW50YXJ5IGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIgCiAgICBlbHNlICdObyB0ZXN0IGNhc2Ugc2V0JwogIGVuZAo="/>
</content>
</Library>