{ "resourceType" : "Library", "id" : "IMMZD2DTHepatitisBBirthDoseLogic", "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" : "
\n
\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n \n \n
Title: IMMZD2DTHepatitisBBirthDoseLogic
Id: IMMZD2DTHepatitisBBirthDoseLogic
Version: 1.0.0
Url: IMMZD2DTHepatitisBBirthDoseLogic
Status: draft
Type: \n \n \n \n

\n system: http://terminology.hl7.org/CodeSystem/library-type\n

\n \n \n

\n code: logic-library\n

\n \n \n \n \n \n
Date: 2026-03-31 13:54:17+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D2.DT.Hepatitis B.Birth dose decision table in the Immunization CPG

\n
Related Artifacts: \n \n \n \n

Dependencies

\n \n \n \n \n \n \n
Parameters: \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is due for hepatitis B monovalent vaccineboolean01Out
Client is due for hepatitis B monovalent vaccine Guidancestring01Out
Client should follow delayed-start decision logicboolean01Out
Client should follow delayed-start decision logic Guidancestring01Out
Client is not due for the hepatitis B birth doseboolean01Out
Client is not due for the hepatitis B birth dose Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD2DTHepatitisBBirthDoseLogic (IMMZ.D2.DT.Hepatitis B.Birth dose)\n * Rule: Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule\n * Decision Table: Birth dose administration\n * Trigger: IMMZ.D2 Determine required vaccination(s) if any\n */\nlibrary IMMZD2DTHepatitisBBirthDoseLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude IMMZD2DTHepatitisBEncounterElements called Encounter\n\nparameter Today Date default Today()\n\ncontext Patient\n\n\n/*\n@dynamicValue: Guidance\n*/\ndefine "Guidance":\n  case \n    when "Client is due for hepatitis B monovalent vaccine" then "Client is due for hepatitis B monovalent vaccine Guidance"\n    when "Client should follow delayed-start decision logic" then "Client should follow delayed-start decision logic Guidance"\n    when "Client is not due for the hepatitis B birth dose" then "Client is not due for the hepatitis B birth dose Guidance" \n    else ''\n  end\n  \ndefine "Has Guidance":\n  "Guidance" is not null and "Guidance" != ''\n\n/*\n@output: Client is due for hepatitis B monovalent vaccine\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of hepatitis B dose" = "Hepatitis B monovalent vaccine")\n*/\ndefine "Client is due for hepatitis B monovalent vaccine":\n  Encounter."Hepatitis B birth dose was not administered"\n    and Encounter."Client's age is less than {Member States defined upper limit}"\n\n/*\n@output: Client is due for hepatitis B monovalent vaccine Guidance\n@guidance: Should vaccinate client with hepatitis B birth dose, as a monovalent dose. Check for contraindications.\n*/\ndefine "Client is due for hepatitis B monovalent vaccine Guidance":\n  'Should vaccinate client with hepatitis B birth dose, as a monovalent dose. Check for contraindications.'\n\n/*\n@output: Client should follow delayed-start decision logic\n@pseudocode: \n*/\ndefine "Client should follow delayed-start decision logic":\n  Encounter."Hepatitis B birth dose was not administered"\n    and Encounter."Client's age is more than {Member States defined upper limit}"\n\n/*\n@output: Client should follow delayed-start decision logic Guidance\n@guidance: The client has a delayed start. Please follow the delayed start schedule.\n*/\ndefine "Client should follow delayed-start decision logic Guidance":\n  'The client has a delayed start. Please follow the delayed start schedule.'\n\n/*\n@output: Client is not due for the hepatitis B birth dose\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for the hepatitis B birth dose":\n  Encounter."Hepatitis B birth dose was administered"\n\n/*\n@output: Client is not due for the hepatitis B birth dose Guidance\n@guidance: Hepatitis B birth dose was already administered. Check hepatitis B immunization schedule.\n*/\ndefine "Client is not due for the hepatitis B birth dose Guidance":\n  'Hepatitis B birth dose was already administered. Check hepatitis B immunization schedule.'\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    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.'\n    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.'\n    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.'\n    else 'No test case set'\n  end\n
\n
\n
\n
" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode" : "computable" }], "url" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisBBirthDoseLogic", "version" : "1.0.0", "name" : "IMMZD2DTHepatitisBBirthDoseLogic", "title" : "IMMZD2DTHepatitisBBirthDoseLogic", "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.D2.DT.Hepatitis B.Birth dose decision table in the Immunization CPG", "relatedArtifact" : [{ "type" : "depends-on", "display" : "Library Encounter", "resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisBEncounterElements" }], "parameter" : [{ "name" : "Today", "use" : "in", "min" : 0, "max" : "1", "type" : "date" }, { "name" : "Patient", "use" : "out", "min" : 0, "max" : "1", "type" : "Patient" }, { "name" : "Client is due for hepatitis B monovalent vaccine", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Client is due for hepatitis B monovalent vaccine Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Client should follow delayed-start decision logic", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Client should follow delayed-start decision logic Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Client is not due for the hepatitis B birth dose", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Client is not due for the hepatitis B birth dose Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Has Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Test Validation", "use" : "out", "min" : 0, "max" : "1", "type" : "Resource" }], "content" : [{ "contentType" : "text/cql", "data" : "LyoKICogTGlicmFyeTogSU1NWkQyRFRIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMgKElNTVouRDIuRFQuSGVwYXRpdGlzIEIuQmlydGggZG9zZSkKICogUnVsZTogRGV0ZXJtaW5lIGlmIHRoZSBjbGllbnQgaXMgZHVlIGZvciBhIGhlcGF0aXRpcyBCIHZhY2NpbmF0aW9uIGFjY29yZGluZyB0byB0aGUgbmF0aW9uYWwgaW1tdW5pemF0aW9uIHNjaGVkdWxlCiAqIERlY2lzaW9uIFRhYmxlOiBCaXJ0aCBkb3NlIGFkbWluaXN0cmF0aW9uCiAqIFRyaWdnZXI6IElNTVouRDIgRGV0ZXJtaW5lIHJlcXVpcmVkIHZhY2NpbmF0aW9uKHMpIGlmIGFueQogKi8KbGlicmFyeSBJTU1aRDJEVEhlcGF0aXRpc0JCaXJ0aERvc2VMb2dpYwoKdXNpbmcgRkhJUiB2ZXJzaW9uICc0LjAuMScKaW5jbHVkZSBGSElSSGVscGVycyB2ZXJzaW9uICc0LjAuMScKCmluY2x1ZGUgSU1NWkQyRFRIZXBhdGl0aXNCRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgpjb250ZXh0IFBhdGllbnQKCgovKgpAZHluYW1pY1ZhbHVlOiBHdWlkYW5jZQoqLwpkZWZpbmUgIkd1aWRhbmNlIjoKICBjYXNlIAogICAgd2hlbiAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIiB0aGVuICJDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUgR3VpZGFuY2UiCiAgICB3aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIiB0aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIEd1aWRhbmNlIgogICAgd2hlbiAiQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiB0aGVuICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgR3VpZGFuY2UiIAogICAgZWxzZSAnJwogIGVuZAogIApkZWZpbmUgIkhhcyBHdWlkYW5jZSI6CiAgIkd1aWRhbmNlIiBpcyBub3QgbnVsbCBhbmQgIkd1aWRhbmNlIiAhPSAnJwoKLyoKQG91dHB1dDogQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lCkBwc2V1ZG9jb2RlOiAiSW1tdW5pemF0aW9uIHJlY29tbWVuZGF0aW9uIHN0YXR1cyIgPSAiRHVlIiAod2hlcmUgIlR5cGUgb2YgaGVwYXRpdGlzIEIgZG9zZSIgPSAiSGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIikKKi8KZGVmaW5lICJDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgbm90IGFkbWluaXN0ZXJlZCIKICAgIGFuZCBFbmNvdW50ZXIuIkNsaWVudCdzIGFnZSBpcyBsZXNzIHRoYW4ge01lbWJlciBTdGF0ZXMgZGVmaW5lZCB1cHBlciBsaW1pdH0iCgovKgpAb3V0cHV0OiBDbGllbnQgaXMgZHVlIGZvciBoZXBhdGl0aXMgQiBtb25vdmFsZW50IHZhY2NpbmUgR3VpZGFuY2UKQGd1aWRhbmNlOiBTaG91bGQgdmFjY2luYXRlIGNsaWVudCB3aXRoIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UsIGFzIGEgbW9ub3ZhbGVudCBkb3NlLiBDaGVjayBmb3IgY29udHJhaW5kaWNhdGlvbnMuCiovCmRlZmluZSAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIEd1aWRhbmNlIjoKICAnU2hvdWxkIHZhY2NpbmF0ZSBjbGllbnQgd2l0aCBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlLCBhcyBhIG1vbm92YWxlbnQgZG9zZS4gQ2hlY2sgZm9yIGNvbnRyYWluZGljYXRpb25zLicKCi8qCkBvdXRwdXQ6IENsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMKQHBzZXVkb2NvZGU6IAoqLwpkZWZpbmUgIkNsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgbm90IGFkbWluaXN0ZXJlZCIKICAgIGFuZCBFbmNvdW50ZXIuIkNsaWVudCdzIGFnZSBpcyBtb3JlIHRoYW4ge01lbWJlciBTdGF0ZXMgZGVmaW5lZCB1cHBlciBsaW1pdH0iCgovKgpAb3V0cHV0OiBDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIEd1aWRhbmNlCkBndWlkYW5jZTogVGhlIGNsaWVudCBoYXMgYSBkZWxheWVkIHN0YXJ0LiBQbGVhc2UgZm9sbG93IHRoZSBkZWxheWVkIHN0YXJ0IHNjaGVkdWxlLgoqLwpkZWZpbmUgIkNsaWVudCBzaG91bGQgZm9sbG93IGRlbGF5ZWQtc3RhcnQgZGVjaXNpb24gbG9naWMgR3VpZGFuY2UiOgogICdUaGUgY2xpZW50IGhhcyBhIGRlbGF5ZWQgc3RhcnQuIFBsZWFzZSBmb2xsb3cgdGhlIGRlbGF5ZWQgc3RhcnQgc2NoZWR1bGUuJwoKLyoKQG91dHB1dDogQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlCkBwc2V1ZG9jb2RlOiAiSW1tdW5pemF0aW9uIHJlY29tbWVuZGF0aW9uIHN0YXR1cyIgPSAiTm90IGR1ZSIKKi8KZGVmaW5lICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiOgogIEVuY291bnRlci4iSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIgoKLyoKQG91dHB1dDogQ2xpZW50IGlzIG5vdCBkdWUgZm9yIHRoZSBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIEd1aWRhbmNlCkBndWlkYW5jZTogSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWxyZWFkeSBhZG1pbmlzdGVyZWQuIENoZWNrIGhlcGF0aXRpcyBCIGltbXVuaXphdGlvbiBzY2hlZHVsZS4KKi8KZGVmaW5lICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgR3VpZGFuY2UiOgogICdIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIHdhcyBhbHJlYWR5IGFkbWluaXN0ZXJlZC4gQ2hlY2sgaGVwYXRpdGlzIEIgaW1tdW5pemF0aW9uIHNjaGVkdWxlLicKCgovKgpAdGVzdDogVGVzdCBleHBlY3RlZCByZXN1bHRzIGJhc2VkIG9uIGV4YW1wbGUgcGF0aWVudHMKKi8KZGVmaW5lICJUZXN0IFZhbGlkYXRpb24iOgogIGNhc2UKICAgIHdoZW4gUGF0aWVudC5pZCA9ICdIZXBhdGl0aXNCMDguMicgdGhlbiAiQ2xpZW50IGlzIGR1ZSBmb3IgaGVwYXRpdGlzIEIgbW9ub3ZhbGVudCB2YWNjaW5lIiBhbmQgIkd1aWRhbmNlIiA9ICdTaG91bGQgdmFjY2luYXRlIGNsaWVudCB3aXRoIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UsIGFzIGEgbW9ub3ZhbGVudCBkb3NlLiBDaGVjayBmb3IgY29udHJhaW5kaWNhdGlvbnMuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0IwOS4yJyB0aGVuICJDbGllbnQgc2hvdWxkIGZvbGxvdyBkZWxheWVkLXN0YXJ0IGRlY2lzaW9uIGxvZ2ljIiBhbmQgIkd1aWRhbmNlIiA9ICdUaGUgY2xpZW50IGhhcyBhIGRlbGF5ZWQgc3RhcnQuIFBsZWFzZSBmb2xsb3cgdGhlIGRlbGF5ZWQgc3RhcnQgc2NoZWR1bGUuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0IxMC4xJyB0aGVuICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgdGhlIGhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiIGFuZCAiR3VpZGFuY2UiID0gJ0hlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFscmVhZHkgYWRtaW5pc3RlcmVkLiBDaGVjayBoZXBhdGl0aXMgQiBpbW11bml6YXRpb24gc2NoZWR1bGUuJwogICAgZWxzZSAnTm8gdGVzdCBjYXNlIHNldCcKICBlbmQK" }] }