FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: PlanDefinition/IMMZD18SCholeraWC

Packagesmart.who.int.immunizations
Resource TypePlanDefinition
IdIMMZD18SCholeraWC
FHIR VersionR4
Sourcehttp://smart.who.int/immunizations/https://build.fhir.org/ig/WorldHealthOrganization/smart-immunizations/PlanDefinition-IMMZD18SCholeraWC.html
URLhttp://smart.who.int/immunizations/PlanDefinition/IMMZD18SCholeraWC
Version0.2.0
Statusdraft
Date2025-08-08T19:12:11+00:00
NameIMMZD18SCholeraWC
TitleIMMZ.D18.S.Cholera.WC vaccines schedule
Authoritywho
DescriptionIMMZ.D18.S.Cholera.WC vaccines schedule Whole-cell (WC) vaccines (Shanchol, Euvchol and mORCVAX), 2-dose schedule

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Id: IMMZD18SCholeraWC
Url: IMMZ.D18.S.Cholera.WC vaccines schedule
Version: 0.2.0
Title: IMMZ.D18.S.Cholera.WC vaccines schedule
Status: draft
Type:

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

code: eca-rule

Date: 2025-08-08 19:12:11+0000
Publisher: WHO
Description:

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

Knowledge Capability: computable
Related Artifacts:

References

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


Libraries:
IMMZD18SCholeraWCLogic
Actions:
Cholera dose 1: Provision of the cholera dose 1 Trigger event: Child's birth and no cholera doses have been administered Child's birth AND Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 0 Trigger date: "Date of birth" OR Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") Create condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year. Revaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.
If: Applicability: Cholera dose 1 (Cholera dose 1)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Cholera dose 1 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })
Cholera dose 2: Provision of the cholera dose 2 Trigger event: First cholera dose administered Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Primary series") = 1 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") Create condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.
If: Applicability: Cholera dose 2 (Cholera dose 2)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Cholera dose 2 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })
Cholera booster dose 1: Provision of the cholera booster dose 1 Trigger event: Primary series for cholera has been completed and latest cholera dose was administered more than 3 years ago "Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ≥ 3 years Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") Create condition: For WC vaccines, revaccination is recommended after 3 years.
If: Applicability: Cholera booster dose 1 (Cholera booster dose 1)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Cholera booster dose 1 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })
Cholera booster dose 2: Provision of the cholera booster dose 1 Trigger event: First cholera booster dose administered Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Booster dose") = 1 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") Create condition: For WC vaccines, revaccination is recommended after 3 years.
If: Applicability: Cholera booster dose 2 (Cholera booster dose 2)
Then: Definition: IMMZ.D2.DT.CR
Dynamic Values:
status: ('active')
payload.contentString: (Cholera booster dose 2 Create)
category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })
priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })

Source

{
  "resourceType": "PlanDefinition",
  "id": "IMMZD18SCholeraWC",
  "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": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability",
      "valueCode": "computable"
    }
  ],
  "url": "http://smart.who.int/immunizations/PlanDefinition/IMMZD18SCholeraWC",
  "version": "0.2.0",
  "name": "IMMZD18SCholeraWC",
  "title": "IMMZ.D18.S.Cholera.WC vaccines schedule",
  "type": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code": "eca-rule"
      }
    ]
  },
  "status": "draft",
  "experimental": false,
  "date": "2025-08-08T19:12:11+00:00",
  "publisher": "WHO",
  "contact": [
    {
      "name": "WHO",
      "telecom": [
        {
          "system": "url",
          "value": "http://who.int"
        }
      ]
    }
  ],
  "description": "IMMZ.D18.S.Cholera.WC vaccines schedule\nWhole-cell (WC) vaccines (Shanchol, Euvchol and mORCVAX), 2-dose schedule",
  "relatedArtifact": [
    {
      "type": "citation",
      "citation": "WHO recommendations for routine immunization - summary tables (January 2025)"
    }
  ],
  "library": [
    "http://smart.who.int/immunizations/Library/IMMZD18SCholeraWCLogic"
  ],
  "action": [
    {
      "title": "Cholera dose 1",
      "description": "Provision of the cholera dose 1\nTrigger event: Child's birth and no cholera doses have been administered\nChild's birth AND Count of vaccines administered (where \"Vaccine type\" = \"Cholera vaccines\" and \"Type of dose\" = \"Primary series\") = 0\nTrigger date: \"Date of birth\"\nOR\nLatest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.\nRevaccination is recommended where there is continued risk of Vibrio cholerae infection. For WC vaccines, revaccination is recommended after 3 years.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Cholera dose 1",
            "language": "text/cql-identifier",
            "expression": "Cholera dose 1"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Cholera dose 1 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    },
    {
      "title": "Cholera dose 2",
      "description": "Provision of the cholera dose 2\nTrigger event: First cholera dose administered\nLatest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Primary series\") = 1\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Cholera dose 2",
            "language": "text/cql-identifier",
            "expression": "Cholera dose 2"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Cholera dose 2 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    },
    {
      "title": "Cholera booster dose 1",
      "description": "Provision of the cholera booster dose 1\nTrigger event: Primary series for cholera has been completed and latest cholera dose was administered more than 3 years ago\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\") ≥ 3 years\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Cholera booster dose 1",
            "language": "text/cql-identifier",
            "expression": "Cholera booster dose 1"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Cholera booster dose 1 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    },
    {
      "title": "Cholera booster dose 2",
      "description": "Provision of the cholera booster dose 1\nTrigger event: First cholera booster dose administered\nLatest \"Dose number\" (where \"Vaccine type\" = \"Cholera vaccines\"and \"Type of dose\" = \"Booster dose\") = 1\nTrigger date: Latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Cholera vaccines\")\nCreate condition: For WC vaccines, revaccination is recommended after 3 years.",
      "condition": [
        {
          "kind": "applicability",
          "expression": {
            "description": "Cholera booster dose 2",
            "language": "text/cql-identifier",
            "expression": "Cholera booster dose 2"
          }
        }
      ],
      "definitionCanonical": "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
      "dynamicValue": [
        {
          "path": "status",
          "expression": {
            "language": "text/cql-expression",
            "expression": "'active'"
          }
        },
        {
          "path": "payload.contentString",
          "expression": {
            "language": "text/cql-identifier",
            "expression": "Cholera booster dose 2 Create"
          }
        },
        {
          "path": "category.coding",
          "expression": {
            "description": "Category of communication",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
          }
        },
        {
          "path": "priority",
          "expression": {
            "description": "Alert priority",
            "language": "text/cql-expression",
            "expression": "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
          }
        }
      ]
    }
  ]
}