Title: IMMZD18SHepatitisB4DoseLogic Id: IMMZD18SHepatitisB4DoseLogic Version: 0.2.0 Url: IMMZD18SHepatitisB4DoseLogic Status: draft Experimental: true Type: system: http://terminology.hl7.org/CodeSystem/library-type code: logic-library Date: 2025-06-25 20:08:00+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 Related Artifacts: Dependencies WHOCommon IMMZCommon IMMZConcepts IMMZEncounterElements IMMZD2DTHepatitisBEncounterElements Parameters: Name Type Min Max In/Out Today date 0 1 In Patient Patient 0 1 Out First hepatitis B dose from the primary series was administered boolean 0 1 Out Hepatitis B dose 1 boolean 0 1 Out Hepatitis B dose 1 Due Date date 0 1 Out Hepatitis B dose 1 Create string 0 1 Out Hepatitis B dose 1 Overdue Resource 0 1 Out Hepatitis B dose 1 Expiration Resource 0 1 Out Second hepatitis B dose from the primary series was administered boolean 0 1 Out Hepatitis B dose 2 boolean 0 1 Out Hepatitis B dose 2 Due Date date 0 1 Out Hepatitis B dose 2 Create string 0 1 Out Hepatitis B dose 2 Overdue Resource 0 1 Out Hepatitis B dose 2 Expiration Resource 0 1 Out Third hepatitis B dose from the primary series was administered. The primary series has been completed boolean 0 1 Out Hepatitis B dose 3 boolean 0 1 Out Hepatitis B dose 3 Due Date date 0 1 Out Hepatitis B dose 3 Create string 0 1 Out Hepatitis B dose 3 Overdue Resource 0 1 Out Hepatitis B dose 3 Expiration Resource 0 1 Out Test Validation Resource 0 1 Out Content: text/cql /* * Library: IMMZD18SHepatitisB4DoseLogic (IMMZ.D18.S.Hepatitis B.4-dose schedule) * Schedule Table: 4-dose schedule (birth dose + 3 primary series doses), on-time start */ library IMMZD18SHepatitisB4DoseLogic using FHIR version '4.0.1' include FHIRHelpers version '4.0.1' include WHOCommon called WC include IMMZCommon called Common include IMMZConcepts called Concepts include IMMZEncounterElements called IE include IMMZD2DTHepatitisBEncounterElements called Encounter parameter Today Date default Today() context Patient /* @output: Hepatitis B dose 1 @description: Provision of hepatitis B dose 1 @trigger: Child's birth @triggerDate: "Date of birth" */ define "Hepatitis B dose 1": not "First hepatitis B dose from the primary series was administered" /* @output: Hepatitis B dose 1 Create @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. */ define "Hepatitis B dose 1 Create": if "Hepatitis B dose 1" 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.' + ' Due Date: ' + ToString("Hepatitis B dose 1 Due Date") else '' /* @dynamicValue: Hepatitis B dose 1 Due Date @pseudocode: "Date of birth" + Member States defined lower limit */ define "Hepatitis B dose 1 Due Date": if "Hepatitis B dose 1" then Patient.birthDate + (Encounter.HepBLowerLimitWeeks * 1 weeks) // Syntax is strange because using a parameter else null /* @dynamicValue: Hepatitis B dose 1 Overdue @pseudocode: To be determined by Member States; however, there is no recommended overdue date. */ define "Hepatitis B dose 1 Overdue": null /* @dynamicValue: Hepatitis B dose 1 Expiration @pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated. */ define "Hepatitis B dose 1 Expiration": null /* @complete: First hepatitis B dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 1 */ define "First hepatitis B dose from the primary series was administered": Encounter."One hepatitis B primary series dose was administered" /* @output: Hepatitis B dose 2 @description: Provision of hepatitis B dose 2 @trigger: First hepatitis B dose from the primary series was administered Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 1 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") */ define "Hepatitis B dose 2": "First hepatitis B dose from the primary series was administered" and not "Second hepatitis B dose from the primary series was administered" /* @output: Hepatitis B dose 2 Create @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. */ define "Hepatitis B dose 2 Create": if "Hepatitis B dose 2" 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.' + ' Due Date: ' + ToString("Hepatitis B dose 2 Due Date") else '' /* @dynamicValue: Hepatitis B dose 2 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") + 4 weeks */ define "Hepatitis B dose 2 Due Date": if "Hepatitis B dose 2" then Encounter."Date of Latest Hepatitis B Dose" + 4 weeks else null /* @dynamicValue: Hepatitis B dose 2 Overdue @pseudocode: To be determined by Member States; however, there is no recommended overdue date. */ define "Hepatitis B dose 2 Overdue": null /* @dynamicValue: Hepatitis B dose 2 Expiration @pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated. */ define "Hepatitis B dose 2 Expiration": null /* @complete: Second hepatitis B dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 2 */ define "Second hepatitis B dose from the primary series was administered": Encounter."Two hepatitis B primary series doses were administered" /* @output: Hepatitis B dose 3 @description: Provision of hepatitis B dose 3 @trigger: Second hepatitis B dose from the primary series was administered Count of vaccines administered (where "Vaccine type" = "Hepatitis B-containing vaccines" and "Type of dose"= "Primary series") = 2 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") */ define "Hepatitis B dose 3": "Second hepatitis B dose from the primary series was administered" and not "Third hepatitis B dose from the primary series was administered. The primary series has been completed" /* @output: Hepatitis B dose 3 Create @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. */ define "Hepatitis B dose 3 Create": if "Hepatitis B dose 3" 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.' + ' Due Date: ' + ToString("Hepatitis B dose 3 Due Date") else '' /* @dynamicValue: Hepatitis B dose 3 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hepatitis B-containing vaccines") + 4 weeks */ define "Hepatitis B dose 3 Due Date": if "Hepatitis B dose 3" then Encounter."Date of Latest Hepatitis B Dose" + 4 weeks else null /* @dynamicValue: Hepatitis B dose 3 Overdue @pseudocode: To be determined by Member States; however, there is no recommended overdue date. */ define "Hepatitis B dose 3 Overdue": null /* @dynamicValue: Hepatitis B dose 3 Expiration @pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated. */ define "Hepatitis B dose 3 Expiration": null /* @complete: Third hepatitis B dose from the primary series was administered. The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hepatitis B-containing vaccines") */ define "Third hepatitis B dose from the primary series was administered. The primary series has been completed": Encounter."Three hepatitis B primary series doses were administered" /* @test: Test expected results based on example patients */ define "Test Validation": case when Patient.id = '36.Alt4w' then "Hepatitis B dose 1" when Patient.id = '37.Agt4w' then "Hepatitis B dose 1" when Patient.id = '38.D1HBlt4w' then "Hepatitis B dose 2" when Patient.id = '39.D1HBgt4w' then "Hepatitis B dose 2" when Patient.id = '40.D2HBlt4w' then "Hepatitis B dose 3" when Patient.id = '41.D2HBgt4w' then "Hepatitis B dose 3" when Patient.id = '42.D3' then not "Hepatitis B dose 3" and "Third hepatitis B dose from the primary series was administered. The primary series has been completed" else 'No test case set' end Content: application/elm+xml Encoded data (79936 characters)
This library defines decision support logic for the IMMZ.D18.S.Hepatitis B.4-dose schedule table in the Immunization CPG
First hepatitis B dose from the primary series was administered
Second hepatitis B dose from the primary series was administered
Third hepatitis B dose from the primary series was administered. The primary series has been completed