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 |
{
"resourceType" : "Library",
"id" : "IMMZD18SPolioBirthDoseLogic",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary"🔗 ,
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary"🔗 ,
"http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library"🔗 ,
"http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n<div>\n <table class=\"grid dict\">\n \n \n <tr>\n <th scope=\"row\"><b>Title: </b></th>\n <td style=\"padding-left: 4px;\">IMMZD18SPolioBirthDoseLogic</td>\n </tr>\n \n\n \n \n <tr>\n <th scope=\"row\"><b>Id: </b></th>\n <td style=\"padding-left: 4px;\">IMMZD18SPolioBirthDoseLogic</td>\n </tr>\n \n\n \n \n <tr>\n <th scope=\"row\"><b>Version: </b></th>\n <td style=\"padding-left: 4px;\">1.0.0</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Url: </b></th>\n <td style=\"padding-left: 4px;\"><a href=\"Library-IMMZD18SPolioBirthDoseLogic.html\">IMMZD18SPolioBirthDoseLogic</a></td>\n </tr>\n \n\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Status: </b></th>\n <td style=\"padding-left: 4px;\">draft</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Type: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p style=\"margin-bottom: 5px;\">\n <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>\n </p>\n \n \n <p style=\"margin-bottom: 5px;\">\n <b>code: </b> <span>logic-library</span>\n </p>\n \n \n \n \n \n </td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Date: </b></th>\n <td style=\"padding-left: 4px;\">2026-03-31 13:54:17+0000</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Publisher: </b></th>\n <td style=\"padding-left: 4px;\">WHO</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Description: </b></th>\n <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>\n</div></td>\n </tr>\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Related Artifacts: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p><b>Dependencies</b></p>\n <ul>\n \n <li><a href=\"Library-WHOCommon.html\">WHOCommon</a></li>\n \n <li><a href=\"Library-IMMZCommon.html\">IMMZCommon</a></li>\n \n <li><a href=\"Library-IMMZConcepts.html\">IMMZConcepts</a></li>\n \n <li><a href=\"Library-IMMZEncounterElements.html\">IMMZEncounterElements</a></li>\n \n <li><a href=\"Library-IMMZD2DTPolioEncounterElements.html\">IMMZD2DTPolioEncounterElements</a></li>\n \n </ul>\n \n \n \n \n \n </td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Parameters: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n <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>\n \n <tr><th>Today</th><th>date</th><th>0</th><th>1</th><th>In</th></tr>\n \n <tr><th>Patient</th><th>Patient</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Polio birth dose (a zero dose) was administered</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>bOPV birth dose (a zero dose) Expiration</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>bOPV birth dose (a zero dose)</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>bOPV birth dose (a zero dose) Due Date</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>bOPV birth dose (a zero dose) Overdue</th><th>date</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>bOPV birth dose (a zero dose) Create</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Test Validation</th><th>Resource</th><th>0</th><th>1</th><th>Out</th></tr>\n \n </table>\n </td>\n </tr>\n \n\n \n\n \n \n <tr>\n <td colspan=\"2\">\n <table>\n <tr><th><a id=\"cql-content\"><b>Content: </b></a> text/cql</th></tr>\n <tr><td><pre><code class=\"language-cql\">/*\n * Library: IMMZD18SPolioBirthDoseLogic (IMMZ.D18.S.Polio.Birth dose schedule)\n * 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)\n */\nlibrary IMMZD18SPolioBirthDoseLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude WHOCommon called WC\n\ninclude IMMZCommon called Common\ninclude IMMZConcepts called Concepts\n\ninclude IMMZEncounterElements called IE\ninclude IMMZD2DTPolioEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: bOPV birth dose (a zero dose)\n@description: Provision of bOPV birth dose (a zero dose)\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "bOPV birth dose (a zero dose)":\n not "Polio birth dose (a zero dose) was administered"\n and "bOPV birth dose (a zero dose) Expiration" after day of Today\n\n\n/*\n@output: bOPV birth dose (a zero dose) Create\n@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\n*/\ndefine "bOPV birth dose (a zero dose) Create":\n if "bOPV birth dose (a zero dose)"\n 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' + '\nDue Date: ' + ToString("bOPV birth dose (a zero dose) Due Date") + '\nOverdue: ' + ToString("bOPV birth dose (a zero dose) Overdue") + '\nExpiration: ' + ToString("bOPV birth dose (a zero dose) Expiration")\n else ''\n\n\n/*\n@dynamicValue: bOPV birth dose (a zero dose) Due Date\n@pseudocode: "Date of birth"\n*/\ndefine "bOPV birth dose (a zero dose) Due Date":\n if "bOPV birth dose (a zero dose)" then Patient.birthDate\n else null\n\n\n/*\n@dynamicValue: bOPV birth dose (a zero dose) Overdue\n@pseudocode: "Date of birth" + 1 day\n*/\ndefine "bOPV birth dose (a zero dose) Overdue":\n if "bOPV birth dose (a zero dose)" then Patient.birthDate + 1 day\n else null\n\n\n/*\n@dynamicValue: bOPV birth dose (a zero dose) Expiration\n@pseudocode: "Date of birth" + 1 week\n*/\ndefine "bOPV birth dose (a zero dose) Expiration":\n Patient.birthDate + 1 week\n\n \n/*\n@complete: Polio birth dose (a zero dose) was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines" and "Type of dose" = "Dose 0" AND "Birth dose" = TRUE) = 1\n*/\ndefine "Polio birth dose (a zero dose) was administered":\n Encounter."bOPV birth dose (a zero dose) was administered"\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n case\n when Patient.id = 'Polio08.2' then "bOPV birth dose (a zero dose)"\n when Patient.id = 'Polio09.2' then not "bOPV birth dose (a zero dose)"\n when Patient.id = 'Polio10.1' then not "bOPV birth dose (a zero dose)"\n else 'No test case set'\n end\n</code></pre></td></tr>\n </table>\n </td>\n </tr>\n \n \n \n </table>\n</div>\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability",
"valueCode" : "computable"
}
],
"url" : "http://smart.who.int/immunizations/Library/IMMZD18SPolioBirthDoseLogic",
"version" : "1.0.0",
"name" : "IMMZD18SPolioBirthDoseLogic",
"title" : "IMMZD18SPolioBirthDoseLogic",
"status" : "draft",
"experimental" : false,
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/library-type",
"code" : "logic-library"
}
]
},
"date" : "2026-03-31T13:54:17+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "This library defines decision support logic for the IMMZ.D18.S.Polio.Birth dose schedule table in the Immunization CPG",
"relatedArtifact" : [
{
"type" : "depends-on",
"display" : "Library WC",
"resource" : "http://smart.who.int/immunizations/Library/WHOCommon"
},
{
"type" : "depends-on",
"display" : "Library Common",
"resource" : "http://smart.who.int/immunizations/Library/IMMZCommon"
},
{
"type" : "depends-on",
"display" : "Library Concepts",
"resource" : "http://smart.who.int/immunizations/Library/IMMZConcepts"
},
{
"type" : "depends-on",
"display" : "Library IE",
"resource" : "http://smart.who.int/immunizations/Library/IMMZEncounterElements"
},
{
"type" : "depends-on",
"display" : "Library Encounter",
"resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTPolioEncounterElements"
}
],
"parameter" : [
{
"name" : "Today",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "Patient",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "Patient"
},
{
"name" : "Polio birth dose (a zero dose) was administered",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "bOPV birth dose (a zero dose) Expiration",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "bOPV birth dose (a zero dose)",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "bOPV birth dose (a zero dose) Due Date",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "bOPV birth dose (a zero dose) Overdue",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "bOPV birth dose (a zero dose) Create",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Test Validation",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "Resource"
}
],
"content" : [
{
"contentType" : "text/cql",
"data" : "LyoKICogTGlicmFyeTogSU1NWkQxOFNQb2xpb0JpcnRoRG9zZUxvZ2ljIChJTU1aLkQxOC5TLlBvbGlvLkJpcnRoIGRvc2Ugc2NoZWR1bGUpCiAqIFNjaGVkdWxlIFRhYmxlOiBCaXJ0aCBkb3NlIHNjaGVkdWxlIChpbiBjb3VudHJpZXMgdGhhdCBhcmUgcG9saW9teWVsaXRpcyAocG9saW8pLWVuZGVtaWMgY291bnRyaWVzIG9yIGNvdW50cmllcyBhdCBoaWdoIHJpc2sgZm9yIGltcG9ydGF0aW9uIGFuZCBzdWJzZXF1ZW50IHNwcmVhZCBvZiBwb2xpbyB0aGF0IGZvbGxvdyB0aGUgY29tYmluZWQgYml2YWxlbnQgb3JhbCBwb2xpbyB2YWNjaW5lIFtiT1BWXeKAk2luYWN0aXZhdGVkIHBvbGlvIHZhY2NpbmUgW0lQVl0gc2NoZWR1bGUpCiAqLwpsaWJyYXJ5IElNTVpEMThTUG9saW9CaXJ0aERvc2VMb2dpYwoKdXNpbmcgRkhJUiB2ZXJzaW9uICc0LjAuMScKaW5jbHVkZSBGSElSSGVscGVycyB2ZXJzaW9uICc0LjAuMScKCmluY2x1ZGUgV0hPQ29tbW9uIGNhbGxlZCBXQwoKaW5jbHVkZSBJTU1aQ29tbW9uIGNhbGxlZCBDb21tb24KaW5jbHVkZSBJTU1aQ29uY2VwdHMgY2FsbGVkIENvbmNlcHRzCgppbmNsdWRlIElNTVpFbmNvdW50ZXJFbGVtZW50cyBjYWxsZWQgSUUKaW5jbHVkZSBJTU1aRDJEVFBvbGlvRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgoKY29udGV4dCBQYXRpZW50CgoKLyoKQG91dHB1dDogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkKQGRlc2NyaXB0aW9uOiBQcm92aXNpb24gb2YgYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkKQHRyaWdnZXI6IENoaWxkJ3MgYmlydGgKQHBzZXVkbzogCkB0cmlnZ2VyRGF0ZTogIkRhdGUgb2YgYmlydGgiCiovCmRlZmluZSAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkiOgogIG5vdCAiUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQiCiAgYW5kICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBFeHBpcmF0aW9uIiBhZnRlciBkYXkgb2YgVG9kYXkKCgovKgpAb3V0cHV0OiBiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBDcmVhdGUKQGNyZWF0ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgc2hvdWxkIGJlIHByb3ZpZGVkIHdpdGhpbiB0aGUgZmlyc3Qgd2VlayBvZiBsaWZlIGFuZCBpZiB0aGUgY2xpZW50IGlzIGluIGEgcG9saW8tZW5kZW1pYyBjb3VudHJ5IG9yIGEgY291bnRyeSBhdCBoaWdoIHJpc2sgZm9yIGltcG9ydGF0aW9uIGFuZCBzdWJzZXF1ZW50IHNwcmVhZCBvZiBwb2xpbwoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIENyZWF0ZSI6CiAgaWYgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIgogIHRoZW4gJ2JPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHNob3VsZCBiZSBwcm92aWRlZCB3aXRoaW4gdGhlIGZpcnN0IHdlZWsgb2YgbGlmZSBhbmQgaWYgdGhlIGNsaWVudCBpcyBpbiBhIHBvbGlvLWVuZGVtaWMgY291bnRyeSBvciBhIGNvdW50cnkgYXQgaGlnaCByaXNrIGZvciBpbXBvcnRhdGlvbiBhbmQgc3Vic2VxdWVudCBzcHJlYWQgb2YgcG9saW8nICsgJwpEdWUgRGF0ZTogJyArIFRvU3RyaW5nKCJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBEdWUgRGF0ZSIpICsgJwpPdmVyZHVlOiAnICsgVG9TdHJpbmcoImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIE92ZXJkdWUiKSArICcKRXhwaXJhdGlvbjogJyArIFRvU3RyaW5nKCJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBFeHBpcmF0aW9uIikKICBlbHNlICcnCgoKLyoKQGR5bmFtaWNWYWx1ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRHVlIERhdGUKQHBzZXVkb2NvZGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIER1ZSBEYXRlIjoKICBpZiAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkiIHRoZW4gUGF0aWVudC5iaXJ0aERhdGUKICBlbHNlIG51bGwKCgovKgpAZHluYW1pY1ZhbHVlOiBiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSBPdmVyZHVlCkBwc2V1ZG9jb2RlOiAiRGF0ZSBvZiBiaXJ0aCIgKyAxIGRheQoqLwpkZWZpbmUgImJPUFYgYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIE92ZXJkdWUiOgogIGlmICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIgdGhlbiBQYXRpZW50LmJpcnRoRGF0ZSArIDEgZGF5CiAgZWxzZSBudWxsCgoKLyoKQGR5bmFtaWNWYWx1ZTogYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRXhwaXJhdGlvbgpAcHNldWRvY29kZTogIkRhdGUgb2YgYmlydGgiICsgMSB3ZWVrCiovCmRlZmluZSAiYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgRXhwaXJhdGlvbiI6CiAgUGF0aWVudC5iaXJ0aERhdGUgKyAxIHdlZWsKCiAgCi8qCkBjb21wbGV0ZTogUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQKQHBzZXVkb2NvZGU6IENvdW50IG9mIHZhY2NpbmVzIGFkbWluaXN0ZXJlZCAod2hlcmUgIlZhY2NpbmUgdHlwZSIgPSAiUG9saW92aXJ1cy1jb250YWluaW5nIHZhY2NpbmVzIiBhbmQgIlR5cGUgb2YgZG9zZSIgPSAiRG9zZSAwIiBBTkQgIkJpcnRoIGRvc2UiID0gVFJVRSkgPSAxCiovCmRlZmluZSAiUG9saW8gYmlydGggZG9zZSAoYSB6ZXJvIGRvc2UpIHdhcyBhZG1pbmlzdGVyZWQiOgogIEVuY291bnRlci4iYk9QViBiaXJ0aCBkb3NlIChhIHplcm8gZG9zZSkgd2FzIGFkbWluaXN0ZXJlZCIKCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnUG9saW8wOC4yJyB0aGVuICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdQb2xpbzA5LjInIHRoZW4gbm90ICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdQb2xpbzEwLjEnIHRoZW4gbm90ICJiT1BWIGJpcnRoIGRvc2UgKGEgemVybyBkb3NlKSIKICAgIGVsc2UgJ05vIHRlc3QgY2FzZSBzZXQnCiAgZW5kCg=="
}
]
}