Title: IMMZD2DTHepatitisAInactivatedHAV2DosesLogic Id: IMMZD2DTHepatitisAInactivatedHAV2DosesLogic Version: 0.2.0 Url: IMMZD2DTHepatitisAInactivatedHAV2DosesLogic Status: draft Type: system: http://terminology.hl7.org/CodeSystem/library-type code: logic-library Date: 2025-12-05 23:35:21+0000 Publisher: WHO Description: This library defines decision support logic for the IMMZ.D2.DT.Hepatitis A.Inactivated HAV 2 doses decision table in the Immunization CPG Related Artifacts: Dependencies IMMZD2DTHepatitisAEncounterElements Parameters: Name Type Min Max In/Out Today date 0 1 In Patient Patient 0 1 Out Client is not due for Hepatitis A vaccination Case 1 boolean 0 1 Out Client is not due for Hepatitis A vaccination Case 2 boolean 0 1 Out Client is not due for Hepatitis A vaccination boolean 0 1 Out Client is not due for Hepatitis A vaccination Guidance string 0 1 Out Client is due for Hepatitis A vaccination Case 1 boolean 0 1 Out Client is due for Hepatitis A vaccination Case 2 boolean 0 1 Out Client is due for Hepatitis A vaccination boolean 0 1 Out Client is due for Hepatitis A vaccination Guidance string 0 1 Out Hepatitis A immunization schedule is complete boolean 0 1 Out Hepatitis A 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: IMMZD2DTHepatitisAInactivatedHAV2DosesLogic (IMMZ.D2.DT.Hepatitis A.Inactivated HAV 2 doses) * Rule: Determine if the client is due for a hepatitis A vaccination according to the national immunization schedule * Decision Table: Inactivated hepatitis A virus (HAV), 2-dose schedule * Trigger: IMMZ.D2 Determine required vaccination(s) if any */ library IMMZD2DTHepatitisAInactivatedHAV2DosesLogic using FHIR version '4.0.1' include FHIRHelpers version '4.0.1' include IMMZD2DTHepatitisAEncounterElements called Encounter parameter Today Date default Today() context Patient /* @dynamicValue: Guidance */ define "Guidance": case when "Client is not due for Hepatitis A vaccination" then "Client is not due for Hepatitis A vaccination Guidance" when "Client is due for Hepatitis A vaccination" then "Client is due for Hepatitis A vaccination Guidance" when "Hepatitis A immunization schedule is complete" then "Hepatitis A immunization schedule is complete Guidance" else '' end define "Has Guidance": "Guidance" is not null and "Guidance" != '' /* @output: Client is not due for Hepatitis A vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for Hepatitis A vaccination Case 1": Encounter."Client's age is less than 12 months" /* @output: Client is not due for Hepatitis A vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for Hepatitis A vaccination Case 2": Encounter."One hepatitis A primary series dose was administered" and Encounter."The latest Hepatitis A dose was administered less than 6 months ago" /* @output: Client is not due for Hepatitis A vaccination @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for Hepatitis A vaccination": "Client is not due for Hepatitis A vaccination Case 1" or "Client is not due for Hepatitis A vaccination Case 2" /* @output: Client is not due for Hepatitis A vaccination Guidance @guidance = Should not vaccinate client with first hepatitis A dose as client's age is less than 12 months. Check for any other vaccines due and inform the caregiver of when to come back for the first dose. @guidance = Should not vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered less than 6 months ago. Check for any vaccines due and inform the caregiver of when to come back for the second dose. */ define "Client is not due for Hepatitis A vaccination Guidance": case when "Client is not due for Hepatitis A vaccination Case 1" then 'Should not vaccinate client with first hepatitis A dose as client\'s age is less than 12 months. Check for any other vaccines due and inform the caregiver of when to come back for the first dose.' when "Client is not due for Hepatitis A vaccination Case 2" then 'Should not vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered less than 6 months ago. Check for any vaccines due and inform the caregiver of when to come back for the second dose.' else '' end /* @output: Client is due for Hepatitis A vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for Hepatitis A vaccination Case 1": Encounter."No hepatitis A primary series doses were administered" and Encounter."Client's age is more than or equal to 12 months" /* @output: Client is due for Hepatitis A vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for Hepatitis A vaccination Case 2": Encounter."One hepatitis A primary series dose was administered" and Encounter."The latest Hepatitis A dose was administered more than 6 months ago" /* @output: Client is due for Hepatitis A vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for Hepatitis A vaccination": "Client is due for Hepatitis A vaccination Case 1" or "Client is due for Hepatitis A vaccination Case 2" /* @output: Client is due for Hepatitis A vaccination Guidance @guidance = Should vaccinate client with first hepatitis A dose as no Hepatitis A doses were administered and client is within the appropriate age range. Check for contraindications. @guidance = Should vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered more than 6 months ago. Check for contraindications. */ define "Client is due for Hepatitis A vaccination Guidance": case when "Client is due for Hepatitis A vaccination Case 1" then 'Should vaccinate client with first hepatitis A dose as no Hepatitis A doses were administered and client is within the appropriate age range. Check for contraindications.' when "Client is due for Hepatitis A vaccination Case 2" then 'Should vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered more than 6 months ago. Check for contraindications.' else '' end /* @output: Hepatitis A immunization schedule is complete @pseudocode: "Immunization recommendation status" = "Complete" "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hepatitis A-containing vaccines") */ define "Hepatitis A immunization schedule is complete": Encounter."Two hepatitis A primary series doses were administered" /* @output: Hepatitis A immunization schedule is complete Guidance @guidance: Hepatitis A immunization schedule is complete. Two hepatitis A primary series doses were administered. Check for any other vaccines due. */ define "Hepatitis A immunization schedule is complete Guidance": 'Hepatitis A immunization schedule is complete. Two hepatitis A 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 = 'HepatitisA08.1' then "Client is not due for Hepatitis A vaccination Case 1" and "Guidance" = 'Should not vaccinate client with first hepatitis A dose as client\'s age is less than 12 months. Check for any other vaccines due and inform the caregiver of when to come back for the first dose.' when Patient.id = 'HepatitisA09.2' then "Client is due for Hepatitis A vaccination Case 1" and "Guidance" = 'Should vaccinate client with first hepatitis A dose as no Hepatitis A doses were administered and client is within the appropriate age range. Check for contraindications.' when Patient.id = 'HepatitisA10.2' then "Client is not due for Hepatitis A vaccination Case 2" and "Guidance" = 'Should not vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered less than 6 months ago. Check for any vaccines due and inform the caregiver of when to come back for the second dose.' when Patient.id = 'HepatitisA11.2' then "Client is due for Hepatitis A vaccination Case 2" and "Guidance" = 'Should vaccinate client with second hepatitis A dose as the latest hepatitis A dose was administered more than 6 months ago. Check for contraindications.' when Patient.id = 'HepatitisA12.1' then "Hepatitis A immunization schedule is complete" and "Guidance" = 'Hepatitis A immunization schedule is complete. Two hepatitis A primary series doses were administered. Check for any other vaccines due.' else 'No test case set' end Content: application/elm+xml Encoded data (67296 characters)
This library defines decision support logic for the IMMZ.D2.DT.Hepatitis A.Inactivated HAV 2 doses decision table in the Immunization CPG
Client is not due for Hepatitis A vaccination Case 1
Client is not due for Hepatitis A vaccination Case 2
Client is not due for Hepatitis A vaccination
Client is not due for Hepatitis A vaccination Guidance
Client is due for Hepatitis A vaccination Case 1
Client is due for Hepatitis A vaccination Case 2
Client is due for Hepatitis A vaccination
Client is due for Hepatitis A vaccination Guidance
Hepatitis A immunization schedule is complete
Hepatitis A immunization schedule is complete Guidance