WHO Immunization Implementation Guide
0.2.0 - ci-build
WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions
| Draft as of 2025-09-17 |
{
"resourceType" : "PlanDefinition",
"id" : "IMMZD18SCholerarBS2to5",
"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;\">IMMZD18SCholerarBS2to5</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-IMMZD18SCholerarBS2to5.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/6.5.0/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;\">2025-09-17 23:03:28+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-IMMZD18SCholerarBS2to5Logic.html\">IMMZD18SCholerarBS2to5Logic</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 \nCount 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\nLatest "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\nLatest "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\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 ± 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>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability",
"valueCode" : "computable"
}
],
"url" : "http://smart.who.int/immunizations/PlanDefinition/IMMZD18SCholerarBS2to5",
"version" : "0.2.0",
"name" : "IMMZD18SCholerarBS2to5",
"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" : "2025-09-17T23:03:28+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/IMMZD18SCholerarBS2to5Logic"
],
"action" : [
{
"title" : "Cholera dose 1",
"description" : "Provision of the cholera dose 1\nTrigger event: Child's birth \nCount 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\nLatest \"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\nLatest \"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\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 ± 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' }"
}
}
]
}
]
}