{ "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 \n \n \n \n \n \n \n
Title: IMMZD18SHepatitisBBirthDoseLogic
Id: IMMZD18SHepatitisBBirthDoseLogic
Version: 0.2.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-29 17:23:09+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 \n \n
Content: application/elm+xml
Encoded data (36124 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SHepatitisBBirthDoseLogic", "version": "0.2.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-29T17:23:09+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", "url": "Library-IMMZD18SHepatitisBBirthDoseLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SHepatitisBBirthDoseLogic.elm.xml" } ] }