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/tree/123/merge and changes regularly. See the Directory of published versions
| Draft as of 2026-03-03 |
{
"resourceType" : "PlanDefinition",
"id" : "IMMZD18SCholeraWCRBSVaccine3Doses",
"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" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n<div>\n <table class=\"grid dict\">\n \n <tr>\n <th scope=\"row\"><b>Id: </b></th>\n <td style=\"padding-left: 4px;\">IMMZD18SCholeraWCRBSVaccine3Doses</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Url: </b></th>\n <td style=\"padding-left: 4px;\"><a href=\"PlanDefinition-IMMZD18SCholeraWCRBSVaccine3Doses.html\">IMMZ.D18.S.Cholera.WC-rBS vaccine 3-dose schedule</a></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Version: </b></th>\n <td style=\"padding-left: 4px;\">0.2.0</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Title: </b></th>\n <td style=\"padding-left: 4px;\">IMMZ.D18.S.Cholera.WC-rBS vaccine 3-dose schedule</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Status: </b></th>\n <td style=\"padding-left: 4px;\">draft</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Type: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p style=\"margin-bottom: 5px;\">\n <b>system: </b> <span><a href=\"http://terminology.hl7.org/7.0.1/CodeSystem-plan-definition-type.html\">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>\n </p>\n \n \n <p style=\"margin-bottom: 5px;\">\n <b>code: </b> <span>eca-rule</span>\n </p>\n \n \n \n \n \n </td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Date: </b></th>\n <td style=\"padding-left: 4px;\">2026-03-03 13:07:11+0000</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Publisher: </b></th>\n <td style=\"padding-left: 4px;\">WHO</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Description: </b></th>\n <td style=\"padding-left: 4px;\"><div><p>IMMZ.D18.S.Cholera.WC-rBS vaccine 3-dose schedule\nWhole cell-recombinant B subunit (WC-rBS) vaccine (Dukoral), 3-dose schedule for clients aged 2–5 years</p>\n</div></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Knowledge Capability: </b></th>\n <td style=\"padding-left: 4px;\">\n \n computable \n </td>\n </tr>\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Related Artifacts: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n <p><b>References</b></p>\n <ul>\n \n <li><div><p>WHO recommendations for routine immunization - summary tables (January 2025)</p>\n</div><br/><a href=\"null\"/></li>\n \n </ul>\n \n \n \n \n \n \n </td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Libraries: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n \n <tr>\n <td><a href=\"Library-IMMZD18SCholeraWCRBSVaccine3DosesLogic.html\">IMMZD18SCholeraWCRBSVaccine3DosesLogic</a></td>\n </tr>\n \n </table>\n </td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Actions: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n \n <tr>\n <td>\n \n <b> Cholera dose 1:</b> Provision of the cholera dose 1\nTrigger event: Child's birth\nTrigger pseudo: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines") = 0 AND (2 years ≤ Today's date − "Date of birth" ≤ 5 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 (2 years ≤ Today's date − "Date of birth" ≤ 5 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") > 6 months AND (2 years ≤ Today's date − "Date of birth" ≤ 5 years)\nTrigger date: "Date of birth"\nOR\nLatest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children 2–5 years of age, 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 children aged 2–5 years: If more than 6 months have passed since completion of primary vaccination series, the primary series of 3 doses should be repeated.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Cholera dose 1\n \n <i>(Cholera dose 1)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTCR.html\">IMMZ.D2.DT.CR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('active')</i>\n <br/>\n \n payload.contentString: <i>(Cholera dose 1 Create)</i>\n <br/>\n \n category.coding: <i>(Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })</i>\n <br/>\n \n priority: <i>(Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Cholera dose 2:</b> Provision of the cholera dose 2\nTrigger event: First cholera dose was administered\nTrigger pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 1 AND (2 years ≤ Today's date − "Date of birth" ≤ 5 years)\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Cholera dose 2\n \n <i>(Cholera dose 2)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTCR.html\">IMMZ.D2.DT.CR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('active')</i>\n <br/>\n \n payload.contentString: <i>(Cholera dose 2 Create)</i>\n <br/>\n \n category.coding: <i>(Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })</i>\n <br/>\n \n priority: <i>(Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Cholera dose 3:</b> Provision of the cholera dose 3\nTrigger event: Second cholera dose was administered\nTrigger pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 2 AND (2 years ≤ Today's date − "Date of birth" ≤ 5 years)\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Cholera dose 3\n \n <i>(Cholera dose 3)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTCR.html\">IMMZ.D2.DT.CR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('active')</i>\n <br/>\n \n payload.contentString: <i>(Cholera dose 3 Create)</i>\n <br/>\n \n category.coding: <i>(Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })</i>\n <br/>\n \n priority: <i>(Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Cholera booster dose:</b> Provision of the cholera booster dose\nTrigger event: Primary series for cholera has been completed and latest cholera dose was administered approximately less than 6 months 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") ≤ 6 months ± Member States defined interval AND (2 years ≤ Today's date − "Date of birth" ≤ 5 years)\nTrigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines")\nCreate condition: For WC-rBS vaccine, for children aged 2–5 years, if less than 6 months have passed since completion of primary vaccination series, 1 dose for revaccination.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Cholera booster dose\n \n <i>(Cholera booster dose)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTCR.html\">IMMZ.D2.DT.CR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('active')</i>\n <br/>\n \n payload.contentString: <i>(Cholera booster dose Create)</i>\n <br/>\n \n category.coding: <i>(Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })</i>\n <br/>\n \n priority: <i>(Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n </table>\n </td>\n </tr>\n \n </table>\n</div>\n</div>"
},
"contained" : [
{
"resourceType" : "Library",
"id" : "effective-data-requirements",
"extension" : [
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Current Patient Age In Years"
},
{
"url" : "statement",
"valueString" : "/** \n * @dataElement Patient age in years\n */\ndefine \"Current Patient Age In Years\":\n AgeInYearsAt(Today)"
},
{
"url" : "displaySequence",
"valueInteger" : 0
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is 2–5 years"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is 2–5 years\n@pseudocode: 2 years ≤ Today's date − \"Date of birth\" ≤ 5 years\n@code: Client's age is 2–5 years-50\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*/\ndefine \"Client's age is 2–5 years\":\n Encounter.\"Current Patient Age In Years\" >= 2\n and Encounter.\"Current Patient Age In Years\" <= 5"
},
{
"url" : "displaySequence",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"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" : 2
}
],
"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" : 3
}
],
"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" : 4
}
],
"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" : 5
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "Dose number of the latest primary series dose is one"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Dose number of the latest primary series dose is one\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n@code: Dose number of the latest primary series dose is one-106\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 \"Dose number of the latest primary series dose is one\":\n \"Cholera Primary Series Doses Administered to Patient\".mostRecent().getDose('1') is not null"
},
{
"url" : "displaySequence",
"valueInteger" : 6
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"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\") = 1\n*/\ndefine \"First cholera dose was administered\":\n Encounter.\"Dose number of the latest primary series dose is one\""
},
{
"url" : "displaySequence",
"valueInteger" : 7
}
],
"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" : 8
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 2 Expiration"
},
{
"url" : "statement",
"valueString" : "/*\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"
},
{
"url" : "displaySequence",
"valueInteger" : 9
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "Dose number of the latest primary series dose is two"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Dose number of the latest primary series dose is two\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 2\n@code: Dose number of the latest primary series dose is two-106\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*/\ndefine \"Dose number of the latest primary series dose is two\":\n \"Cholera Primary Series Doses Administered to Patient\".mostRecent().getDose('2') is not null"
},
{
"url" : "displaySequence",
"valueInteger" : 10
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Second cholera dose was administered"
},
{
"url" : "statement",
"valueString" : "/*\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\""
},
{
"url" : "displaySequence",
"valueInteger" : 11
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"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 was administered\n@pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 1 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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 2–5 years\"\n and \"First cholera dose was administered\"\n and \"Cholera dose 2 Expiration\" after day of Today\n and not \"Second cholera dose was administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 12
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"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\") + 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"
},
{
"url" : "displaySequence",
"valueInteger" : 13
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 2 Create"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Cholera dose 2 Create\n@create: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, 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), 3 doses should be given to children aged 2–5 years, 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 ''"
},
{
"url" : "displaySequence",
"valueInteger" : 14
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 3 Expiration"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Cholera dose 3 Expiration\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 6 weeks\n*/\ndefine \"Cholera dose 3 Expiration\":\n Encounter.\"Date of Latest Cholera Dose\" + 6 weeks"
},
{
"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 primary series dose is three"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Dose number of the latest primary series dose is three\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 3\n@code: Dose number of the latest primary series dose is three-106\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*/\ndefine \"Dose number of the latest primary series dose is three\":\n \"Cholera Primary Series Doses Administered to Patient\".mostRecent().getDose('3') is not null"
},
{
"url" : "displaySequence",
"valueInteger" : 16
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Three doses from primary series were administered. The primary series has been completed"
},
{
"url" : "statement",
"valueString" : "/*\n@complete: Three doses from primary series were administered. The primary series has been completed\n@pseudocode: \"Completed the primary vaccination series\" (where \"Vaccine type\" = \"Cholera vaccines\") = TRUE\n*/\ndefine \"Three doses from primary series were administered. The primary series has been completed\":\n Encounter.\"Dose number of the latest primary series dose is three\""
},
{
"url" : "displaySequence",
"valueInteger" : 17
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 3"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Cholera dose 3\n@description: Provision of the cholera dose 3\n@trigger: Second cholera dose was administered\n@pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 2 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\n@triggerDate: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera dose 3\":\n Encounter.\"Client's age is 2–5 years\"\n and \"Second cholera dose was administered\"\n and \"Cholera dose 3 Expiration\" after day of Today\n and not \"Three doses from primary series were administered. The primary series has been completed\""
},
{
"url" : "displaySequence",
"valueInteger" : 18
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 3 Due Date"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Cholera dose 3 Due Date\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 1 week\n*/\ndefine \"Cholera dose 3 Due Date\":\n if \"Cholera dose 3\" then Encounter.\"Date of Latest Cholera Dose\" + 1 week\n else null"
},
{
"url" : "displaySequence",
"valueInteger" : 19
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 3 Create"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Cholera dose 3 Create\n@create: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.\n*/\ndefine \"Cholera dose 3 Create\":\n if \"Cholera dose 3\"\n then 'For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.' + '\nDue Date: ' + ToString(\"Cholera dose 3 Due Date\") + '\nExpiration: ' + ToString(\"Cholera dose 3 Expiration\")\n else ''"
},
{
"url" : "displaySequence",
"valueInteger" : 20
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera booster dose Expiration"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Cholera booster dose Expiration\n@pseudocode: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") + 6 months ± Member States defined interval\n*/\ndefine \"Cholera booster dose Expiration\":\n Encounter.\"Date of Latest Cholera Dose\" + 6 months + (CholeraExactIntervalDays * 1 days)"
},
{
"url" : "displaySequence",
"valueInteger" : 21
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera booster dose"
},
{
"url" : "statement",
"valueString" : "/*\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 6 months 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\") ≤ 6 months ± Member States defined interval AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\n@triggerDate: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\n*/\ndefine \"Cholera booster dose\":\n Encounter.\"Dose number of the latest primary series dose is three\"\n and \"Cholera booster dose Expiration\" after day of Today"
},
{
"url" : "displaySequence",
"valueInteger" : 22
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera booster dose Due Date"
},
{
"url" : "statement",
"valueString" : "/*\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\" + (CholeraLowerLimitDays * 1 days)\n else null"
},
{
"url" : "displaySequence",
"valueInteger" : 23
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera booster dose Create"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Cholera booster dose Create\n@create: For WC-rBS vaccine, for children aged 2–5 years, if less than 6 months 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 children aged 2–5 years, if less than 6 months 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 ''"
},
{
"url" : "displaySequence",
"valueInteger" : 24
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is less than 2 years"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is less than 2 years\n@pseudocode: Today's date − \"Date of birth\" < 2 years\n@code: Client's age is less than 2 years-40\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*/\ndefine \"Client's age is less than 2 years\":\n Encounter.\"Current Patient Age In Years\" < 2"
},
{
"url" : "displaySequence",
"valueInteger" : 25
}
],
"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" : 26
}
],
"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" : 27
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "Dose number of the latest primary series dose is less than three"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Dose number of the latest primary series dose is less than three\n@pseudocode: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") < 3\n@code: Dose number of the latest primary series dose is less than three-106\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*/\ndefine \"Dose number of the latest primary series dose is less than three\":\n ((\"Cholera Primary Series Doses Administered to Patient\".mostRecent()) I\n where exists( I.protocolApplied pa where ToInteger(pa.doseNumber) < 3)) is not null"
},
{
"url" : "displaySequence",
"valueInteger" : 28
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered more than 6 weeks ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered more than 6 weeks ago\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") ≥ 6 weeks\n@code: The latest cholera dose was administered more than 6 weeks ago-106\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 \"The latest cholera dose was administered more than 6 weeks ago\":\n \"Date of Latest Cholera Dose\" is not null\n and duration in weeks between \"Date of Latest Cholera Dose\" and Today >= 6"
},
{
"url" : "displaySequence",
"valueInteger" : 29
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") > 6 months\n@code: The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}-107\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*/\ndefine \"The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}\":\n \"Date of Latest Cholera Dose\" is not null\n and duration in days between (\"Date of Latest Cholera Dose\" + 6 months) and Today > CholeraExactIntervalDays"
},
{
"url" : "displaySequence",
"valueInteger" : 30
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"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\n@pseudo: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\") = 0 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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 (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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\") > 6 months AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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 less than 2 years\"\n or Encounter.\"Client's age is 2–5 years\" )\n and ( Encounter.\"No cholera primary series dose was administered\"\n or ( Encounter.\"Dose number of the latest primary series dose is less than three\"\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 6 months ago {Member States defined exact interval}\"\n )"
},
{
"url" : "displaySequence",
"valueInteger" : 31
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 1 Due Date"
},
{
"url" : "statement",
"valueString" : "/*\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 Patient.birthDate + 2 years\n else null"
},
{
"url" : "displaySequence",
"valueInteger" : 32
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD18SCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Cholera dose 1 Create"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Cholera dose 1 Create\n@create: For WC-rBS vaccine (Dukoral), 3 doses should be given to children 2–5 years of age, 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 children aged 2–5 years: If more than 6 months have passed since completion of primary vaccination series, the primary series of 3 doses should be repeated.\n*/\ndefine \"Cholera dose 1 Create\":\n if \"Cholera dose 1\"\n then 'For WC-rBS vaccine (Dukoral), 3 doses should be given to children 2–5 years of age, with an interval of 1-6 weeks between doses. If the interval since the last dose ≥ 6 weeks, restart the primary series.\nRevaccination for children aged 2–5 years: If more than 6 months have passed since completion of primary vaccination series, the primary series of 3 doses should be repeated.' + '\nDue Date: ' + ToString(\"Cholera dose 1 Due Date\")\n else ''"
},
{
"url" : "displaySequence",
"valueInteger" : 33
}
],
"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" : 34
}
],
"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" : 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<Immunization>):\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" : "seriesPrimary"
},
{
"url" : "statement",
"valueString" : "/**\n * @description: Gets the doses from the primary series\n */\ndefine fluent function seriesPrimary(immunizations List<Immunization>):\n immunizations I where\n exists( I.protocolApplied pa where pa.series = 'Primary series' )"
},
{
"url" : "displaySequence",
"valueInteger" : 37
}
],
"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" : 38
}
],
"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" : 39
}
],
"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" : 40
}
],
"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" : 41
}
],
"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" : 42
}
],
"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 Encounter",
"resource" : "http://smart.who.int/immunizations/Library/IMMZEncounterElements"
},
{
"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 WC",
"resource" : "http://smart.who.int/immunizations/Library/WHOCommon"
},
{
"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" : "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" : "CholeraExactIntervalDays",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "integer"
},
{
"name" : "CholeraLowerLimitDays",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "integer"
},
{
"name" : "Cholera dose 2 Create",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Cholera dose 3 Create",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Cholera booster dose Create",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Cholera dose 3",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "Cholera 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",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "Cholera dose 1 Create",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
}
],
"dataRequirement" : [
{
"type" : "Patient",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"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" : "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"
]
}
]
}
],
"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/IMMZD18SCholeraWCRBSVaccine3Doses",
"version" : "0.2.0",
"name" : "IMMZD18SCholeraWCRBSVaccine3Doses",
"title" : "IMMZ.D18.S.Cholera.WC-rBS vaccine 3-dose schedule",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "eca-rule"
}
]
},
"status" : "draft",
"experimental" : false,
"date" : "2026-03-03T13:07:11+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "IMMZ.D18.S.Cholera.WC-rBS vaccine 3-dose schedule\nWhole cell-recombinant B subunit (WC-rBS) vaccine (Dukoral), 3-dose schedule for clients aged 2–5 years",
"relatedArtifact" : [
{
"type" : "citation",
"citation" : "WHO recommendations for routine immunization - summary tables (January 2025)"
}
],
"library" : [
🔗 "http://smart.who.int/immunizations/Library/IMMZD18SCholeraWCRBSVaccine3DosesLogic"
],
"action" : [
{
"title" : "Cholera dose 1",
"description" : "Provision of the cholera dose 1\nTrigger event: Child's birth\nTrigger pseudo: Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\") = 0 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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 (2 years ≤ Today's date − \"Date of birth\" ≤ 5 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\") > 6 months AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\nTrigger date: \"Date of birth\"\nOR\nLatest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children 2–5 years of age, 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 children aged 2–5 years: If more than 6 months have passed since completion of primary vaccination series, the primary series of 3 doses should be repeated.",
"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 was administered\nTrigger pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 1 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.",
"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 dose 3",
"description" : "Provision of the cholera dose 3\nTrigger event: Second cholera dose was administered\nTrigger pseudo: Latest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\") = 2 AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years, with an interval of 1–6 weeks between doses.",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Cholera dose 3",
"language" : "text/cql-identifier",
"expression" : "Cholera dose 3"
}
}
],
"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 3 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",
"description" : "Provision of the cholera booster dose\nTrigger event: Primary series for cholera has been completed and latest cholera dose was administered approximately less than 6 months 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\") ≤ 6 months ± Member States defined interval AND (2 years ≤ Today's date − \"Date of birth\" ≤ 5 years)\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC-rBS vaccine, for children aged 2–5 years, if less than 6 months have passed since completion of primary vaccination series, 1 dose for revaccination.",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Cholera booster dose",
"language" : "text/cql-identifier",
"expression" : "Cholera booster dose"
}
}
],
"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 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' }"
}
}
]
}
]
}