{ "resourceType": "Library", "id": "IMMZD18SHepatitisB4DosesLogic", "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: IMMZD18SHepatitisB4DosesLogic
Id: IMMZD18SHepatitisB4DosesLogic
Version: 0.2.0
Url: IMMZD18SHepatitisB4DosesLogic
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.4-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 \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
First hepatitis B dose from the primary series was administeredboolean01Out
Second hepatitis B dose from the primary series was administeredboolean01Out
Third hepatitis B dose from the primary series was administered. The primary series has been completedboolean01Out
Hepatitis B dose 1boolean01Out
Hepatitis B dose 1 Due Datedate01Out
Hepatitis B dose 1 Createstring01Out
Hepatitis B dose 1 OverdueResource01Out
Hepatitis B dose 1 ExpirationResource01Out
Hepatitis B dose 2boolean01Out
Hepatitis B dose 2 Due Datedate01Out
Hepatitis B dose 2 Createstring01Out
Hepatitis B dose 2 OverdueResource01Out
Hepatitis B dose 2 ExpirationResource01Out
Hepatitis B dose 3boolean01Out
Hepatitis B dose 3 Due Datedate01Out
Hepatitis B dose 3 Createstring01Out
Hepatitis B dose 3 OverdueResource01Out
Hepatitis B dose 3 ExpirationResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SHepatitisB4DosesLogic (IMMZ.D18.S.Hepatitis B.4-dose schedule)\n * Schedule Table: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n */\nlibrary IMMZD18SHepatitisB4DosesLogic\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 dose 1\n@description: Provision of hepatitis B dose 1\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "Hepatitis B dose 1":\n  not "First hepatitis B dose from the primary series was administered"\n    and not "Second hepatitis B dose from the primary series was administered"\n    and not "Third hepatitis B dose from the primary series was administered. The primary series has been completed"\n\n\n/*\n@output: Hepatitis B dose 1 Create\n@create: The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.\n*/\ndefine "Hepatitis B dose 1 Create":\n  if "Hepatitis B dose 1"\n  then 'The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.' + '\nDue Date: ' + ToString("Hepatitis B dose 1 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Hepatitis B dose 1 Due Date\n@pseudocode: "Date of birth" + Member States defined lower limit\n*/\ndefine "Hepatitis B dose 1 Due Date":\n  if "Hepatitis B dose 1" then Patient.birthDate + (Encounter.HepBLowerLimitWeeks * 1 weeks)\n  else null\n\n\n/*\n@dynamicValue: Hepatitis B dose 1 Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Hepatitis B dose 1 Overdue":\n  null\n\n\n/*\n@dynamicValue: Hepatitis B dose 1 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Hepatitis B dose 1 Expiration":\n  null\n\n  \n/*\n@complete: First hepatitis B dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 1\n*/\ndefine "First hepatitis B dose from the primary series was administered":\n  Encounter."One hepatitis B primary series dose was administered"\n\n\n\n/*\n@output: Hepatitis B dose 2\n@description: Provision of hepatitis B dose 2\n@trigger: First hepatitis B dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 1\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines")\n*/\ndefine "Hepatitis B dose 2":\n  "First hepatitis B dose from the primary series was administered"\n    and not "Second hepatitis B dose from the primary series was administered"\n    and not "Third hepatitis B dose from the primary series was administered. The primary series has been completed"\n\n\n/*\n@output: Hepatitis B dose 2 Create\n@create: The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.\n*/\ndefine "Hepatitis B dose 2 Create":\n  if "Hepatitis B dose 2"\n  then 'The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.' + '\nDue Date: ' + ToString("Hepatitis B dose 2 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Hepatitis B dose 2 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") + 4 weeks\n*/\ndefine "Hepatitis B dose 2 Due Date":\n  if "Hepatitis B dose 2" then Encounter."Date of Latest Hepatitis B Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: Hepatitis B dose 2 Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Hepatitis B dose 2 Overdue":\n  null\n\n\n/*\n@dynamicValue: Hepatitis B dose 2 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Hepatitis B dose 2 Expiration":\n  null\n\n  \n/*\n@complete: Second hepatitis B dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 2\n*/\ndefine "Second hepatitis B dose from the primary series was administered":\n  Encounter."Two hepatitis B primary series doses were administered"\n\n\n\n/*\n@output: Hepatitis B dose 3\n@description: Provision of hepatitis B dose 3\n@trigger: Second hepatitis B dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 2\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines")\n*/\ndefine "Hepatitis B dose 3":\n  "Second hepatitis B dose from the primary series was administered"\n    and not "Third hepatitis B dose from the primary series was administered. The primary series has been completed"\n\n\n/*\n@output: Hepatitis B dose 3 Create\n@create: The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.\n*/\ndefine "Hepatitis B dose 3 Create":\n  if "Hepatitis B dose 3"\n  then 'The following option is considered appropriate: 4 doses, where a monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; the additional dose does not cause any harm. The interval between doses should be at least 4 weeks.' + '\nDue Date: ' + ToString("Hepatitis B dose 3 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Hepatitis B dose 3 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") + 4 weeks\n*/\ndefine "Hepatitis B dose 3 Due Date":\n  if "Hepatitis B dose 3" then Encounter."Date of Latest Hepatitis B Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: Hepatitis B dose 3 Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Hepatitis B dose 3 Overdue":\n  null\n\n\n/*\n@dynamicValue: Hepatitis B dose 3 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Hepatitis B dose 3 Expiration":\n  null\n\n  \n/*\n@complete: Third hepatitis B dose from the primary series was administered. The primary series has been completed\n@pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hepatitis B-containing vaccines")\n*/\ndefine "Third hepatitis B dose from the primary series was administered. The primary series has been completed":\n  Encounter."Three hepatitis B primary series doses were administered"\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'HepatitisB36.2' then "Hepatitis B dose 1"\n    when Patient.id = 'HepatitisB37.2' then "Hepatitis B dose 1"\n    when Patient.id = 'HepatitisB38.2' then "Hepatitis B dose 2"\n    when Patient.id = 'HepatitisB39.2' then "Hepatitis B dose 2"\n    when Patient.id = 'HepatitisB40.2' then "Hepatitis B dose 3"\n    when Patient.id = 'HepatitisB41.2' then "Hepatitis B dose 3"\n    when Patient.id = 'HepatitisB42.1' then not "Hepatitis B dose 3" and "Third hepatitis B dose from the primary series was administered. The primary series has been completed"\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (83604 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SHepatitisB4DosesLogic", "version": "0.2.0", "name": "IMMZD18SHepatitisB4DosesLogic", "title": "IMMZD18SHepatitisB4DosesLogic", "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.4-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": "First hepatitis B dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Second hepatitis B dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Third hepatitis B dose from the primary series was administered. The primary series has been completed", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hepatitis B dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hepatitis B dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hepatitis B dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hepatitis B dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Hepatitis B dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Hepatitis B dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hepatitis B dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hepatitis B dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hepatitis B dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Hepatitis B dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Hepatitis B dose 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hepatitis B dose 3 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hepatitis B dose 3 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hepatitis B dose 3 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Hepatitis B dose 3 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-IMMZD18SHepatitisB4DosesLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SHepatitisB4DosesLogic.elm.xml" } ] }