{ "resourceType" : "PlanDefinition", "id" : "IMMZD18SCholeraWCVaccines", "meta" : { "profile" : ["http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-recommendationdefinition", "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableplandefinition", "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableplandefinition"] }, "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
Id: IMMZD18SCholeraWCVaccines
Url: IMMZ.D18.S.Cholera.WC vaccines schedule
Version: 0.2.0
Title: IMMZ.D18.S.Cholera.WC vaccines schedule
Status: draft
Type: \n \n \n \n

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

\n \n \n

\n code: eca-rule\n

\n \n \n \n \n \n
Date: 2026-03-25 23:30:34+0000
Publisher: WHO
Description:

IMMZ.D18.S.Cholera.WC vaccines schedule\nWhole-cell (WC) vaccines (Shanchol, Euvchol and mORCVAX), 2-dose schedule

\n
Knowledge Capability: \n \n computable \n
Related Artifacts: \n \n \n

References

\n
    \n \n

  • WHO recommendations for routine immunization - summary tables (January 2025)

    \n

    • \n \n
\n \n \n \n \n \n \n
Libraries: \n \n \n \n \n \n \n
IMMZD18SCholeraWCVaccinesLogic
\n
Actions: \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n Cholera dose 1: Provision of the cholera dose 1\nTrigger event: Child's birth and no cholera doses have been administered\nTrigger pseudo: Child's birth AND Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 0\nTrigger date: "Date of birth"\nOR\nLatest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\nRevaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.\n \n
\n \n \n If:\n \n Applicability:\n \n Cholera dose 1\n \n (Cholera dose 1)\n
\n \n \n \n \n Then: Definition: IMMZ.D2.DT.CR
\n \n Dynamic Values:
\n \n status: ('active')\n
\n \n payload.contentString: (Cholera dose 1 Create)\n
\n \n category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })\n
\n \n priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })\n
\n \n \n \n \n
\n \n Cholera dose 2: Provision of the cholera dose 2\nTrigger event: First cholera dose administered\nTrigger pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Primary series") = 1\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\n \n
\n \n \n If:\n \n Applicability:\n \n Cholera dose 2\n \n (Cholera dose 2)\n
\n \n \n \n \n Then: Definition: IMMZ.D2.DT.CR
\n \n Dynamic Values:
\n \n status: ('active')\n
\n \n payload.contentString: (Cholera dose 2 Create)\n
\n \n category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })\n
\n \n priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })\n
\n \n \n \n \n
\n \n Cholera booster dose 1: Provision of the cholera booster dose 1\nTrigger event: Primary series for cholera has been completed and latest cholera dose was administered more than 3 years ago\nTrigger 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") ≥ 3 years\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.\n \n
\n \n \n If:\n \n Applicability:\n \n Cholera booster dose 1\n \n (Cholera booster dose 1)\n
\n \n \n \n \n Then: Definition: IMMZ.D2.DT.CR
\n \n Dynamic Values:
\n \n status: ('active')\n
\n \n payload.contentString: (Cholera booster dose 1 Create)\n
\n \n category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })\n
\n \n priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })\n
\n \n \n \n \n
\n \n Cholera booster dose 2: Provision of the cholera booster dose 1\nTrigger event: First cholera booster dose administered\nTrigger pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Booster dose") = 1\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.\n \n
\n \n \n If:\n \n Applicability:\n \n Cholera booster dose 2\n \n (Cholera booster dose 2)\n
\n \n \n \n \n Then: Definition: IMMZ.D2.DT.CR
\n \n Dynamic Values:
\n \n status: ('active')\n
\n \n payload.contentString: (Cholera booster dose 2 Create)\n
\n \n category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })\n
\n \n priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })\n
\n \n \n \n \n
\n
\n
\n
" }, "contained" : [{ "resourceType" : "Library", "id" : "effective-data-requirements", "extension" : [{ "extension" : [{ "url" : "libraryName", "valueString" : "IMMZElements" }, { "url" : "name", "valueString" : "Doses Administered to Patient" }, { "url" : "statement", "valueString" : "/**\n * @dataElement All Doses Administered to Patient\n */\ndefine \"Doses Administered to Patient\":\n [Immunization] I\n where I.status = 'completed'\n and I.isSubpotent is not true" }, { "url" : "displaySequence", "valueInteger" : 0 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZEncounterElements" }, { "url" : "name", "valueString" : "Doses Administered to Patient" }, { "url" : "statement", "valueString" : "/**\n * @dataElement All Doses Administered to Patient\n */\ndefine \"Doses Administered to Patient\":\n Elements.\"Doses Administered to Patient\" I\n where I.occurrence.toInterval() same day or before Today" }, { "url" : "displaySequence", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Cholera Doses Administered to Patient" }, { "url" : "statement", "valueString" : "/*\n@internal: Cholera containing Doses Administered to Patient\n*/\ndefine \"Cholera Doses Administered to Patient\":\n Encounter.\"Doses Administered to Patient\" I\n where\n I.vaccineCode in Concepts.\"Cholera vaccines\"" }, { "url" : "displaySequence", "valueInteger" : 2 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Cholera Primary Series Doses Administered to Patient" }, { "url" : "statement", "valueString" : "/*\n@internal: Cholera containing Doses Administered to Patient that are in the Primary series\n*/\ndefine \"Cholera Primary Series Doses Administered to Patient\":\n \"Cholera Doses Administered to Patient\".seriesPrimary()" }, { "url" : "displaySequence", "valueInteger" : 3 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Number of Cholera Primary Series Doses Administered" }, { "url" : "statement", "valueString" : "/*\n@internal: Number of Cholera Primary Series doses\n*/\ndefine \"Number of Cholera Primary Series Doses Administered\":\n Count(\"Cholera Primary Series Doses Administered to Patient\")" }, { "url" : "displaySequence", "valueInteger" : 4 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "One cholera primary series dose was administered" }, { "url" : "statement", "valueString" : "/*\n@input: One cholera primary series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n@code: One cholera primary series dose was administered-116\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n*/\ndefine \"One cholera primary series dose was administered\":\n \"Number of Cholera Primary Series Doses Administered\" = 1" }, { "url" : "displaySequence", "valueInteger" : 5 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "First cholera dose was administered" }, { "url" : "statement", "valueString" : "/*\n@complete: First cholera dose was administered\n@pseudocode: 'Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n*/\ndefine \"First cholera dose was administered\":\n Encounter.\"One cholera primary series dose was administered\"" }, { "url" : "displaySequence", "valueInteger" : 6 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Two cholera primary series doses were administered" }, { "url" : "statement", "valueString" : "/*\n@input: Two cholera primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 2\n@code: Two cholera primary series doses were administered-116\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n*/\ndefine \"Two cholera primary series doses were administered\":\n \"Number of Cholera Primary Series Doses Administered\" = 2" }, { "url" : "displaySequence", "valueInteger" : 7 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "The primary series has been completed" }, { "url" : "statement", "valueString" : "/*\n@complete: The primary series has been completed\n@pseudocode: \"Completed the primary vaccination series\" (where \"Vaccine type\" = \"Cholera vaccines\") = TRUE\n*/\ndefine \"The primary series has been completed\":\n Encounter.\"Two cholera primary series doses were administered\"" }, { "url" : "displaySequence", "valueInteger" : 8 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 2" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera dose 2\n@description: Provision of the cholera dose 2\n@trigger: First cholera dose administered\n@pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Primary series\") = 1\n@triggerDate: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera dose 2\":\n \"First cholera dose was administered\"\n and not \"The primary series has been completed\"" }, { "url" : "displaySequence", "valueInteger" : 9 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Date of Latest Cholera Dose" }, { "url" : "statement", "valueString" : "/*\n@internal: Date of Latest Cholera Dose\n*/\ndefine \"Date of Latest Cholera Dose\":\n date from start of \"Cholera Doses Administered to Patient\".mostRecent().occurrence.toInterval()" }, { "url" : "displaySequence", "valueInteger" : 10 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 2 Due Date" }, { "url" : "statement", "valueString" : "/*\n@dynamicValue: Cholera dose 2 Due Date\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 2 weeks\n*/\ndefine \"Cholera dose 2 Due Date\":\n if \"Cholera dose 2\" then Encounter.\"Date of Latest Cholera Dose\" + 2 weeks\n else null" }, { "url" : "displaySequence", "valueInteger" : 11 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 2 Create" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera dose 2 Create\n@create: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\n*/\ndefine \"Cholera dose 2 Create\":\n if \"Cholera dose 2\"\n then 'WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.' + '\nDue Date: ' + ToString(\"Cholera dose 2 Due Date\")\n else ''" }, { "url" : "displaySequence", "valueInteger" : 12 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Cholera Booster Series Doses Administered to Patient" }, { "url" : "statement", "valueString" : "/*\n@internal: Cholera Booster Series Doses Administered to Patient\n*/\ndefine \"Cholera Booster Series Doses Administered to Patient\":\n \"Cholera Doses Administered to Patient\".seriesBooster()" }, { "url" : "displaySequence", "valueInteger" : 13 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Number of Cholera Booster Series Doses Administered" }, { "url" : "statement", "valueString" : "/*\n@internal: Number of Cholera Booster Series Doses Administered\n*/\ndefine \"Number of Cholera Booster Series Doses Administered\":\n Count(\"Cholera Booster Series Doses Administered to Patient\")" }, { "url" : "displaySequence", "valueInteger" : 14 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "At least one booster series dose was administered" }, { "url" : "statement", "valueString" : "/*\n@input: At least one booster series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Booster dose\") >= 1\n@code: At least one booster series dose was administered-115\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n*/\ndefine \"At least one booster series dose was administered\":\n \"Number of Cholera Booster Series Doses Administered\" >= 1" }, { "url" : "displaySequence", "valueInteger" : 15 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Dose number of the latest dose is one" }, { "url" : "statement", "valueString" : "/*\n@input: Dose number of the latest dose is one\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 1\n@code: Dose number of the latest dose is one-68\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n*/\ndefine \"Dose number of the latest dose is one\":\n \"Cholera Doses Administered to Patient\".mostRecent().getDose('1') is not null" }, { "url" : "displaySequence", "valueInteger" : 16 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "First cholera booster dose was administered" }, { "url" : "statement", "valueString" : "/*\n@complete: First cholera booster dose was administered\n@pseudocode: 'Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Booster dose\") = 1\n*/\ndefine \"First cholera booster dose was administered\":\n Encounter.\"At least one booster series dose was administered\"\n and Encounter.\"Dose number of the latest dose is one\"" }, { "url" : "displaySequence", "valueInteger" : 17 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 1" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera booster dose 1\n@description: Provision of the cholera booster dose 1\n@trigger: Primary series for cholera has been completed and latest cholera dose was administered more than 3 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\") ≥ 3 years\n@triggerDate: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera booster dose 1\":\n \"The primary series has been completed\"\n and not \"First cholera booster dose was administered\"" }, { "url" : "displaySequence", "valueInteger" : 18 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 1 Due Date" }, { "url" : "statement", "valueString" : "/*\n@dynamicValue: Cholera booster dose 1 Due Date\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 2 weeks\n*/\ndefine \"Cholera booster dose 1 Due Date\":\n if \"Cholera booster dose 1\" then Encounter.\"Date of Latest Cholera Dose\" + 3 years\n else null" }, { "url" : "displaySequence", "valueInteger" : 19 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 1 Create" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera booster dose 1 Create\n@create: For WC vaccines, revaccination is recommended after 3 years.\n*/\ndefine \"Cholera booster dose 1 Create\":\n if \"Cholera booster dose 1\"\n then 'For WC vaccines, revaccination is recommended after 3 years.' + '\nDue Date: ' + ToString(\"Cholera booster dose 1 Due Date\")\n else ''" }, { "url" : "displaySequence", "valueInteger" : 20 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "Dose number of the latest dose is two" }, { "url" : "statement", "valueString" : "/*\n@input: Dose number of the latest dose is two\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 2\n@code: Dose number of the latest dose is two-68\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n*/\ndefine \"Dose number of the latest dose is two\":\n \"Cholera Doses Administered to Patient\".mostRecent().getDose('2') is not null" }, { "url" : "displaySequence", "valueInteger" : 21 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Revaccination with booster series has been completed in the last 3 years" }, { "url" : "statement", "valueString" : "/*\n@complete: Revaccination with booster series has been completed in the last 3 years\n@pseudocode: \"Completed the booster series\" (where \"Vaccine type\" = \"Cholera vaccines\") = TRUE AND Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccine\") < 3 years\n*/\ndefine \"Revaccination with booster series has been completed in the last 3 years\":\n Encounter.\"At least one booster series dose was administered\"\n and Encounter.\"Dose number of the latest dose is two\"" }, { "url" : "displaySequence", "valueInteger" : 22 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 2" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera booster dose 2\n@description: Provision of the cholera booster dose 1\n@trigger: First cholera booster dose administered\n@pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Booster dose\") = 1\n@triggerDate: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera booster dose 2\":\n \"First cholera booster dose was administered\"\n and not \"Revaccination with booster series has been completed in the last 3 years\"" }, { "url" : "displaySequence", "valueInteger" : 23 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD2DTCholeraEncounterElements" }, { "url" : "name", "valueString" : "No cholera primary series dose was administered" }, { "url" : "statement", "valueString" : "/*\n@input: No cholera primary series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 0\n@code: No cholera primary series dose was administered-116\n@decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule\n@decision: IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses: Whole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years\n@decision: IMMZ.D2.DT.Cholera.WC-rBS vaccine 2 doses: Whole cell-recombinant B subunit (WC-rBS) vaccine, 2-dose schedule for clients aged over 5 years\n*/\ndefine \"No cholera primary series dose was administered\":\n \"Number of Cholera Primary Series Doses Administered\" = 0" }, { "url" : "displaySequence", "valueInteger" : 24 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 1" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera dose 1\n@description: Provision of the cholera dose 1\n@trigger: Child's birth and no cholera doses have been administered\n@pseudo: Child's birth AND Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 0\n@triggerDate: \"Date of birth\"\nOR\nLatest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera dose 1\":\n Encounter.\"No cholera primary series dose was administered\"\n and not \"First cholera dose was administered\"" }, { "url" : "displaySequence", "valueInteger" : 25 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 2 Due Date" }, { "url" : "statement", "valueString" : "/*\n@dynamicValue: Cholera booster dose 2 Due Date\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 3 years\n*/\ndefine \"Cholera booster dose 2 Due Date\":\n if \"Cholera booster dose 2\" then Encounter.\"Date of Latest Cholera Dose\" + 2 weeks\n else null" }, { "url" : "displaySequence", "valueInteger" : 26 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera booster dose 2 Create" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera booster dose 2 Create\n@create: For WC vaccines, revaccination is recommended after 3 years.\n*/\ndefine \"Cholera booster dose 2 Create\":\n if \"Cholera booster dose 2\"\n then 'For WC vaccines, revaccination is recommended after 3 years.' + '\nDue Date: ' + ToString(\"Cholera booster dose 2 Due Date\")\n else ''" }, { "url" : "displaySequence", "valueInteger" : 27 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 1 Due Date" }, { "url" : "statement", "valueString" : "/*\n@dynamicValue: Cholera dose 1 Due Date\n@pseudocode: \"Date of birth\" + 1 year\n*/\ndefine \"Cholera dose 1 Due Date\":\n if \"Cholera dose 1\" then Patient.birthDate + 1 year\n else null" }, { "url" : "displaySequence", "valueInteger" : 28 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZD18SCholeraWCVaccinesLogic" }, { "url" : "name", "valueString" : "Cholera dose 1 Create" }, { "url" : "statement", "valueString" : "/*\n@output: Cholera dose 1 Create\n@create: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\nRevaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.\n*/\ndefine \"Cholera dose 1 Create\":\n if \"Cholera dose 1\"\n then 'WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\nRevaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.' + '\nDue Date: ' + ToString(\"Cholera dose 1 Due Date\")\n else ''" }, { "url" : "displaySequence", "valueInteger" : 29 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZCommon" }, { "url" : "name", "valueString" : "seriesPrimary" }, { "url" : "statement", "valueString" : "/**\n * @description: Gets the doses from the primary series\n */\ndefine fluent function seriesPrimary(immunizations List):\n immunizations I where\n exists( I.protocolApplied pa where pa.series = 'Primary series' )" }, { "url" : "displaySequence", "valueInteger" : 30 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToString" }, { "url" : "statement", "valueString" : "define function ToString(value string): value.value" }, { "url" : "displaySequence", "valueInteger" : 31 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToString" }, { "url" : "statement", "valueString" : "define function ToString(value ImmunizationStatus): value.value" }, { "url" : "displaySequence", "valueInteger" : 32 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToBoolean" }, { "url" : "statement", "valueString" : "define function ToBoolean(value boolean): value.value" }, { "url" : "displaySequence", "valueInteger" : 33 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToConcept" }, { "url" : "statement", "valueString" : "define function ToConcept(concept FHIR.CodeableConcept):\n if concept is null then\n null\n else\n System.Concept {\n codes: concept.coding C return ToCode(C),\n display: concept.text.value\n }" }, { "url" : "displaySequence", "valueInteger" : 34 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToCode" }, { "url" : "statement", "valueString" : "define function ToCode(coding FHIR.Coding):\n if coding is null then\n null\n else\n System.Code {\n code: coding.code.value,\n system: coding.system.value,\n version: coding.version.value,\n display: coding.display.value\n }" }, { "url" : "displaySequence", "valueInteger" : 35 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "WHOCommon" }, { "url" : "name", "valueString" : "mostRecent" }, { "url" : "statement", "valueString" : "define fluent function mostRecent(immunizations List):\n Last(\n immunizations I\n sort by start of occurrence.toInterval()\n )" }, { "url" : "displaySequence", "valueInteger" : 36 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZCommon" }, { "url" : "name", "valueString" : "seriesBooster" }, { "url" : "statement", "valueString" : "/**\n * @description: Gets the doses from the Booster series\n */\ndefine fluent function seriesBooster(immunizations List):\n immunizations I where\n exists( I.protocolApplied pa where pa.series = 'Booster dose' )" }, { "url" : "displaySequence", "valueInteger" : 37 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "IMMZCommon" }, { "url" : "name", "valueString" : "getDose" }, { "url" : "statement", "valueString" : "/**\n * @description: Gets a given immunization from a list that matches the dose number\n */\ndefine fluent function getDose(immunization Immunization, doseNumber String):\n immunization I where\n exists( I.protocolApplied pa where pa.doseNumber = doseNumber )" }, { "url" : "displaySequence", "valueInteger" : 38 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }, { "extension" : [{ "url" : "libraryName", "valueString" : "FHIRHelpers" }, { "url" : "name", "valueString" : "ToDate" }, { "url" : "statement", "valueString" : "define function ToDate(value date): value.value" }, { "url" : "displaySequence", "valueInteger" : 39 }], "url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition" }], "name" : "EffectiveDataRequirements", "status" : "active", "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "module-definition" }] }, "relatedArtifact" : [{ "type" : "depends-on", "display" : "FHIR model information", "resource" : "http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1" }, { "type" : "depends-on", "display" : "Library Encounter", "resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTCholeraEncounterElements" }, { "type" : "depends-on", "display" : "Library Common", "resource" : "http://smart.who.int/immunizations/Library/IMMZCommon" }, { "type" : "depends-on", "display" : "Library FHIRHelpers", "resource" : "http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1" }, { "type" : "depends-on", "display" : "Library Encounter", "resource" : "http://smart.who.int/immunizations/Library/IMMZEncounterElements" }, { "type" : "depends-on", "display" : "Library Elements", "resource" : "http://smart.who.int/immunizations/Library/IMMZElements" }, { "type" : "depends-on", "display" : "Library WC", "resource" : "http://smart.who.int/immunizations/Library/WHOCommon" }, { "type" : "depends-on", "display" : "Library FHIRHelpers", "resource" : "http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1" }, { "type" : "depends-on", "display" : "Library Concepts", "resource" : "http://smart.who.int/immunizations/Library/IMMZConcepts" }, { "type" : "depends-on", "display" : "Library WC", "resource" : "http://smart.who.int/immunizations/Library/WHOCommon" }, { "type" : "depends-on", "display" : "Value set Cholera vaccines", "resource" : "http://smart.who.int/immunizations/ValueSet/IMMZ.Z.DE2" }], "parameter" : [{ "name" : "Today", "use" : "in", "min" : 0, "max" : "1", "type" : "date" }, { "name" : "Cholera dose 2 Create", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Cholera dose 2", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Cholera booster dose 1 Create", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Cholera booster dose 2", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Cholera dose 1", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Cholera booster dose 1", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Cholera booster dose 2 Create", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Cholera dose 1 Create", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }], "dataRequirement" : [{ "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence", "vaccineCode"] }, { "type" : "Patient", "profile" : ["http://hl7.org/fhir/StructureDefinition/Patient"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence", "vaccineCode"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence", "vaccineCode"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence", "vaccineCode"] }, { "type" : "Immunization", "profile" : ["http://hl7.org/fhir/StructureDefinition/Immunization"], "mustSupport" : ["status", "isSubpotent", "occurrence", "vaccineCode"] }] }], "extension" : [{ "url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability", "valueCode" : "computable" }, { "url" : "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-effectiveDataRequirements", "valueCanonical" : "#effective-data-requirements" }], "url" : "http://smart.who.int/immunizations/PlanDefinition/IMMZD18SCholeraWCVaccines", "version" : "0.2.0", "name" : "IMMZD18SCholeraWCVaccines", "title" : "IMMZ.D18.S.Cholera.WC vaccines schedule", "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type", "code" : "eca-rule" }] }, "status" : "draft", "experimental" : false, "date" : "2026-03-25T23:30:34+00:00", "publisher" : "WHO", "contact" : [{ "name" : "WHO", "telecom" : [{ "system" : "url", "value" : "http://who.int" }] }], "description" : "IMMZ.D18.S.Cholera.WC vaccines schedule\nWhole-cell (WC) vaccines (Shanchol, Euvchol and mORCVAX), 2-dose schedule", "relatedArtifact" : [{ "type" : "citation", "citation" : "WHO recommendations for routine immunization - summary tables (January 2025)" }], "library" : ["http://smart.who.int/immunizations/Library/IMMZD18SCholeraWCVaccinesLogic"], "action" : [{ "title" : "Cholera dose 1", "description" : "Provision of the cholera dose 1\nTrigger event: Child's birth and no cholera doses have been administered\nTrigger pseudo: Child's birth AND Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 0\nTrigger date: \"Date of birth\"\nOR\nLatest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\nRevaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.", "condition" : [{ "kind" : "applicability", "expression" : { "description" : "Cholera dose 1", "language" : "text/cql-identifier", "expression" : "Cholera dose 1" } }], "definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR", "dynamicValue" : [{ "path" : "status", "expression" : { "language" : "text/cql-expression", "expression" : "'active'" } }, { "path" : "payload.contentString", "expression" : { "language" : "text/cql-identifier", "expression" : "Cholera dose 1 Create" } }, { "path" : "category.coding", "expression" : { "description" : "Category of communication", "language" : "text/cql-expression", "expression" : "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }" } }, { "path" : "priority", "expression" : { "description" : "Alert priority", "language" : "text/cql-expression", "expression" : "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }" } }] }, { "title" : "Cholera dose 2", "description" : "Provision of the cholera dose 2\nTrigger event: First cholera dose administered\nTrigger pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Primary series\") = 1\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.", "condition" : [{ "kind" : "applicability", "expression" : { "description" : "Cholera dose 2", "language" : "text/cql-identifier", "expression" : "Cholera dose 2" } }], "definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR", "dynamicValue" : [{ "path" : "status", "expression" : { "language" : "text/cql-expression", "expression" : "'active'" } }, { "path" : "payload.contentString", "expression" : { "language" : "text/cql-identifier", "expression" : "Cholera dose 2 Create" } }, { "path" : "category.coding", "expression" : { "description" : "Category of communication", "language" : "text/cql-expression", "expression" : "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }" } }, { "path" : "priority", "expression" : { "description" : "Alert priority", "language" : "text/cql-expression", "expression" : "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }" } }] }, { "title" : "Cholera booster dose 1", "description" : "Provision of the cholera booster dose 1\nTrigger event: Primary series for cholera has been completed and latest cholera dose was administered more than 3 years ago\nTrigger 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\") ≥ 3 years\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.", "condition" : [{ "kind" : "applicability", "expression" : { "description" : "Cholera booster dose 1", "language" : "text/cql-identifier", "expression" : "Cholera booster dose 1" } }], "definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR", "dynamicValue" : [{ "path" : "status", "expression" : { "language" : "text/cql-expression", "expression" : "'active'" } }, { "path" : "payload.contentString", "expression" : { "language" : "text/cql-identifier", "expression" : "Cholera booster dose 1 Create" } }, { "path" : "category.coding", "expression" : { "description" : "Category of communication", "language" : "text/cql-expression", "expression" : "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }" } }, { "path" : "priority", "expression" : { "description" : "Alert priority", "language" : "text/cql-expression", "expression" : "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }" } }] }, { "title" : "Cholera booster dose 2", "description" : "Provision of the cholera booster dose 1\nTrigger event: First cholera booster dose administered\nTrigger pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Booster dose\") = 1\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.", "condition" : [{ "kind" : "applicability", "expression" : { "description" : "Cholera booster dose 2", "language" : "text/cql-identifier", "expression" : "Cholera booster dose 2" } }], "definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR", "dynamicValue" : [{ "path" : "status", "expression" : { "language" : "text/cql-expression", "expression" : "'active'" } }, { "path" : "payload.contentString", "expression" : { "language" : "text/cql-identifier", "expression" : "Cholera booster dose 2 Create" } }, { "path" : "category.coding", "expression" : { "description" : "Category of communication", "language" : "text/cql-expression", "expression" : "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }" } }, { "path" : "priority", "expression" : { "description" : "Alert priority", "language" : "text/cql-expression", "expression" : "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }" } }] }] }