{ "resourceType" : "Library", "id" : "IMMZD18SHepatitisBBirthDoseLogic", "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: IMMZD18SHepatitisBBirthDoseLogic
Id: IMMZD18SHepatitisBBirthDoseLogic
Version: 1.0.0
Url: IMMZD18SHepatitisBBirthDoseLogic
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.D18.S.Hepatitis B.Birth dose schedule 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Hepatitis B birth dose was administeredboolean01Out
Hepatitis B birth doseboolean01Out
Hepatitis B birth dose Due Datedate01Out
Hepatitis B birth dose Overduedate01Out
Hepatitis B birth dose Createstring01Out
Hepatitis B birth dose ExpirationResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SHepatitisBBirthDoseLogic (IMMZ.D18.S.Hepatitis B.Birth dose schedule)\n * Schedule Table: Birth dose schedule\n */\nlibrary IMMZD18SHepatitisBBirthDoseLogic\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 IMMZD2DTHepatitisBEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: Hepatitis B birth dose\n@description: Provision of hepatitis B birth dose\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "Hepatitis B birth dose":\n  not "Hepatitis B birth dose was administered"\n\n\n/*\n@output: Hepatitis B birth dose Create\n@create: All infants should receive a first dose of the hepatitis B-containing vaccine as soon as possible after birth, ideally within 24 hours\n*/\ndefine "Hepatitis B birth dose Create":\n  if "Hepatitis B birth dose"\n  then 'All infants should receive a first dose of the hepatitis B-containing vaccine as soon as possible after birth, ideally within 24 hours' + '\nDue Date: ' + ToString("Hepatitis B birth dose Due Date") + '\nOverdue: ' + ToString("Hepatitis B birth dose Overdue")\n  else ''\n\n\n/*\n@dynamicValue: Hepatitis B birth dose Due Date\n@pseudocode: "Date of birth"\n*/\ndefine "Hepatitis B birth dose Due Date":\n  if "Hepatitis B birth dose" then Patient.birthDate\n  else null\n\n\n/*\n@dynamicValue: Hepatitis B birth dose Overdue\n@pseudocode: "Date of birth" + 24 hours\n*/\ndefine "Hepatitis B birth dose Overdue":\n  if "Hepatitis B birth dose" then Patient.birthDate + 24 hours\n  else null\n\n\n/*\n@dynamicValue: Hepatitis B birth dose Expiration\n@pseudocode: To be determined by Member States\n*/\ndefine "Hepatitis B birth dose Expiration":\n  null\n\n  \n/*\n@complete: Hepatitis B birth dose was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Birth Dose" = TRUE) = 1\n*/\ndefine "Hepatitis B birth dose was administered":\n  Encounter."Hepatitis B birth 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 = 'HepatitisB08.2' then "Hepatitis B birth dose"\n    when Patient.id = 'HepatitisB09.2' then "Hepatitis B birth dose"\n    when Patient.id = 'HepatitisB10.1' then not "Hepatitis B birth dose" and "Hepatitis B birth dose was administered"\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/IMMZD18SHepatitisBBirthDoseLogic", "version" : "1.0.0", "name" : "IMMZD18SHepatitisBBirthDoseLogic", "title" : "IMMZD18SHepatitisBBirthDoseLogic", "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.Hepatitis B.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/IMMZD2DTHepatitisBEncounterElements" }], "parameter" : [{ "name" : "Today", "use" : "in", "min" : 0, "max" : "1", "type" : "date" }, { "name" : "Patient", "use" : "out", "min" : 0, "max" : "1", "type" : "Patient" }, { "name" : "Hepatitis B birth dose was administered", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Hepatitis B birth dose", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Hepatitis B birth dose Due Date", "use" : "out", "min" : 0, "max" : "1", "type" : "date" }, { "name" : "Hepatitis B birth dose Overdue", "use" : "out", "min" : 0, "max" : "1", "type" : "date" }, { "name" : "Hepatitis B birth dose Create", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Hepatitis B birth dose Expiration", "use" : "out", "min" : 0, "max" : "1", "type" : "Resource" }, { "name" : "Test Validation", "use" : "out", "min" : 0, "max" : "1", "type" : "Resource" }], "content" : [{ "contentType" : "text/cql", "data" : "LyoKICogTGlicmFyeTogSU1NWkQxOFNIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMgKElNTVouRDE4LlMuSGVwYXRpdGlzIEIuQmlydGggZG9zZSBzY2hlZHVsZSkKICogU2NoZWR1bGUgVGFibGU6IEJpcnRoIGRvc2Ugc2NoZWR1bGUKICovCmxpYnJhcnkgSU1NWkQxOFNIZXBhdGl0aXNCQmlydGhEb3NlTG9naWMKCnVzaW5nIEZISVIgdmVyc2lvbiAnNC4wLjEnCmluY2x1ZGUgRkhJUkhlbHBlcnMgdmVyc2lvbiAnNC4wLjEnCgppbmNsdWRlIFdIT0NvbW1vbiBjYWxsZWQgV0MKCmluY2x1ZGUgSU1NWkNvbW1vbiBjYWxsZWQgQ29tbW9uCmluY2x1ZGUgSU1NWkNvbmNlcHRzIGNhbGxlZCBDb25jZXB0cwoKaW5jbHVkZSBJTU1aRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIElFCmluY2x1ZGUgSU1NWkQyRFRIZXBhdGl0aXNCRW5jb3VudGVyRWxlbWVudHMgY2FsbGVkIEVuY291bnRlcgoKcGFyYW1ldGVyIFRvZGF5IERhdGUgZGVmYXVsdCBUb2RheSgpCgoKY29udGV4dCBQYXRpZW50CgoKLyoKQG91dHB1dDogSGVwYXRpdGlzIEIgYmlydGggZG9zZQpAZGVzY3JpcHRpb246IFByb3Zpc2lvbiBvZiBoZXBhdGl0aXMgQiBiaXJ0aCBkb3NlCkB0cmlnZ2VyOiBDaGlsZCdzIGJpcnRoCkBwc2V1ZG86IApAdHJpZ2dlckRhdGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiOgogIG5vdCAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIgoKCi8qCkBvdXRwdXQ6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgQ3JlYXRlCkBjcmVhdGU6IEFsbCBpbmZhbnRzIHNob3VsZCByZWNlaXZlIGEgZmlyc3QgZG9zZSBvZiB0aGUgaGVwYXRpdGlzIEItY29udGFpbmluZyB2YWNjaW5lIGFzIHNvb24gYXMgcG9zc2libGUgYWZ0ZXIgYmlydGgsIGlkZWFsbHkgd2l0aGluIDI0IGhvdXJzCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBDcmVhdGUiOgogIGlmICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIgogIHRoZW4gJ0FsbCBpbmZhbnRzIHNob3VsZCByZWNlaXZlIGEgZmlyc3QgZG9zZSBvZiB0aGUgaGVwYXRpdGlzIEItY29udGFpbmluZyB2YWNjaW5lIGFzIHNvb24gYXMgcG9zc2libGUgYWZ0ZXIgYmlydGgsIGlkZWFsbHkgd2l0aGluIDI0IGhvdXJzJyArICcKRHVlIERhdGU6ICcgKyBUb1N0cmluZygiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBEdWUgRGF0ZSIpICsgJwpPdmVyZHVlOiAnICsgVG9TdHJpbmcoIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgT3ZlcmR1ZSIpCiAgZWxzZSAnJwoKCi8qCkBkeW5hbWljVmFsdWU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRHVlIERhdGUKQHBzZXVkb2NvZGU6ICJEYXRlIG9mIGJpcnRoIgoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRHVlIERhdGUiOgogIGlmICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiB0aGVuIFBhdGllbnQuYmlydGhEYXRlCiAgZWxzZSBudWxsCgoKLyoKQGR5bmFtaWNWYWx1ZTogSGVwYXRpdGlzIEIgYmlydGggZG9zZSBPdmVyZHVlCkBwc2V1ZG9jb2RlOiAiRGF0ZSBvZiBiaXJ0aCIgKyAyNCBob3VycwoqLwpkZWZpbmUgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgT3ZlcmR1ZSI6CiAgaWYgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiIHRoZW4gUGF0aWVudC5iaXJ0aERhdGUgKyAyNCBob3VycwogIGVsc2UgbnVsbAoKCi8qCkBkeW5hbWljVmFsdWU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2UgRXhwaXJhdGlvbgpAcHNldWRvY29kZTogVG8gYmUgZGV0ZXJtaW5lZCBieSBNZW1iZXIgU3RhdGVzCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSBFeHBpcmF0aW9uIjoKICBudWxsCgogIAovKgpAY29tcGxldGU6IEhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZApAcHNldWRvY29kZTogQ291bnQgb2YgdmFjY2luZXMgYWRtaW5pc3RlcmVkICh3aGVyZSAiVmFjY2luZSB0eXBlIiA9ICJIZXBhdGl0aXMgQi1jb250YWluaW5nIHZhY2NpbmVzIiBhbmQgIkJpcnRoIERvc2UiID0gVFJVRSkgPSAxCiovCmRlZmluZSAiSGVwYXRpdGlzIEIgYmlydGggZG9zZSB3YXMgYWRtaW5pc3RlcmVkIjoKICBFbmNvdW50ZXIuIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjA4LjInIHRoZW4gIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjA5LjInIHRoZW4gIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2UiCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQjEwLjEnIHRoZW4gbm90ICJIZXBhdGl0aXMgQiBiaXJ0aCBkb3NlIiBhbmQgIkhlcGF0aXRpcyBCIGJpcnRoIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKICAgIGVsc2UgJ05vIHRlc3QgY2FzZSBzZXQnCiAgZW5kCg==" }] }