Title: IMMZD2DTCholeraWCLogic Id: IMMZD2DTCholeraWCLogic Version: 0.2.0 Url: IMMZD2DTCholeraWCLogic Status: draft Experimental: true Type: system: http://terminology.hl7.org/CodeSystem/library-type code: logic-library Date: 2025-07-02 07:24:46+0000 Publisher: WHO Description: This library defines decision support logic for the IMMZ.D2.DT.Cholera.WC vaccines decision table in the Immunization CPG Related Artifacts: Dependencies IMMZD2DTCholeraEncounterElements Parameters: Name Type Min Max In/Out Today date 0 1 In Patient Patient 0 1 Out Client is not due for cholera vaccination Case 1 boolean 0 1 Out Client is not due for cholera vaccination Case 2 boolean 0 1 Out Client is not due for cholera vaccination boolean 0 1 Out Client is not due for cholera vaccination Guidance string 0 1 Out Client is due for cholera vaccination Case 1 boolean 0 1 Out Client is due for cholera vaccination Case 2 boolean 0 1 Out Client is due for cholera vaccination Case 3 boolean 0 1 Out Client is due for cholera vaccination boolean 0 1 Out Client is due for cholera vaccination Guidance string 0 1 Out Primary series is complete. Client is not due for cholera booster dose boolean 0 1 Out Primary series is complete. Client is not due for cholera booster dose Guidance string 0 1 Out Primary series is complete. Client is due for cholera booster dose boolean 0 1 Out Primary series is complete. Client is due for cholera booster dose Guidance string 0 1 Out Client is not due for cholera booster dose boolean 0 1 Out Client is not due for cholera booster dose Guidance string 0 1 Out Client is due for cholera booster dose boolean 0 1 Out Client is due for cholera booster dose Guidance string 0 1 Out Booster series is complete boolean 0 1 Out Booster series 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: IMMZD2DTCholeraWCLogic (IMMZ.D2.DT.Cholera.WC vaccines) * Rule: Determine if the client is due for a cholera vaccination according to the national immunization schedule * Decision Table: Whole-cell (WC) vaccines schedule * Trigger: IMMZ.D2 Determine required vaccination(s) if any */ library IMMZD2DTCholeraWCLogic using FHIR version '4.0.1' include FHIRHelpers version '4.0.1' include IMMZD2DTCholeraEncounterElements called Encounter parameter Today Date default Today() context Patient /* @dynamicValue: Guidance */ define "Guidance": case when "Client is not due for cholera vaccination" then "Client is not due for cholera vaccination Guidance" when "Client is due for cholera vaccination" then "Client is due for cholera vaccination Guidance" when "Primary series is complete. Client is not due for cholera booster dose" then "Primary series is complete. Client is not due for cholera booster dose Guidance" when "Primary series is complete. Client is due for cholera booster dose" then "Primary series is complete. Client is due for cholera booster dose Guidance" when "Client is not due for cholera booster dose" then "Client is not due for cholera booster dose Guidance" when "Client is due for cholera booster dose" then "Client is due for cholera booster dose Guidance" when "Booster series is complete" then "Booster series is complete Guidance" else '' end define "Has Guidance": "Guidance" is not null and "Guidance" != '' /* @output: Client is not due for cholera vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for cholera vaccination Case 1": Encounter."Client's age is less than 1 year" /* @output: Client is not due for cholera vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for cholera vaccination Case 2": Encounter."Client's age is more than or equal to 1 year" and Encounter."One cholera primary series dose was administered" and Encounter."The latest cholera dose was administered less than 14 days ago" /* @output: Client is not due for cholera vaccination @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for cholera vaccination": "Client is not due for cholera vaccination Case 1" or "Client is not due for cholera vaccination Case 2" /* @output: Client is not due for cholera vaccination Guidance @guidance: Should not vaccinate client with cholera dose as client's age is under 1 year. Check for any vaccines due and inform the caregiver of when to come back for the first cholera dose. @guidance: Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose. */ define "Client is not due for cholera vaccination Guidance": case when "Client is not due for cholera vaccination Case 1" then 'Should not vaccinate client with cholera dose as client\'s age is under 1 year. Check for any vaccines due and inform the caregiver of when to come back for the first cholera dose.' when "Client is not due for cholera vaccination Case 2" then 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose.' else '' end /* @output: Client is due for cholera vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for cholera vaccination Case 1": Encounter."Client's age is more than or equal to 1 year" and Encounter."No cholera primary series dose was administered" /* @output: Client is due for cholera vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for cholera vaccination Case 2": Encounter."Client's age is more than or equal to 1 year" and Encounter."One cholera primary series dose was administered" and Encounter."The latest cholera dose was administered more than 14 days ago" /* @output: Client is due for cholera vaccination Case 3 @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for cholera vaccination Case 3": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."At least one booster series dose was administered" and Encounter."The latest cholera dose was administered more than 3 years ago" /* @output: Client is due for cholera vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for cholera vaccination": "Client is due for cholera vaccination Case 1" or "Client is due for cholera vaccination Case 2" or "Client is due for cholera vaccination Case 3" /* @output: Client is due for cholera vaccination Guidance @guidance: Should vaccinate client with cholera dose as no doses have been given. @guidance: Should vaccinate client with cholera dose as the latest cholera dose was administered more than 14 days ago. Check for contraindications. @guidance: Should vaccinate client with cholera dose as the booster series for cholera was completed more than 3 years ago. Check for contraindications. */ define "Client is due for cholera vaccination Guidance": case when "Client is due for cholera vaccination Case 1" then 'Should vaccinate client with cholera dose as no doses have been given. ' when "Client is due for cholera vaccination Case 2" then 'Should vaccinate client with cholera dose as the latest cholera dose was administered more than 14 days ago. Check for contraindications.' when "Client is due for cholera vaccination Case 3" then 'Should vaccinate client with cholera dose as the booster series for cholera was completed more than 3 years ago. Check for contraindications. ' else '' end /* @output: Primary series is complete. Client is not due for cholera booster dose @pseudocode: "Immunization recommendation status" = "Not due" */ define "Primary series is complete. Client is not due for cholera booster dose": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."No cholera booster series dose was administered" and Encounter."The latest cholera dose was administered less than 3 years ago" /* @output: Primary series is complete. Client is not due for cholera booster dose Guidance @guidance: Should not vaccinate client with cholera booster dose as primary series was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the first booster dose. */ define "Primary series is complete. Client is not due for cholera booster dose Guidance": 'Should not vaccinate client with cholera booster dose as primary series was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the first booster dose.' /* @output: Primary series is complete. Client is due for cholera booster dose @pseudocode: "Immunization recommendation status" = "Due" */ define "Primary series is complete. Client is due for cholera booster dose": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."No cholera booster series dose was administered" and Encounter."The latest cholera dose was administered more than 3 years ago" /* @output: Primary series is complete. Client is due for cholera booster dose Guidance @guidance: Should vaccinate client with cholera dose as the primary series for cholera was completed more than 3 years ago. Check for contraindications. */ define "Primary series is complete. Client is due for cholera booster dose Guidance": 'Should vaccinate client with cholera dose as the primary series for cholera was completed more than 3 years ago. Check for contraindications. ' /* @output: Client is not due for cholera booster dose @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for cholera booster dose": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."At least one booster series dose was administered" and Encounter."Dose number of the latest dose is one" and Encounter."The latest cholera dose was administered less than 14 days ago" /* @output: Client is not due for cholera booster dose Guidance @guidance: Should not vaccinate client with cholera booster dose as the latest dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose. */ define "Client is not due for cholera booster dose Guidance": 'Should not vaccinate client with cholera booster dose as the latest dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose.' /* @output: Client is due for cholera booster dose @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for cholera booster dose": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."At least one booster series dose was administered" and Encounter."Dose number of the latest dose is one" and Encounter."The latest cholera dose was administered more than 14 days ago and less than 3 years ago" /* @output: Client is due for cholera booster dose Guidance @guidance: Should vaccinate client with cholera booster dose as the booster series is not completed and the latest cholera dose was administered more than 14 days ago. Check for contraindications. */ define "Client is due for cholera booster dose Guidance": 'Should vaccinate client with cholera booster dose as the booster series is not completed and the latest cholera dose was administered more than 14 days ago. Check for contraindications. ' /* @output: Booster series is complete @pseudocode: "Completed the booster series" (where "Vaccine type" = "Cholera vaccines") = TRUE */ define "Booster series is complete": Encounter."Client's age is more than or equal to 1 year" and Encounter."Two cholera primary series doses were administered" and Encounter."At least one booster series dose was administered" and Encounter."Dose number of the latest dose is two" and Encounter."The latest cholera dose was administered less than 3 years ago" /* @output: Booster series is complete Guidance @guidance: Should not vaccinate client with cholera dose as the booster series for cholera was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the next booster series. */ define "Booster series is complete Guidance": 'Should not vaccinate client with cholera dose as the booster series for cholera was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the next booster series.' /* @test: Test expected results based on example patients */ define "Test Validation": case when Patient.id = '08.0' then "Client is not due for cholera vaccination Case 1" and "Guidance" = 'Should not vaccinate client with cholera dose as client\'s age is under 1 year. Check for any vaccines due and inform the caregiver of when to come back for the first cholera dose.' when Patient.id = '09.01' then "Client is due for cholera vaccination Case 1" and "Guidance" = 'Should vaccinate client with cholera dose as no doses have been given. ' when Patient.id = '10.014' then "Client is not due for cholera vaccination Case 2" and "Guidance" = 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose.' when Patient.id = '11.014' then "Client is due for cholera vaccination Case 2" and "Guidance" = 'Should vaccinate client with cholera dose as the latest cholera dose was administered more than 14 days ago. Check for contraindications.' when Patient.id = '12.0124' then "Primary series is complete. Client is not due for cholera booster dose" and "Guidance" = 'Should not vaccinate client with cholera booster dose as primary series was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the first booster dose.' when Patient.id = '13.0124' then "Primary series is complete. Client is due for cholera booster dose" and "Guidance" = 'Should vaccinate client with cholera dose as the primary series for cholera was completed more than 3 years ago. Check for contraindications. ' when Patient.id = '14.01234' then "Client is not due for cholera booster dose" and "Guidance" = 'Should not vaccinate client with cholera booster dose as the latest dose was administered less than 14 days ago. Check for any vaccines due and inform the caregiver of when to come back for the next dose.' when Patient.id = '15.01234' then "Client is due for cholera booster dose" and "Guidance" = 'Should vaccinate client with cholera booster dose as the booster series is not completed and the latest cholera dose was administered more than 14 days ago. Check for contraindications. ' when Patient.id = '16.01234' then "Booster series is complete" and "Guidance" = 'Should not vaccinate client with cholera dose as the booster series for cholera was completed less than 3 years ago. Check for any vaccines due and inform the caregiver of when to come back for the next booster series.' when Patient.id = '17.0124' then "Client is due for cholera vaccination Case 3" and "Guidance" = 'Should vaccinate client with cholera dose as the booster series for cholera was completed more than 3 years ago. Check for contraindications. ' else 'No test case set' end Content: application/elm+xml Encoded data (141180 characters)
This library defines decision support logic for the IMMZ.D2.DT.Cholera.WC vaccines decision table in the Immunization CPG
Client is not due for cholera vaccination Case 1
Client is not due for cholera vaccination Case 2
Client is not due for cholera vaccination
Client is not due for cholera vaccination Guidance
Client is due for cholera vaccination Case 1
Client is due for cholera vaccination Case 2
Client is due for cholera vaccination Case 3
Client is due for cholera vaccination Guidance
Primary series is complete. Client is not due for cholera booster dose
Primary series is complete. Client is not due for cholera booster dose Guidance
Primary series is complete. Client is due for cholera booster dose
Primary series is complete. Client is due for cholera booster dose Guidance
Client is not due for cholera booster dose
Client is not due for cholera booster dose Guidance
Client is due for cholera booster dose Guidance