WHO Immunization Implementation Guide
0.2.0 - ci-build

WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions

Library: IMMZD2DTCholerarBS2to5Logic

Official URL: http://smart.who.int/immunizations/Library/IMMZD2DTCholerarBS2to5Logic Version: 0.2.0
Draft as of 2025-09-17 Computable Name: IMMZD2DTCholerarBS2to5Logic

This library defines decision support logic for the IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses decision table in the Immunization CPG

Title: IMMZD2DTCholerarBS2to5Logic
Id: IMMZD2DTCholerarBS2to5Logic
Version: 0.2.0
Url: IMMZD2DTCholerarBS2to5Logic
Status: draft
Type:

system: http://terminology.hl7.org/CodeSystem/library-type

code: logic-library

Date: 2025-09-17 23:03:28+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses decision table in the Immunization CPG

Related Artifacts:

Dependencies

Parameters:
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is not due for cholera vaccination Case 1boolean01Out
Client is not due for cholera vaccination Case 2boolean01Out
Client is not due for cholera vaccination Case 3boolean01Out
Client is not due for cholera vaccinationboolean01Out
Client is not due for cholera vaccination Guidancestring01Out
Client is due for cholera vaccination Case 1boolean01Out
Client is due for cholera vaccination Case 2boolean01Out
Client is due for cholera vaccination Case 3boolean01Out
Client is due for cholera vaccination Case 4boolean01Out
Client is due for cholera vaccination Case 5boolean01Out
Client is due for cholera vaccinationboolean01Out
Client is due for cholera vaccination Guidancestring01Out
Primary series is complete. Client is not due for cholera booster doseboolean01Out
Primary series is complete. Client is not due for cholera booster dose Guidancestring01Out
Primary series is complete. Client is due for cholera booster doseboolean01Out
Primary series is complete. Client is due for cholera booster dose Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
Content: text/cql

/*
 * Library: IMMZD2DTCholerarBS2to5Logic (IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses)
 * Rule: Determine if the client is due for a cholera vaccination according to the national immunization schedule
 * Decision Table: Whole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years
 * Trigger: IMMZ.D2 Determine required vaccination(s) if any  
 */
library IMMZD2DTCholerarBS2to5Logic

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"
    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 2 years"

/*
@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 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is one"
    and Encounter."The latest cholera dose was administered less than 1 week ago"

/*
@output: Client is not due for cholera vaccination Case 3
@pseudocode: "Immunization recommendation status" = "Not due"
*/
define "Client is not due for cholera vaccination Case 3":
  Encounter."Client's age is 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is two"
    and Encounter."The latest cholera dose was administered less than 1 week 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"
    or "Client is not due for cholera vaccination Case 3"

/*
@output: Client is not due for cholera vaccination Guidance
@guidance: Should not vaccinate client with cholera dose as client's age is less than 2 years.
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 1 week ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.
@guidance: Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week 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 less than 2 years.
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 1 week ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when "Client is not due for cholera vaccination Case 3" then 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week 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 2–5 years"
    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 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is one"
    and Encounter."The latest cholera dose was administered more than 1 week and less than 6 weeks 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 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is two"
    and Encounter."The latest cholera dose was administered more than 1 week and less than 6 weeks ago"

/*
@output: Client is due for cholera vaccination Case 4
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for cholera vaccination Case 4":
  Encounter."Client's age is 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is less than three"
    and Encounter."The latest cholera dose was administered more than 6 weeks ago"

/*
@output: Client is due for cholera vaccination Case 5
@pseudocode: "Immunization recommendation status" = "Due"
*/
define "Client is due for cholera vaccination Case 5":
  Encounter."Client's age is 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is three"
    and Encounter."The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}"

/*
@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"
    or "Client is due for cholera vaccination Case 4"
    or "Client is due for cholera vaccination Case 5"

/*
@output: Client is due for cholera vaccination Guidance
@guidance: Should vaccinate client with cholera dose as no cholera doses have been administered.
Check for contraindications.
@guidance: Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.
@guidance: Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.
@guidance: Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than 6 weeks ago.
Check for contraindications.
@guidance: Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than approximately 6 months 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 cholera doses have been administered.
Check for contraindications.'
    when "Client is due for cholera vaccination Case 2" then 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.'
    when "Client is due for cholera vaccination Case 3" then 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.'
    when "Client is due for cholera vaccination Case 4" then 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than 6 weeks ago.
Check for contraindications.'
    when "Client is due for cholera vaccination Case 5" then 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than approximately 6 months 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 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is three"
    and Encounter."The latest cholera dose was administered less than {Member States defined lower limit} days ago"

/*
@output: Primary series is complete. Client is not due for cholera booster dose Guidance
@guidance: Should not vaccinate client with cholera dose as the latest cholera dose was administered less than {Member States defined lower limit} days ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.
*/
define "Primary series is complete. Client is not due for cholera booster dose Guidance":
  'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than {Member States defined lower limit} days ago.
Check for any vaccines due and inform the caregiver of when to come back for the next 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 2–5 years"
    and Encounter."At least one cholera primary series dose was administered"
    and Encounter."Dose number of the latest primary series dose is three"
    and Encounter."The latest cholera dose was administered approximately less than 6 months ago {Member States defined exact interval}"

/*
@output: Primary series is complete. Client is due for cholera booster dose Guidance
@guidance: Should vaccinate client with cholera booster dose as the latest cholera dose was administered less than approximately 6 months ago.
Check for contraindications.
*/
define "Primary series is complete. Client is due for cholera booster dose Guidance":
  'Should vaccinate client with cholera booster dose as the latest cholera dose was administered less than approximately 6 months ago.
Check for contraindications.'


/*
@test: Test expected results based on example patients
*/
define "Test Validation":
  case
    when Patient.id = '25.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 less than 2 years.
Check for any vaccines due and inform the caregiver of when to come back for the first cholera dose.'
    when Patient.id = '26.01' then "Client is due for cholera vaccination Case 1" and "Guidance" = 'Should vaccinate client with cholera dose as no cholera doses have been administered.
Check for contraindications.'
    when Patient.id = '27.0123' 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 1 week ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when Patient.id = '28.0123' then "Client is due for cholera vaccination Case 2" and "Guidance" = 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.'
    when Patient.id = '29.0123' then "Client is not due for cholera vaccination Case 3" and "Guidance" = 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when Patient.id = '30.0123' then "Client is due for cholera vaccination Case 3" and "Guidance" = 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.
Check for contraindications.'
    when Patient.id = '31.0123' then "Client is due for cholera vaccination Case 4" and "Guidance" = 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than 6 weeks ago.
Check for contraindications.'
    when Patient.id = '32.0123' then "Primary series is complete. Client is not due for cholera booster dose" and "Guidance" = 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than {Member States defined lower limit} days ago.
Check for any vaccines due and inform the caregiver of when to come back for the next dose.'
    when Patient.id = '33.0123' then "Primary series is complete. Client is due for cholera booster dose" and "Guidance" = 'Should vaccinate client with cholera booster dose as the latest cholera dose was administered less than approximately 6 months ago.
Check for contraindications.'
    when Patient.id = '34.0123' then "Client is due for cholera vaccination Case 5" and "Guidance" = 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than approximately 6 months ago.
Check for contraindications.'
    else 'No test case set'
  end
Content: application/elm+xml
Encoded data (139836 characters)