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" : "IMMZD2DTCholeraWCRBSVaccine3Doses",
"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;\">IMMZD2DTCholeraWCRBSVaccine3Doses</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-IMMZD2DTCholeraWCRBSVaccine3Doses.html\">IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses</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.D2.DT.Cholera.WC-rBS vaccine 3 doses</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.D2.DT.Cholera.WC-rBS vaccine 3 doses\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 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-IMMZD2DTCholeraWCRBSVaccine3DosesLogic.html\">IMMZD2DTCholeraWCRBSVaccine3DosesLogic</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> Determine if the client is due for Cholera.:</b> Determine if the client is due for Cholera vaccine according to the national immunization protocol.\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Client is due for cholera vaccination\n \n <i>(Client is due for cholera vaccination)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTMR.html\">IMMZD2DTMR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('draft')</i>\n <br/>\n \n intent: <i>('proposal')</i>\n <br/>\n \n medication: <i>(Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE2', display: 'Cholera vaccines' } }, display: 'Cholera vaccines' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Determine if the client is due for Cholera.:</b> Determine if the client is due for Cholera vaccine according to the national immunization protocol.\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Primary series is complete. Client is due for cholera booster dose\n \n <i>(Primary series is complete. Client is due for cholera booster dose)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTMR.html\">IMMZD2DTMR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('draft')</i>\n <br/>\n \n intent: <i>('proposal')</i>\n <br/>\n \n medication: <i>(Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE2', display: 'Cholera vaccines' } }, display: 'Cholera vaccines' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Check for Guidance for the patient regarding IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses.:</b> Show Guidance for the patient regarding IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Has Guidance\n \n <i>(Has Guidance)</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>(Guidance)</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 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" : 1
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for cholera vaccination Case 1"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for cholera vaccination Case 1\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for cholera vaccination Case 1\":\n Encounter.\"Client's age is less than 2 years\""
},
{
"url" : "displaySequence",
"valueInteger" : 2
}
],
"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" : 3
}
],
"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" : 4
}
],
"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" : 5
}
],
"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" : 6
}
],
"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" : 7
}
],
"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" : 8
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "At least one cholera primary series dose was administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: At least 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: At least one cholera primary series dose was administered-117\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 \"At least one cholera primary series dose was administered\":\n \"Number of Cholera Primary Series Doses Administered\" >= 1"
},
{
"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 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" : 10
}
],
"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" : 11
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered less than 1 week ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered less than 1 week ago\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") < 1 week\n@code: The latest cholera dose was administered less than 1 week ago-105\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 less than 1 week ago\":\n \"Date of Latest Cholera Dose\" is not null\n and duration in weeks between \"Date of Latest Cholera Dose\" and Today < 1"
},
{
"url" : "displaySequence",
"valueInteger" : 12
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for cholera vaccination Case 2"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for cholera vaccination Case 2\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for cholera vaccination Case 2\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is one\"\n and Encounter.\"The latest cholera dose was administered less than 1 week ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 13
}
],
"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" : 14
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for cholera vaccination Case 3"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for cholera vaccination Case 3\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for cholera vaccination Case 3\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is two\"\n and Encounter.\"The latest cholera dose was administered less than 1 week ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 15
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for cholera vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for cholera vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for cholera vaccination\":\n \"Client is not due for cholera vaccination Case 1\"\n or \"Client is not due for cholera vaccination Case 2\"\n or \"Client is not due for cholera vaccination Case 3\""
},
{
"url" : "displaySequence",
"valueInteger" : 16
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for cholera vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for cholera vaccination Guidance\n@guidance = Should not vaccinate client with cholera dose as client's age is less than 2 years.\nCheck for any vaccines due and inform the caregiver of when to come back for the first cholera dose.\n@guidance = Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.\n@guidance = Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.\n*/\ndefine \"Client is not due for cholera vaccination Guidance\":\n case\n when \"Client is not due for cholera vaccination Case 1\" then 'Should not vaccinate client with cholera dose as client\\'s age is less than 2 years.\nCheck for any vaccines due and inform the caregiver of when to come back for the first cholera dose.'\n when \"Client is not due for cholera vaccination Case 2\" then 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.'\n when \"Client is not due for cholera vaccination Case 3\" then 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than 1 week ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.'\n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 17
}
],
"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" : 18
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Case 1"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Case 1\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for cholera vaccination Case 1\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"No cholera primary series dose was administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 19
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered more than 1 week and less than 6 weeks ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered more than 1 week and less than 6 weeks ago\n@pseudocode: 1 week ≤ 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 1 week and less than 6 weeks ago-115\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 1 week and less 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 >= 1\n and duration in weeks between \"Date of Latest Cholera Dose\" and Today < 6"
},
{
"url" : "displaySequence",
"valueInteger" : 20
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Case 2"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Case 2\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for cholera vaccination Case 2\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is one\"\n and Encounter.\"The latest cholera dose was administered more than 1 week and less than 6 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 21
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Case 3"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Case 3\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for cholera vaccination Case 3\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is two\"\n and Encounter.\"The latest cholera dose was administered more than 1 week and less than 6 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 22
}
],
"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" : 23
}
],
"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" : 24
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Case 4"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Case 4\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n\"Completed the booster series\" (where \"Vaccine type\" = \"Cholera vaccines\") = FALSE when dose 1 is administered\n*/\ndefine \"Client is due for cholera vaccination Case 4\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and 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\""
},
{
"url" : "displaySequence",
"valueInteger" : 25
}
],
"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" : 26
}
],
"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" : 27
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Case 5"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Case 5\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n\"Completed the primary vaccination series\" (where \"Vaccine type\" = \"Cholera vaccines\") = FALSE when dose 1 is administered\n*/\ndefine \"Client is due for cholera vaccination Case 5\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is three\"\n and Encounter.\"The latest cholera dose was administered approximately more than 6 months ago {Member States defined exact interval}\""
},
{
"url" : "displaySequence",
"valueInteger" : 28
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for cholera vaccination\":\n \"Client is due for cholera vaccination Case 1\"\n or \"Client is due for cholera vaccination Case 2\"\n or \"Client is due for cholera vaccination Case 3\"\n or \"Client is due for cholera vaccination Case 4\"\n or \"Client is due for cholera vaccination Case 5\""
},
{
"url" : "displaySequence",
"valueInteger" : 29
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for cholera vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for cholera vaccination Guidance\n@guidance = Should vaccinate client with cholera dose as no cholera doses have been administered.\nCheck for contraindications.\n@guidance = Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.\nCheck for contraindications.\n@guidance = Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.\nCheck for contraindications.\n@guidance = Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than 6 weeks ago.\nCheck for contraindications.\n@guidance = Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than approximately 6 months ago.\nCheck for contraindications.\n*/\ndefine \"Client is due for cholera vaccination Guidance\":\n case\n when \"Client is due for cholera vaccination Case 1\" then 'Should vaccinate client with cholera dose as no cholera doses have been administered.\nCheck for contraindications.'\n when \"Client is due for cholera vaccination Case 2\" then 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.\nCheck for contraindications.'\n when \"Client is due for cholera vaccination Case 3\" then 'Should vaccinate client with cholera dose as the latest cholera dose was administered in the last 1 to 6 weeks.\nCheck for contraindications.'\n when \"Client is due for cholera vaccination Case 4\" then 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than 6 weeks ago.\nCheck for contraindications.'\n when \"Client is due for cholera vaccination Case 5\" then 'Should vaccinate client with cholera dose and restart primary series as the latest cholera dose was administered more than approximately 6 months ago.\nCheck for contraindications.'\n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 30
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered less than {Member States defined lower limit} days ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered less than {Member States defined lower limit} days ago\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\") ≤ Member States defined lower limit\n@code: The latest cholera dose was administered less than {Member States defined lower limit} days ago-132\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 less than {Member States defined lower limit} days ago\":\n \"Date of Latest Cholera Dose\" is not null\n and duration in days between \"Date of Latest Cholera Dose\" and Today <= CholeraLowerLimitDays"
},
{
"url" : "displaySequence",
"valueInteger" : 31
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Primary series is complete. Client is not due for cholera booster dose"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Primary series is complete. Client is not due for cholera booster dose\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n\"Completed the booster series\" (where \"Vaccine type\" = \"Cholera vaccines\") = TRUE\n*/\ndefine \"Primary series is complete. Client is not due for cholera booster dose\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is three\"\n and Encounter.\"The latest cholera dose was administered less than {Member States defined lower limit} days ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 32
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Primary series is complete. Client is not due for cholera booster dose Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Primary series is complete. Client is not due for cholera booster dose Guidance\n@guidance: Should not vaccinate client with cholera dose as the latest cholera dose was administered less than {Member States defined lower limit} days ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.\n*/\ndefine \"Primary series is complete. Client is not due for cholera booster dose Guidance\":\n 'Should not vaccinate client with cholera dose as the latest cholera dose was administered less than {Member States defined lower limit} days ago.\nCheck for any vaccines due and inform the caregiver of when to come back for the next dose.'"
},
{
"url" : "displaySequence",
"valueInteger" : 33
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest cholera dose was administered approximately less than 6 months ago {Member States defined exact interval}"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest cholera dose was administered approximately less 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 less 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 less 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\" and Today > CholeraLowerLimitDays\n and duration in days between (\"Date of Latest Cholera Dose\" + 6 months) and Today <= CholeraExactIntervalDays"
},
{
"url" : "displaySequence",
"valueInteger" : 34
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Primary series is complete. Client is due for cholera booster dose"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Primary series is complete. Client is due for cholera booster dose\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n\"Completed the booster series\" (where \"Vaccine type\" = \"Cholera vaccines\") = TRUE\n*/\ndefine \"Primary series is complete. Client is due for cholera booster dose\":\n Encounter.\"Client's age is 2–5 years\"\n and Encounter.\"At least one cholera primary series dose was administered\"\n and Encounter.\"Dose number of the latest primary series dose is three\"\n and Encounter.\"The latest cholera dose was administered approximately less than 6 months ago {Member States defined exact interval}\""
},
{
"url" : "displaySequence",
"valueInteger" : 35
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Primary series is complete. Client is due for cholera booster dose Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Primary series is complete. Client is due for cholera booster dose Guidance\n@guidance: Should vaccinate client with cholera booster dose as the latest cholera dose was administered less than approximately 6 months ago.\nCheck for contraindications.\n*/\ndefine \"Primary series is complete. Client is due for cholera booster dose Guidance\":\n 'Should vaccinate client with cholera booster dose as the latest cholera dose was administered less than approximately 6 months ago.\nCheck for contraindications.'"
},
{
"url" : "displaySequence",
"valueInteger" : 36
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Guidance\n*/\ndefine \"Guidance\":\n case \n when \"Client is not due for cholera vaccination\" then \"Client is not due for cholera vaccination Guidance\"\n when \"Client is due for cholera vaccination\" then \"Client is due for cholera vaccination Guidance\"\n when \"Primary series is complete. Client is not due for cholera booster dose\" then \"Primary series is complete. Client is not due for cholera booster dose Guidance\"\n when \"Primary series is complete. Client is due for cholera booster dose\" then \"Primary series is complete. Client is due for cholera booster dose Guidance\" \n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 37
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
},
{
"url" : "name",
"valueString" : "Has Guidance"
},
{
"url" : "statement",
"valueString" : "define \"Has Guidance\":\n \"Guidance\" is not null and \"Guidance\" != ''"
},
{
"url" : "displaySequence",
"valueInteger" : 38
}
],
"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" : 39
}
],
"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" : 40
}
],
"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" : 41
}
],
"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" : 42
}
],
"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" : 43
}
],
"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" : 44
}
],
"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" : 45
}
],
"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" : 46
}
],
"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 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" : "CholeraExactIntervalDays",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "integer"
},
{
"name" : "CholeraLowerLimitDays",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "integer"
},
{
"name" : "Guidance",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Has Guidance",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "Primary series is complete. Client is due for cholera booster dose",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "Client is due for cholera vaccination",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
}
],
"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" : "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/IMMZD2DTCholeraWCRBSVaccine3Doses",
"version" : "0.2.0",
"name" : "IMMZD2DTCholeraWCRBSVaccine3Doses",
"title" : "IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses",
"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.D2.DT.Cholera.WC-rBS vaccine 3 doses\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 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/IMMZD2DTCholeraWCRBSVaccine3DosesLogic"
],
"action" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale",
"valueMarkdown" : "For WC-rBS vaccine (Dukoral), 3 doses should be given to children aged 2–5 years of age, with an interval of 1–6 weeks between doses.\nFor WC-rBS vaccine, children aged 2–5 years revaccination is recommended within 6 months. \nIf more than 6 months have passed, the primary series of 3 doses should be repeated."
}
],
"title" : "Determine if the client is due for Cholera.",
"description" : "Determine if the client is due for Cholera vaccine according to the national immunization protocol.\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Client is due for cholera vaccination",
"language" : "text/cql-identifier",
"expression" : "Client is due for cholera vaccination"
}
}
],
"definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTMR",
"dynamicValue" : [
{
"path" : "status",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'draft'"
}
},
{
"path" : "intent",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'proposal'"
}
},
{
"path" : "medication",
"expression" : {
"language" : "text/cql-expression",
"expression" : "Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE2', display: 'Cholera vaccines' } }, display: 'Cholera vaccines' }"
}
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale",
"valueMarkdown" : "Revaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC-rBS vaccine, \nchildren aged 2–5 years revaccination is recommended within 6 months. If less than 6 months have passed, 1 dose for revaccination."
}
],
"title" : "Determine if the client is due for Cholera.",
"description" : "Determine if the client is due for Cholera vaccine according to the national immunization protocol.\nWhole cell-recombinant B subunit (WC-rBS) vaccine, 3-dose schedule for clients aged 2–5 years",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Primary series is complete. Client is due for cholera booster dose",
"language" : "text/cql-identifier",
"expression" : "Primary series is complete. Client is due for cholera booster dose"
}
}
],
"definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTMR",
"dynamicValue" : [
{
"path" : "status",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'draft'"
}
},
{
"path" : "intent",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'proposal'"
}
},
{
"path" : "medication",
"expression" : {
"language" : "text/cql-expression",
"expression" : "Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE2', display: 'Cholera vaccines' } }, display: 'Cholera vaccines' }"
}
}
]
},
{
"title" : "Check for Guidance for the patient regarding IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses.",
"description" : "Show Guidance for the patient regarding IMMZ.D2.DT.Cholera.WC-rBS vaccine 3 doses.",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Has Guidance",
"language" : "text/cql-identifier",
"expression" : "Has Guidance"
}
}
],
"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" : "Guidance"
}
},
{
"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' }"
}
}
]
}
]
}