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 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:Library ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "IMMZD5DTHepatitisBContraindicationsLogic"] ; #
fhir:meta [
( fhir:profile [
fhir:v "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary> ] [
fhir:v "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary> ] [
fhir:v "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library> ] [
fhir:v "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module> ] )
] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir:div [ fhir:v "<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;\">IMMZD5DTHepatitisBContraindicationsLogic</td>\n </tr>\n \n\n \n \n <tr>\n <th scope=\"row\"><b>Id: </b></th>\n <td style=\"padding-left: 4px;\">IMMZD5DTHepatitisBContraindicationsLogic</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-IMMZD5DTHepatitisBContraindicationsLogic.html\">IMMZD5DTHepatitisBContraindicationsLogic</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.D5.DT.Hepatitis B contraindications decision 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-IMMZD5DTHepatitisBEncounterElements.html\">IMMZD5DTHepatitisBEncounterElements</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>Draft Medication Request ID for Hepatitis B dose</th><th>id</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note.</th><th>boolean</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Guidance</th><th>string</th><th>0</th><th>1</th><th>Out</th></tr>\n \n <tr><th>Has Guidance</th><th>boolean</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: IMMZD5DTHepatitisBContraindicationsLogic (IMMZ.D5.DT.Hepatitis B contraindications)\n * Rule: Check for contraindications before administering the vaccine(s) due\n * Decision Table: IMMZ.D5.DT.Hepatitis B contraindications\n * Trigger: IMMZ.D5 Determine vaccine(s) to be administered based on contraindications\n */\nlibrary IMMZD5DTHepatitisBContraindicationsLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude IMMZD5DTHepatitisBEncounterElements called Encounter\n\nparameter Today Date default Today()\n\ncontext Patient\n\n/*\n @dynamicValue: Draft Medication Request ID for Hepatitis B dose\n */\n define \"Draft Medication Request ID for Hepatitis B dose\":\n First(Encounter.\"Draft Medication Request for Hepatitis B dose\").id\n\n\n/*\n@dynamicValue: Guidance\n*/\ndefine \"Guidance\":\n case \n when \"Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note.\" then \"Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. Guidance\" \n else ''\n end\n \ndefine \"Has Guidance\":\n \"Guidance\" is not null and \"Guidance\" != ''\n\n/*\n@output: Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note.\n@pseudocode: '\"Immunization recommendation status\" = \"Further evaluation needed\"\n*/\ndefine \"Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note.\":\n Encounter.\"The client has history of severe allergic reactions\"\n\n/*\n@output: Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. Guidance\n@guidance: Do not vaccinate client with hepatitis B if the client had a history of serious allergic reactions to any of the vaccine components. Allergy to yeast is considered a contraindication to immunization with yeast-produced hepatitis B-containing vaccine.\n*/\ndefine \"Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. Guidance\":\n 'Do not vaccinate client with hepatitis B if the client had a history of serious allergic reactions to any of the vaccine components. Allergy to yeast is considered a contraindication to immunization with yeast-produced hepatitis B-containing vaccine.'\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine \"Test Validation\":\n case\n when Patient.id = 'HepatitisB62.1' then \"Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note.\" and \"Guidance\" = 'Do not vaccinate client with hepatitis B if the client had a history of serious allergic reactions to any of the vaccine components. Allergy to yeast is considered a contraindication to immunization with yeast-produced hepatitis B-containing vaccine.'\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>"^^rdf:XMLLiteral ]
] ; #
fhir:extension ( [
fhir:url [
fhir:v "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability> ] ;
fhir:value [
a fhir:Code ;
fhir:v "computable" ]
] ) ; #
fhir:url [
fhir:v "http://smart.who.int/immunizations/Library/IMMZD5DTHepatitisBContraindicationsLogic"^^xsd:anyURI ;
fhir:l <http://smart.who.int/immunizations/Library/IMMZD5DTHepatitisBContraindicationsLogic>
] ; #
fhir:version [ fhir:v "1.0.0"] ; #
fhir:name [ fhir:v "IMMZD5DTHepatitisBContraindicationsLogic"] ; #
fhir:title [ fhir:v "IMMZD5DTHepatitisBContraindicationsLogic"] ; #
fhir:status [ fhir:v "draft"] ; #
fhir:experimental [ fhir:v false] ; #
fhir:type [
( fhir:coding [
fhir:system [
fhir:v "http://terminology.hl7.org/CodeSystem/library-type"^^xsd:anyURI ;
fhir:l <http://terminology.hl7.org/CodeSystem/library-type> ] ;
fhir:code [ fhir:v "logic-library" ] ] )
] ; #
fhir:date [ fhir:v "2026-03-31T13:54:17+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "WHO"] ; #
fhir:contact ( [
fhir:name [ fhir:v "WHO" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://who.int" ] ] )
] ) ; #
fhir:description [ fhir:v "This library defines decision support logic for the IMMZ.D5.DT.Hepatitis B contraindications decision table in the Immunization CPG"] ; #
fhir:relatedArtifact ( [
fhir:type [ fhir:v "depends-on" ] ;
fhir:display [ fhir:v "Library Encounter" ] ;
fhir:resource [
fhir:v "http://smart.who.int/immunizations/Library/IMMZD5DTHepatitisBEncounterElements"^^xsd:anyURI ;
fhir:l <http://smart.who.int/immunizations/Library/IMMZD5DTHepatitisBEncounterElements> ]
] ) ; #
fhir:parameter ( [
fhir:name [ fhir:v "Today" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "date" ]
] [
fhir:name [ fhir:v "Patient" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "Patient" ]
] [
fhir:name [ fhir:v "Draft Medication Request ID for Hepatitis B dose" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "id" ]
] [
fhir:name [ fhir:v "Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note." ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "boolean" ]
] [
fhir:name [ fhir:v "Hepatitis B vaccination could be contraindicated. Clinical judgement is required. Create a clinical note. Guidance" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "Guidance" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "string" ]
] [
fhir:name [ fhir:v "Has Guidance" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "boolean" ]
] [
fhir:name [ fhir:v "Test Validation" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 0 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:type [ fhir:v "Resource" ]
] ) ; #
fhir:content ( [
fhir:contentType [ fhir:v "text/cql" ] ;
fhir:data [ fhir:v "LyoKICogTGlicmFyeTogSU1NWkQ1RFRIZXBhdGl0aXNCQ29udHJhaW5kaWNhdGlvbnNMb2dpYyAoSU1NWi5ENS5EVC5IZXBhdGl0aXMgQiBjb250cmFpbmRpY2F0aW9ucykKICogUnVsZTogQ2hlY2sgZm9yIGNvbnRyYWluZGljYXRpb25zIGJlZm9yZSBhZG1pbmlzdGVyaW5nIHRoZSB2YWNjaW5lKHMpIGR1ZQogKiBEZWNpc2lvbiBUYWJsZTogSU1NWi5ENS5EVC5IZXBhdGl0aXMgQiBjb250cmFpbmRpY2F0aW9ucwogKiBUcmlnZ2VyOiBJTU1aLkQ1IERldGVybWluZSB2YWNjaW5lKHMpIHRvIGJlIGFkbWluaXN0ZXJlZCBiYXNlZCBvbiBjb250cmFpbmRpY2F0aW9ucwogKi8KbGlicmFyeSBJTU1aRDVEVEhlcGF0aXRpc0JDb250cmFpbmRpY2F0aW9uc0xvZ2ljCgp1c2luZyBGSElSIHZlcnNpb24gJzQuMC4xJwppbmNsdWRlIEZISVJIZWxwZXJzIHZlcnNpb24gJzQuMC4xJwoKaW5jbHVkZSBJTU1aRDVEVEhlcGF0aXRpc0JFbmNvdW50ZXJFbGVtZW50cyBjYWxsZWQgRW5jb3VudGVyCgpwYXJhbWV0ZXIgVG9kYXkgRGF0ZSBkZWZhdWx0IFRvZGF5KCkKCmNvbnRleHQgUGF0aWVudAoKLyoKICBAZHluYW1pY1ZhbHVlOiBEcmFmdCBNZWRpY2F0aW9uIFJlcXVlc3QgSUQgZm9yIEhlcGF0aXRpcyBCIGRvc2UKICAqLwogIGRlZmluZSAiRHJhZnQgTWVkaWNhdGlvbiBSZXF1ZXN0IElEIGZvciBIZXBhdGl0aXMgQiBkb3NlIjoKICAgIEZpcnN0KEVuY291bnRlci4iRHJhZnQgTWVkaWNhdGlvbiBSZXF1ZXN0IGZvciBIZXBhdGl0aXMgQiBkb3NlIikuaWQKCgovKgpAZHluYW1pY1ZhbHVlOiBHdWlkYW5jZQoqLwpkZWZpbmUgIkd1aWRhbmNlIjoKICBjYXNlIAogICAgd2hlbiAiSGVwYXRpdGlzIEIgdmFjY2luYXRpb24gY291bGQgYmUgY29udHJhaW5kaWNhdGVkLiBDbGluaWNhbCBqdWRnZW1lbnQgaXMgcmVxdWlyZWQuIENyZWF0ZSBhIGNsaW5pY2FsIG5vdGUuIiB0aGVuICJIZXBhdGl0aXMgQiB2YWNjaW5hdGlvbiBjb3VsZCBiZSBjb250cmFpbmRpY2F0ZWQuIENsaW5pY2FsIGp1ZGdlbWVudCBpcyByZXF1aXJlZC4gQ3JlYXRlIGEgY2xpbmljYWwgbm90ZS4gR3VpZGFuY2UiIAogICAgZWxzZSAnJwogIGVuZAogIApkZWZpbmUgIkhhcyBHdWlkYW5jZSI6CiAgIkd1aWRhbmNlIiBpcyBub3QgbnVsbCBhbmQgIkd1aWRhbmNlIiAhPSAnJwoKLyoKQG91dHB1dDogSGVwYXRpdGlzIEIgdmFjY2luYXRpb24gY291bGQgYmUgY29udHJhaW5kaWNhdGVkLiBDbGluaWNhbCBqdWRnZW1lbnQgaXMgcmVxdWlyZWQuIENyZWF0ZSBhIGNsaW5pY2FsIG5vdGUuCkBwc2V1ZG9jb2RlOiAnIkltbXVuaXphdGlvbiByZWNvbW1lbmRhdGlvbiBzdGF0dXMiID0gIkZ1cnRoZXIgZXZhbHVhdGlvbiBuZWVkZWQiCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgdmFjY2luYXRpb24gY291bGQgYmUgY29udHJhaW5kaWNhdGVkLiBDbGluaWNhbCBqdWRnZW1lbnQgaXMgcmVxdWlyZWQuIENyZWF0ZSBhIGNsaW5pY2FsIG5vdGUuIjoKICBFbmNvdW50ZXIuIlRoZSBjbGllbnQgaGFzIGhpc3Rvcnkgb2Ygc2V2ZXJlIGFsbGVyZ2ljIHJlYWN0aW9ucyIKCi8qCkBvdXRwdXQ6IEhlcGF0aXRpcyBCIHZhY2NpbmF0aW9uIGNvdWxkIGJlIGNvbnRyYWluZGljYXRlZC4gQ2xpbmljYWwganVkZ2VtZW50IGlzIHJlcXVpcmVkLiBDcmVhdGUgYSBjbGluaWNhbCBub3RlLiBHdWlkYW5jZQpAZ3VpZGFuY2U6IERvIG5vdCB2YWNjaW5hdGUgY2xpZW50IHdpdGggaGVwYXRpdGlzIEIgaWYgdGhlIGNsaWVudCBoYWQgYSBoaXN0b3J5IG9mIHNlcmlvdXMgYWxsZXJnaWMgcmVhY3Rpb25zIHRvIGFueSBvZiB0aGUgdmFjY2luZSBjb21wb25lbnRzLiBBbGxlcmd5IHRvIHllYXN0IGlzIGNvbnNpZGVyZWQgYSBjb250cmFpbmRpY2F0aW9uIHRvIGltbXVuaXphdGlvbiB3aXRoIHllYXN0LXByb2R1Y2VkIGhlcGF0aXRpcyBCLWNvbnRhaW5pbmcgdmFjY2luZS4KKi8KZGVmaW5lICJIZXBhdGl0aXMgQiB2YWNjaW5hdGlvbiBjb3VsZCBiZSBjb250cmFpbmRpY2F0ZWQuIENsaW5pY2FsIGp1ZGdlbWVudCBpcyByZXF1aXJlZC4gQ3JlYXRlIGEgY2xpbmljYWwgbm90ZS4gR3VpZGFuY2UiOgogICdEbyBub3QgdmFjY2luYXRlIGNsaWVudCB3aXRoIGhlcGF0aXRpcyBCIGlmIHRoZSBjbGllbnQgaGFkIGEgaGlzdG9yeSBvZiBzZXJpb3VzIGFsbGVyZ2ljIHJlYWN0aW9ucyB0byBhbnkgb2YgdGhlIHZhY2NpbmUgY29tcG9uZW50cy4gQWxsZXJneSB0byB5ZWFzdCBpcyBjb25zaWRlcmVkIGEgY29udHJhaW5kaWNhdGlvbiB0byBpbW11bml6YXRpb24gd2l0aCB5ZWFzdC1wcm9kdWNlZCBoZXBhdGl0aXMgQi1jb250YWluaW5nIHZhY2NpbmUuJwoKCi8qCkB0ZXN0OiBUZXN0IGV4cGVjdGVkIHJlc3VsdHMgYmFzZWQgb24gZXhhbXBsZSBwYXRpZW50cwoqLwpkZWZpbmUgIlRlc3QgVmFsaWRhdGlvbiI6CiAgY2FzZQogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0I2Mi4xJyB0aGVuICJIZXBhdGl0aXMgQiB2YWNjaW5hdGlvbiBjb3VsZCBiZSBjb250cmFpbmRpY2F0ZWQuIENsaW5pY2FsIGp1ZGdlbWVudCBpcyByZXF1aXJlZC4gQ3JlYXRlIGEgY2xpbmljYWwgbm90ZS4iIGFuZCAiR3VpZGFuY2UiID0gJ0RvIG5vdCB2YWNjaW5hdGUgY2xpZW50IHdpdGggaGVwYXRpdGlzIEIgaWYgdGhlIGNsaWVudCBoYWQgYSBoaXN0b3J5IG9mIHNlcmlvdXMgYWxsZXJnaWMgcmVhY3Rpb25zIHRvIGFueSBvZiB0aGUgdmFjY2luZSBjb21wb25lbnRzLiBBbGxlcmd5IHRvIHllYXN0IGlzIGNvbnNpZGVyZWQgYSBjb250cmFpbmRpY2F0aW9uIHRvIGltbXVuaXphdGlvbiB3aXRoIHllYXN0LXByb2R1Y2VkIGhlcGF0aXRpcyBCLWNvbnRhaW5pbmcgdmFjY2luZS4nCiAgICBlbHNlICdObyB0ZXN0IGNhc2Ugc2V0JwogIGVuZAo="^^xsd:base64Binary ]
] ) . #
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