{ "resourceType": "Library", "id": "IMMZD18SCholeraWCRBSVaccine2DosesLogic", "meta": { "profile": [ "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary", "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary", "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library", "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module" ] }, "text": { "status": "extensions", "div": "
\n
\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Title: IMMZD18SCholeraWCRBSVaccine2DosesLogic
Id: IMMZD18SCholeraWCRBSVaccine2DosesLogic
Version: 0.2.0
Url: IMMZD18SCholeraWCRBSVaccine2DosesLogic
Status: draft
Type: \n \n \n \n

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

\n \n \n

\n code: logic-library\n

\n \n \n \n \n \n
Date: 2026-03-29 17:23:09+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D18.S.Cholera.WC-rBS vaccine 2-dose schedule table in the Immunization CPG

\n
Related Artifacts: \n \n \n \n

Dependencies

\n \n \n \n \n \n \n
Parameters: \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Cholera dose 1boolean01Out
Cholera dose 1 Due Datedate01Out
Cholera dose 1 Createstring01Out
Cholera dose 1 OverdueResource01Out
Cholera dose 1 ExpirationResource01Out
First cholera dose was administeredboolean01Out
Cholera dose 2 Expirationdate01Out
Second cholera dose was administeredboolean01Out
Cholera dose 2boolean01Out
Cholera dose 2 Due Datedate01Out
Cholera dose 2 Createstring01Out
Cholera dose 2 OverdueResource01Out
Cholera booster doseboolean01Out
Cholera booster dose Due Datedate01Out
Cholera booster dose Expirationdate01Out
Cholera booster dose Createstring01Out
Cholera booster dose OverdueResource01Out
Booster dose was administered approximately less than 2 years agoboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SCholeraWCRBSVaccine2DosesLogic (IMMZ.D18.S.Cholera.WC-rBS vaccine 2-dose schedule)\n * Schedule Table: Whole cell-recombinant B subunit (WC-rBS) vaccine (Dukoral), 2-dose schedule for clients aged ≥ 6 years\n */\nlibrary IMMZD18SCholeraWCRBSVaccine2DosesLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude WHOCommon called WC\n\ninclude IMMZCommon called Common\ninclude IMMZConcepts called Concepts\n\ninclude IMMZEncounterElements called IE\ninclude IMMZD2DTCholeraEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: Cholera dose 1\n@description: Provision of the cholera dose 1\n@trigger: Child's birth\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines") = 0 AND (Today's date − "Date of birth" ≥ 6 years)\nOR Primary series interrupted for 6 or more weeks\n"Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = FALSE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ≥ 6 weeks AND (Today's date − "Date of birth" ≥ 6 years)\nOR more than 6 months have passed since completion of primary vaccination series\n"Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") > 2 years AND (Today's date − "Date of birth" ≥ 6 years)\n@triggerDate: "Date of birth"\nOR\nLatest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\n*/\ndefine "Cholera dose 1":\n  Encounter."Client's age is more than 5 years"\n  and ( Encounter."No cholera primary series dose was administered"\n  or ( not Encounter."Dose number of the latest primary series dose is more than or equal to two"\n    and Encounter."The latest cholera dose was administered more than 6 weeks ago"\n  ) or Encounter."The latest cholera dose was administered approximately more than 2 years ago {Member States defined interval}"\n  )\n\n\n/*\n@output: Cholera dose 1 Create\n@create: For WC-rBS vaccine (Dukoral), 2 doses should be given to children aged ≥ 6 years and adults, with an interval of 1–6 weeks between doses. If the interval since the last dose ≥ 6 weeks, restart the primary series.\n\nRevaccination for those aged ≥ 6 years: If more than 2 years have passed since completion of primary vaccination series, the primary series of 2 doses should be repeated.\n*/\ndefine "Cholera dose 1 Create":\n  if "Cholera dose 1"\n  then 'For WC-rBS vaccine (Dukoral), 2 doses should be given to children aged ≥ 6 years and adults, with an interval of 1–6 weeks between doses. If the interval since the last dose ≥ 6 weeks, restart the primary series.\nRevaccination for those aged ≥ 6 years: If more than 2 years have passed since completion of primary vaccination series, the primary series of 2 doses should be repeated.' + '\nDue Date: ' + ToString("Cholera dose 1 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Cholera dose 1 Due Date\n@pseudocode: "Date of birth" + 2 years\n*/\ndefine "Cholera dose 1 Due Date":\n  if "Cholera dose 1" then\n    case when Encounter."No cholera primary series dose was administered" then Patient.birthDate + 2 years\n      when not Encounter."Dose number of the latest primary series dose is more than or equal to two"\n        and Encounter."The latest cholera dose was administered more than 6 weeks ago" then Today\n      when Encounter."The latest cholera dose was administered approximately more than 2 years ago {Member States defined interval}" then Encounter."Date of Latest Cholera Dose" + 2 years\n      else null\n    end\n  else null\n\n\n/*\n@dynamicValue: Cholera dose 1 Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Cholera dose 1 Overdue":\n  null\n\n\n/*\n@dynamicValue: Cholera dose 1 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Cholera dose 1 Expiration":\n  null\n\n  \n/*\n@complete: First cholera dose was administered\n@pseudocode: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 1\n*/\ndefine "First cholera dose was administered":\n  Encounter."Dose number of the latest primary series dose is one"\n\n\n\n/*\n@output: Cholera dose 2\n@description: Provision of the cholera dose 2\n@trigger: First cholera dose was administered\n@pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 1 AND (Today's date − "Date of birth" ≥ 6 years)\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\n*/\ndefine "Cholera dose 2":\n  Encounter."Client's age is more than 5 years"\n  and "Cholera dose 2 Expiration" after day of Today\n  and "First cholera dose was administered"\n  and not "Second cholera dose was administered"\n\n\n/*\n@output: Cholera dose 2 Create\n@create: For WC-rBS vaccine (Dukoral) 2 doses should be given to children aged ≥6 years and adults, with an interval of 1-6 weeks between doses.\n*/\ndefine "Cholera dose 2 Create":\n  if "Cholera dose 2"\n  then 'For WC-rBS vaccine (Dukoral)  2 doses should be given to children aged ≥6 years and adults, with an interval of 1-6 weeks between doses.' + '\nDue Date: ' + ToString("Cholera dose 2 Due Date") + '\nExpiration: ' + ToString("Cholera dose 2 Expiration")\n  else ''\n\n\n/*\n@dynamicValue: Cholera dose 2 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 1 week\n*/\ndefine "Cholera dose 2 Due Date":\n  if "Cholera dose 2" then Encounter."Date of Latest Cholera Dose" + 1 week\n  else null\n\n\n/*\n@dynamicValue: Cholera dose 2 Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Cholera dose 2 Overdue":\n  null\n\n\n/*\n@dynamicValue: Cholera dose 2 Expiration\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 6 weeks\n*/\ndefine "Cholera dose 2 Expiration":\n  Encounter."Date of Latest Cholera Dose" + 6 weeks\n\n  \n/*\n@complete: Second cholera dose was administered\n@pseudocode: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 2\n*/\ndefine "Second cholera dose was administered":\n  Encounter."Dose number of the latest primary series dose is two"\n\n\n\n/*\n@output: Cholera booster dose\n@description: Provision of the cholera booster dose\n@trigger: Primary series for cholera has been completed and latest cholera dose was administered approximately less than 2 years ago\n@pseudo: "Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ≤ 2 years ± Member States defined interval AND (Today's date − "Date of birth" ≥ 6 years)\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\n*/\ndefine "Cholera booster dose":\n  "Second cholera dose was administered"\n  and not Encounter."The latest cholera dose was administered approximately more than 2 years ago {Member States defined interval}"\n\n\n/*\n@output: Cholera booster dose Create\n@create: For WC-rBS vaccine, for those aged ≥ 6 years of age, if less than 2 years have passed since completion of primary vaccination series, 1 dose for revaccination.\n*/\ndefine "Cholera booster dose Create":\n  if "Cholera booster dose"\n  then 'For WC-rBS vaccine, for those aged ≥ 6 years of age, if less than 2 years have passed since completion of primary vaccination series, 1 dose for revaccination.' + '\nDue Date: ' + ToString("Cholera booster dose Due Date") + '\nExpiration: ' + ToString("Cholera booster dose Expiration")\n  else ''\n\n\n/*\n@dynamicValue: Cholera booster dose Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ± Member States defined interval\n*/\ndefine "Cholera booster dose Due Date":\n  if "Cholera booster dose" then Encounter."Date of Latest Cholera Dose" + 22 months\n  else null\n\n\n/*\n@dynamicValue: Cholera booster dose Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "Cholera booster dose Overdue":\n  null\n\n\n/*\n@dynamicValue: Cholera booster dose Expiration\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 2 years + Member states defined interval\n*/\ndefine "Cholera booster dose Expiration":\n  if "Cholera booster dose" then Encounter."Date of Latest Cholera Dose" + 2 years\n  else null\n\n  \n/*\n@complete: Booster dose was administered approximately less than 2 years ago\n@pseudocode: Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines" AND "Type of dose" = "Booster dose") ≤ 2 years ± Member States defined interval\n*/\ndefine "Booster dose was administered approximately less than 2 years ago":\n  not Encounter."The latest cholera dose was administered approximately more than 2 years ago {Member States defined interval}"\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Cholera44.2' then "Cholera dose 1"\n    when Patient.id = 'Cholera45.4' then "Cholera dose 2"\n    when Patient.id = 'Cholera46.4' then "Cholera dose 2"\n    when Patient.id = 'Cholera47.4' then "Cholera dose 1"\n    when Patient.id = 'Cholera48.4' then "Cholera booster dose"\n    when Patient.id = 'Cholera49.4' then "Cholera dose 1"\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (98412 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SCholeraWCRBSVaccine2DosesLogic", "version": "0.2.0", "name": "IMMZD18SCholeraWCRBSVaccine2DosesLogic", "title": "IMMZD18SCholeraWCRBSVaccine2DosesLogic", "status": "draft", "experimental": false, "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/library-type", "code": "logic-library" } ] }, "date": "2026-03-29T17:23:09+00:00", "publisher": "WHO", "contact": [ { "name": "WHO", "telecom": [ { "system": "url", "value": "http://who.int" } ] } ], "description": "This library defines decision support logic for the IMMZ.D18.S.Cholera.WC-rBS vaccine 2-dose schedule table in the Immunization CPG", "relatedArtifact": [ { "type": "depends-on", "display": "Library WC", "resource": "http://smart.who.int/immunizations/Library/WHOCommon" }, { "type": "depends-on", "display": "Library Common", "resource": "http://smart.who.int/immunizations/Library/IMMZCommon" }, { "type": "depends-on", "display": "Library Concepts", "resource": "http://smart.who.int/immunizations/Library/IMMZConcepts" }, { "type": "depends-on", "display": "Library IE", "resource": "http://smart.who.int/immunizations/Library/IMMZEncounterElements" }, { "type": "depends-on", "display": "Library Encounter", "resource": "http://smart.who.int/immunizations/Library/IMMZD2DTCholeraEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "Cholera dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Cholera dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Cholera dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Cholera dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Cholera dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "First cholera dose was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Cholera dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Second cholera dose was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Cholera dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Cholera dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Cholera dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Cholera dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Cholera booster dose", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Cholera booster dose Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Cholera booster dose Expiration", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Cholera booster dose Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Cholera booster dose Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Booster dose was administered approximately less than 2 years ago", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Test Validation", "use": "out", "min": 0, "max": "1", "type": "Resource" } ], "content": [ { "contentType": "text/cql", "url": "Library-IMMZD18SCholeraWCRBSVaccine2DosesLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SCholeraWCRBSVaccine2DosesLogic.elm.xml" } ] }