Title: IMMZD2DTHepatitisBDelayedStartLogic Id: IMMZD2DTHepatitisBDelayedStartLogic Version: 0.2.0 Url: IMMZD2DTHepatitisBDelayedStartLogic Status: draft Type: system: http://terminology.hl7.org/CodeSystem/library-type code: logic-library Date: 2025-11-11 19:50:47+0000 Publisher: WHO Description: This library defines decision support logic for the IMMZ.D2.DT.Hepatitis B.Delayed start decision table in the Immunization CPG Related Artifacts: Dependencies IMMZD2DTHepatitisBEncounterElements Parameters: Name Type Min Max In/Out Today date 0 1 In Patient Patient 0 1 Out Client is due for hepatitis B vaccination boolean 0 1 Out Client is due for hepatitis B vaccination Guidance string 0 1 Out Client is not due for a hepatitis B vaccination Case 1 boolean 0 1 Out Client is not due for a hepatitis B vaccination Case 2 boolean 0 1 Out Client is not due for a hepatitis B vaccination Case 3 boolean 0 1 Out Client is not due for a hepatitis B vaccination boolean 0 1 Out Client is not due for a hepatitis B vaccination Guidance string 0 1 Out Client is due for a hepatitis B vaccination Case 1 boolean 0 1 Out Client is due for a hepatitis B vaccination Case 2 boolean 0 1 Out Client is due for a hepatitis B vaccination boolean 0 1 Out Client is due for a hepatitis B vaccination Guidance string 0 1 Out Hepatitis B immunization schedule is complete boolean 0 1 Out Hepatitis B immunization schedule is complete Guidance string 0 1 Out Guidance string 0 1 Out Has Guidance boolean 0 1 Out Test Validation Resource 0 1 Out Content: text/cql /* * Library: IMMZD2DTHepatitisBDelayedStartLogic (IMMZ.D2.DT.Hepatitis B.Delayed start) * Rule: Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule * Decision Table: 3-dose schedule (no birth dose + 3 doses), delayed start * Trigger: IMMZ.D2 Determine required vaccination(s) if any */ library IMMZD2DTHepatitisBDelayedStartLogic using FHIR version '4.0.1' include FHIRHelpers version '4.0.1' include IMMZD2DTHepatitisBEncounterElements called Encounter parameter Today Date default Today() context Patient /* @dynamicValue: Guidance */ define "Guidance": case when "Client is due for hepatitis B vaccination" then "Client is due for hepatitis B vaccination Guidance" when "Client is not due for a hepatitis B vaccination" then "Client is not due for a hepatitis B vaccination Guidance" when "Client is due for a hepatitis B vaccination" then "Client is due for a hepatitis B vaccination Guidance" when "Hepatitis B immunization schedule is complete" then "Hepatitis B immunization schedule is complete Guidance" else '' end define "Has Guidance": "Guidance" is not null and "Guidance" != '' /* @output: Client is due for hepatitis B vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for hepatitis B vaccination": Encounter."No hepatitis B doses were administered" and Encounter."Client's age is more than {Member States defined lower limit}" /* @output: Client is due for hepatitis B vaccination Guidance @guidance: Should vaccinate client with first hepatitis B dose as hepatitis B birth dose was not administered. The first hepatitis B dose should be administered as soon as possible. Check for contraindications. */ define "Client is due for hepatitis B vaccination Guidance": 'Should vaccinate client with first hepatitis B dose as hepatitis B birth dose was not administered. The first hepatitis B dose should be administered as soon as possible. Check for contraindications.' /* @output: Client is not due for a hepatitis B vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for a hepatitis B vaccination Case 1": Encounter."One hepatitis B dose was administered" and Encounter."The latest hepatitis B dose was administered less than 4 weeks ago" /* @output: Client is not due for a hepatitis B vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for a hepatitis B vaccination Case 2": Encounter."Two hepatitis B doses were administered" and Encounter."The latest hepatitis B dose was administered less than 4 weeks ago" /* @output: Client is not due for a hepatitis B vaccination Case 3 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for a hepatitis B vaccination Case 3": Encounter."Two hepatitis B doses were administered" and Encounter."The latest hepatitis B dose was administered more than 4 weeks ago" and Encounter."The first hepatitis B dose was administered less than 6 months ago" /* @output: Client is not due for a hepatitis B vaccination @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for a hepatitis B vaccination": "Client is not due for a hepatitis B vaccination Case 1" or "Client is not due for a hepatitis B vaccination Case 2" or "Client is not due for a hepatitis B vaccination Case 3" /* @output: Client is not due for a hepatitis B vaccination Guidance @guidance = Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose. @guidance = Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Two hepatitis B doses have been administered to the client. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose. @guidance = Should not vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered less than 6 months ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose. */ define "Client is not due for a hepatitis B vaccination Guidance": case when "Client is not due for a hepatitis B vaccination Case 1" then 'Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' when "Client is not due for a hepatitis B vaccination Case 2" then 'Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Two hepatitis B doses have been administered to the client. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' when "Client is not due for a hepatitis B vaccination Case 3" then 'Should not vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered less than 6 months ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' else '' end /* @output: Client is due for a hepatitis B vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for a hepatitis B vaccination Case 1": Encounter."One hepatitis B dose was administered" and Encounter."The latest hepatitis B dose was administered more than 4 weeks ago" /* @output: Client is due for a hepatitis B vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for a hepatitis B vaccination Case 2": Encounter."Two hepatitis B doses were administered" and Encounter."The latest hepatitis B dose was administered more than 4 weeks ago" and Encounter."The first hepatitis B dose was administered more than 6 months ago" /* @output: Client is due for a hepatitis B vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for a hepatitis B vaccination": "Client is due for a hepatitis B vaccination Case 1" or "Client is due for a hepatitis B vaccination Case 2" /* @output: Client is due for a hepatitis B vaccination Guidance @guidance = Should vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for contraindications. @guidance = Should vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered more than 6 months ago and the latest hepatitis B dose was administered more than 4 weeks ago. Check for contraindications. */ define "Client is due for a hepatitis B vaccination Guidance": case when "Client is due for a hepatitis B vaccination Case 1" then 'Should vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for contraindications.' when "Client is due for a hepatitis B vaccination Case 2" then 'Should vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered more than 6 months ago and the latest hepatitis B dose was administered more than 4 weeks ago. Check for contraindications.' else '' end /* @output: Hepatitis B immunization schedule is complete @pseudocode: '"Immunization recommendation status" = "Complete" "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hepatitis B-containing vaccines") */ define "Hepatitis B immunization schedule is complete": Encounter."Three hepatitis B doses were administered" /* @output: Hepatitis B immunization schedule is complete Guidance @guidance: Hepatitis B immunization schedule is complete. Three hepatitis B primary series doses were administered. Check for any other vaccines due. */ define "Hepatitis B immunization schedule is complete Guidance": 'Hepatitis B immunization schedule is complete. Three hepatitis B primary series doses were administered. Check for any other vaccines due.' /* @test: Test expected results based on example patients */ define "Test Validation": case when Patient.id = 'HepatitisB50.2' then "Client is due for hepatitis B vaccination" and "Guidance" = 'Should vaccinate client with first hepatitis B dose as hepatitis B birth dose was not administered. The first hepatitis B dose should be administered as soon as possible. Check for contraindications.' when Patient.id = 'HepatitisB51.2' then "Client is not due for a hepatitis B vaccination Case 1" and "Guidance" = 'Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' when Patient.id = 'HepatitisB52.2' then "Client is due for a hepatitis B vaccination Case 1" and "Guidance" = 'Should vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Check for contraindications.' when Patient.id = 'HepatitisB53.2' then "Client is not due for a hepatitis B vaccination Case 2" and "Guidance" = 'Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago. Two hepatitis B doses have been administered to the client. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' when Patient.id = 'HepatitisB54.3' then "Client is not due for a hepatitis B vaccination Case 3" and "Guidance" = 'Should not vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered less than 6 months ago. Check for any other vaccines due, and inform the caregiver of when to come back for the next dose.' when Patient.id = 'HepatitisB55.3' then "Client is due for a hepatitis B vaccination Case 2" and "Guidance" = 'Should vaccinate client with third hepatitis B dose as the first hepatitis B dose was administered more than 6 months ago and the latest hepatitis B dose was administered more than 4 weeks ago. Check for contraindications.' when Patient.id = 'HepatitisB56.1' then "Hepatitis B immunization schedule is complete" and "Guidance" = 'Hepatitis B immunization schedule is complete. Three hepatitis B primary series doses were administered. Check for any other vaccines due.' else 'No test case set' end Content: application/elm+xml Encoded data (93252 characters)
This library defines decision support logic for the IMMZ.D2.DT.Hepatitis B.Delayed start decision table in the Immunization CPG
Client is due for hepatitis B vaccination
Client is due for hepatitis B vaccination Guidance
Client is not due for a hepatitis B vaccination Case 1
Client is not due for a hepatitis B vaccination Case 2
Client is not due for a hepatitis B vaccination Case 3
Client is not due for a hepatitis B vaccination
Client is not due for a hepatitis B vaccination Guidance
Client is due for a hepatitis B vaccination Case 1
Client is due for a hepatitis B vaccination Case 2
Client is due for a hepatitis B vaccination
Client is due for a hepatitis B vaccination Guidance
Hepatitis B immunization schedule is complete
Hepatitis B immunization schedule is complete Guidance