IMMZD18SCholeraWCVaccines
type: PlanDefinition
node role: treeRoot
id:
  v: IMMZD18SCholeraWCVaccines
meta:
  profile:
    v: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-recommendationdefinition
    l: cpg-recommendationdefinition
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableplandefinition
    l: crmi-shareableplandefinition
  profile:
    v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableplandefinition
    l: crmi-publishableplandefinition
text:
  status:
    v: extensions
  div:
    v: Id: IMMZD18SCholeraWCVaccines Url: IMMZ.D18.S.Cholera.WC vaccines schedule Version: 0.2.0 Title: IMMZ.D18.S.Cholera.WC vaccines schedule Status: draft Type: system: http://terminology.hl7.org/CodeSystem/plan-definition-type code: eca-rule Date: 2026-03-25 23:30:34+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: IMMZD18SCholeraWCVaccinesLogic Actions: Cholera dose 1: Provision of the cholera dose 1 Trigger event: Child's birth and no cholera doses have been administered Trigger pseudo: 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 Trigger pseudo: 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 …
contained: Library
  id:
    v: effective-data-requirements
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: Doses Administered to Patient
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /** * @dataElement All Doses Administered to Patient */ define "Doses Administered to Patient": [Immunization] I where I.status = 'completed' and I.isSubpotent is not true
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 0
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZEncounterElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: Doses Administered to Patient
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /** * @dataElement All Doses Administered to Patient */ define "Doses Administered to Patient": Elements."Doses Administered to Patient" I where I.occurrence.toInterval() same day or before Today
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 1
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZD2DTCholeraEncounterElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: Cholera Doses Administered to Patient
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /* @internal: Cholera containing Doses Administered to Patient */ define "Cholera Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."Cholera vaccines"
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 2
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZD2DTCholeraEncounterElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: Cholera Primary Series Doses Administered to Patient
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /* @internal: Cholera containing Doses Administered to Patient that are in the Primary series */ define "Cholera Primary Series Doses Administered to Patient": "Cholera Doses Administered to Patient".seriesPrimary()
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 3
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZD2DTCholeraEncounterElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: Number of Cholera Primary Series Doses Administered
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /* @internal: Number of Cholera Primary Series doses */ define "Number of Cholera Primary Series Doses Administered": Count("Cholera Primary Series Doses Administered to Patient")
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 4
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZD2DTCholeraEncounterElements
    extension:
      url:
        v: name
        l: name
      value: String
        v: One cholera primary series dose was administered
    extension:
      url:
        v: statement
        l: statement
      value: String
        v: /* @input: One cholera primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 1 @code: One cholera primary series dose was administered-116 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule */ define "One cholera primary series dose was administered": "Number of Cholera Primary Series Doses Administered" = 1
    extension:
      url:
        v: displaySequence
        l: displaySequence
      value: Integer
        v: 5
    url:
      v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
      l: cqf-logicDefinition
  extension:
    extension:
      url:
        v: libraryName
        l: libraryName
      value: String
        v: IMMZD18SCholeraWCVaccinesLogic
    extension:
      url:
        v: name
        l: name
      value: String
        v: First cholera dose was administered

url:
  v: statement
  l: statement
value: String
  v: /* @complete: First cholera dose was administered @pseudocode: 'Latest "Dose number" (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 1 */ define "First cholera dose was administered": Encounter."One cholera primary series dose was administered"

url:
  v: displaySequence
  l: displaySequence
value: Integer
  v: 6

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Two cholera primary series doses were administered
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @input: Two cholera primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 2 @code: Two cholera primary series doses were administered-116 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule */ define "Two cholera primary series doses were administered": "Number of Cholera Primary Series Doses Administered" = 2
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 7
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: The primary series has been completed
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @complete: The primary series has been completed @pseudocode: "Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE */ define "The primary series has been completed": Encounter."Two cholera primary series doses were administered"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 8
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 2
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera dose 2 @description: Provision of the cholera dose 2 @trigger: First cholera dose administered @pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Primary series") = 1 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") */ define "Cholera dose 2": "First cholera dose was administered" and not "The primary series has been completed"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 9
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Date of Latest Cholera Dose
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @internal: Date of Latest Cholera Dose */ define "Date of Latest Cholera Dose": date from start of "Cholera Doses Administered to Patient".mostRecent().occurrence.toInterval()
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 10
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 2 Due Date
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @dynamicValue: Cholera dose 2 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 2 weeks */ define "Cholera dose 2 Due Date": if "Cholera dose 2" then Encounter."Date of Latest Cholera Dose" + 2 weeks else null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 11
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 2 Create
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera dose 2 Create @create: WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year. */ define "Cholera dose 2 Create": if "Cholera dose 2" then 'WC vaccines: 2 doses should be given 14 days apart to individuals aged ≥ 1 year.' + ' Due Date: ' + ToString("Cholera dose 2 Due Date") else ''
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 12
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera Booster Series Doses Administered to Patient
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @internal: Cholera Booster Series Doses Administered to Patient */ define "Cholera Booster Series Doses Administered to Patient": "Cholera Doses Administered to Patient".seriesBooster()
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 13
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Number of Cholera Booster Series Doses Administered
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @internal: Number of Cholera Booster Series Doses Administered */ define "Number of Cholera Booster Series Doses Administered": Count("Cholera Booster Series Doses Administered to Patient")
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 14
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: At least one booster series dose was administered
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @input: At least one booster series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Booster dose") >= 1 @code: At least one booster series dose was administered-115 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule */ define "At least one booster series dose was administered": "Number of Cholera Booster Series Doses Administered" >= 1
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 15
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Dose number of the latest dose is one
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @input: Dose number of the latest dose is one @pseudocode: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 1 @code: Dose number of the latest dose is one-68 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule */ define "Dose number of the latest dose is one": "Cholera Doses Administered to Patient".mostRecent().getDose('1') is not null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 16
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: First cholera booster dose was administered
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @complete: First cholera booster dose was administered @pseudocode: 'Latest "Dose number" (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Booster dose") = 1 */ define "First cholera booster dose was administered": Encounter."At least one booster series dose was administered" and Encounter."Dose number of the latest dose is one"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 17
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 1
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera booster dose 1 @description: Provision of the cholera booster dose 1 @trigger: Primary series for cholera has been completed and latest cholera dose was administered more than 3 years ago @pseudo: "Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ≥ 3 years @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") */ define "Cholera booster dose 1": "The primary series has been completed" and not "First cholera booster dose was administered"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 18
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 1 Due Date
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @dynamicValue: Cholera booster dose 1 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 2 weeks */ define "Cholera booster dose 1 Due Date": if "Cholera booster dose 1" then Encounter."Date of Latest Cholera Dose" + 3 years else null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 19
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 1 Create
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera booster dose 1 Create @create: For WC vaccines, revaccination is recommended after 3 years. */ define "Cholera booster dose 1 Create": if "Cholera booster dose 1" then 'For WC vaccines, revaccination is recommended after 3 years.' + ' Due Date: ' + ToString("Cholera booster dose 1 Due Date") else ''
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 20
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: Dose number of the latest dose is two
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @input: Dose number of the latest dose is two @pseudocode: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines") = 2 @code: Dose number of the latest dose is two-68 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule */ define "Dose number of the latest dose is two": "Cholera Doses Administered to Patient".mostRecent().getDose('2') is not null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 21
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Revaccination with booster series has been completed in the last 3 years
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @complete: Revaccination with booster series has been completed in the last 3 years @pseudocode: "Completed the booster series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccine") < 3 years */ define "Revaccination with booster series has been completed in the last 3 years": Encounter."At least one booster series dose was administered" and Encounter."Dose number of the latest dose is two"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 22
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 2
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera booster dose 2 @description: Provision of the cholera booster dose 1 @trigger: First cholera booster dose administered @pseudo: Latest "Dose number" (where "Vaccine type" = "Cholera vaccines"and "Type of dose" = "Booster dose") = 1 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") */ define "Cholera booster dose 2": "First cholera booster dose was administered" and not "Revaccination with booster series has been completed in the last 3 years"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 23
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD2DTCholeraEncounterElements
extension:
  url:
    v: name
    l: name
  value: String
    v: No cholera primary series dose was administered
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @input: No cholera primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 0 @code: No cholera primary series dose was administered-116 @decision: IMMZ.D2.DT.Cholera.WC vaccines: Whole-cell (WC) vaccines schedule @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 @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 */ define "No cholera primary series dose was administered": "Number of Cholera Primary Series Doses Administered" = 0
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 24
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 1
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera dose 1 @description: Provision of the cholera dose 1 @trigger: Child's birth and no cholera doses have been administered @pseudo: Child's birth AND Count of vaccines administered (where "Vaccine type" = "Cholera vaccines" and "Type of dose" = "Primary series") = 0 @triggerDate: "Date of birth" OR Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") */ define "Cholera dose 1": Encounter."No cholera primary series dose was administered" and not "First cholera dose was administered"
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 25
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 2 Due Date
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @dynamicValue: Cholera booster dose 2 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") + 3 years */ define "Cholera booster dose 2 Due Date": if "Cholera booster dose 2" then Encounter."Date of Latest Cholera Dose" + 2 weeks else null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 26
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera booster dose 2 Create
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera booster dose 2 Create @create: For WC vaccines, revaccination is recommended after 3 years. */ define "Cholera booster dose 2 Create": if "Cholera booster dose 2" then 'For WC vaccines, revaccination is recommended after 3 years.' + ' Due Date: ' + ToString("Cholera booster dose 2 Due Date") else ''
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 27
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 1 Due Date
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @dynamicValue: Cholera dose 1 Due Date @pseudocode: "Date of birth" + 1 year */ define "Cholera dose 1 Due Date": if "Cholera dose 1" then Patient.birthDate + 1 year else null
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 28
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZD18SCholeraWCVaccinesLogic
extension:
  url:
    v: name
    l: name
  value: String
    v: Cholera dose 1 Create
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /* @output: Cholera dose 1 Create @create: 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. */ define "Cholera dose 1 Create": if "Cholera dose 1" then '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.' + ' Due Date: ' + ToString("Cholera dose 1 Due Date") else ''
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 29
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZCommon
extension:
  url:
    v: name
    l: name
  value: String
    v: seriesPrimary
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /** * @description: Gets the doses from the primary series */ define fluent function seriesPrimary(immunizations List<Immunization>): immunizations I where exists( I.protocolApplied pa where pa.series = 'Primary series' )
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 30
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToString
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToString(value string): value.value
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 31
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToString
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToString(value ImmunizationStatus): value.value
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 32
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToBoolean
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToBoolean(value boolean): value.value
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 33
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToConcept
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToConcept(concept FHIR.CodeableConcept): if concept is null then null else System.Concept { codes: concept.coding C return ToCode(C), display: concept.text.value }
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 34
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToCode
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToCode(coding FHIR.Coding): if coding is null then null else System.Code { code: coding.code.value, system: coding.system.value, version: coding.version.value, display: coding.display.value }
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 35
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: WHOCommon
extension:
  url:
    v: name
    l: name
  value: String
    v: mostRecent
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define fluent function mostRecent(immunizations List<Immunization>): Last( immunizations I sort by start of occurrence.toInterval() )
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 36
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZCommon
extension:
  url:
    v: name
    l: name
  value: String
    v: seriesBooster
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /** * @description: Gets the doses from the Booster series */ define fluent function seriesBooster(immunizations List<Immunization>): immunizations I where exists( I.protocolApplied pa where pa.series = 'Booster dose' )
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 37
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: IMMZCommon
extension:
  url:
    v: name
    l: name
  value: String
    v: getDose
extension:
  url:
    v: statement
    l: statement
  value: String
    v: /** * @description: Gets a given immunization from a list that matches the dose number */ define fluent function getDose(immunization Immunization, doseNumber String): immunization I where exists( I.protocolApplied pa where pa.doseNumber = doseNumber )
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 38
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

extension:
  url:
    v: libraryName
    l: libraryName
  value: String
    v: FHIRHelpers
extension:
  url:
    v: name
    l: name
  value: String
    v: ToDate
extension:
  url:
    v: statement
    l: statement
  value: String
    v: define function ToDate(value date): value.value
extension:
  url:
    v: displaySequence
    l: displaySequence
  value: Integer
    v: 39
url:
  v: http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition
  l: cqf-logicDefinition

v: EffectiveDataRequirements

v: active

coding:
  system:
    v: http://terminology.hl7.org/CodeSystem/library-type
    l: library-type
  code:
    v: module-definition

type:
  v: depends-on
display:
  v: FHIR model information
resource:
  v: http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1
  l: http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo

type:
  v: depends-on
display:
  v: Library Encounter
resource:
  v: http://smart.who.int/immunizations/Library/IMMZD2DTCholeraEncounterElements
  l: IMMZD2DTCholeraEncounterElements

type:
  v: depends-on
display:
  v: Library Common
resource:
  v: http://smart.who.int/immunizations/Library/IMMZCommon
  l: IMMZCommon

type:
  v: depends-on
display:
  v: Library FHIRHelpers
resource:
  v: http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1
  l: http://fhir.org/guides/cqf/common/Library/FHIRHelpers

type:
  v: depends-on
display:
  v: Library Encounter
resource:
  v: http://smart.who.int/immunizations/Library/IMMZEncounterElements
  l: IMMZEncounterElements

type:
  v: depends-on
display:
  v: Library Elements
resource:
  v: http://smart.who.int/immunizations/Library/IMMZElements
  l: IMMZElements

type:
  v: depends-on
display:
  v: Library WC
resource:
  v: http://smart.who.int/immunizations/Library/WHOCommon
  l: WHOCommon

type:
  v: depends-on
display:
  v: Library FHIRHelpers
resource:
  v: http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1
  l: http://fhir.org/guides/cqf/common/Library/FHIRHelpers

type:
  v: depends-on
display:
  v: Library Concepts
resource:
  v: http://smart.who.int/immunizations/Library/IMMZConcepts
  l: IMMZConcepts

type:
  v: depends-on
display:
  v: Library WC
resource:
  v: http://smart.who.int/immunizations/Library/WHOCommon
  l: WHOCommon

type:
  v: depends-on
display:
  v: Value set Cholera vaccines
resource:
  v: http://smart.who.int/immunizations/ValueSet/IMMZ.Z.DE2
  l: IMMZ.Z.DE2

name:
  v: Today
use:
  v: in
min:
  v: 0
max:
  v: 1
type:
  v: date

name:
  v: Cholera dose 2 Create
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: string

name:
  v: Cholera dose 2
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: boolean

name:
  v: Cholera booster dose 1 Create
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: string

name:
  v: Cholera booster dose 2
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: boolean

name:
  v: Cholera dose 1
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: boolean

name:
  v: Cholera booster dose 1
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: boolean

name:
  v: Cholera booster dose 2 Create
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: string

name:
  v: Cholera dose 1 Create
use:
  v: out
min:
  v: 0
max:
  v: 1
type:
  v: string

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence
must support:
  v: vaccineCode

type:
  v: Patient
profile:
  v: http://hl7.org/fhir/StructureDefinition/Patient
  l: Patient

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence
must support:
  v: vaccineCode

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence
must support:
  v: vaccineCode

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence
must support:
  v: vaccineCode

type:
  v: Immunization
profile:
  v: http://hl7.org/fhir/StructureDefinition/Immunization
  l: Immunization
must support:
  v: status
must support:
  v: isSubpotent
must support:
  v: occurrence
must support:
  v: vaccineCode

url:
  v: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability
  l: cpg-knowledgeCapability
value: Code
  v: computable

url:
  v: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-effectiveDataRequirements
  l: crmi-effectiveDataRequirements
value: Canonical
  v: #effective-data-requirements
  l: effective-data-requirements

v: 0.2.0

v: IMMZD18SCholeraWCVaccines

v: IMMZ.D18.S.Cholera.WC vaccines schedule

coding:
  system:
    v: http://terminology.hl7.org/CodeSystem/plan-definition-type
    l: plan-definition-type
  code:
    v: eca-rule

v: draft

v: false

v: 2026-03-25T23:30:34+00:00

v: WHO

name:
  v: WHO
telecom:
  system:
    v: url
  value:
    v: http://who.int

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

type:
  v: citation
citation:
  v: WHO recommendations for routine immunization - summary tables (January 2025)

title:
  v: Cholera dose 1
description:
  v: Provision of the cholera dose 1 Trigger event: Child's birth and no cholera doses have been administered Trigger pseudo: 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.
condition:
  kind:
    v: applicability
  expression:
    description:
      v: Cholera dose 1
    language:
      v: text/cql-identifier
    expression:
      v: Cholera dose 1
definition: Canonical
  v: http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR
  l: IMMZD2DTCR
dynamic value:
  path:
    v: status
  expression:
    language:
      v: text/cql-expression
    expression:
      v: 'active'
dynamic value:
  path:
    v: payload.contentString
  expression:
    language:
      v: text/cql-identifier
    expression:
      v: Cholera dose 1 Create
dynamic value:
  path:
    v: category.coding
  expression:
    description:
      v: Category of communication
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
dynamic value:
  path:
    v: priority
  expression:
    description:
      v: Alert priority
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }

title:
  v: Cholera dose 2
description:
  v: Provision of the cholera dose 2 Trigger event: First cholera dose administered Trigger pseudo: 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.
condition:
  kind:
    v: applicability
  expression:
    description:
      v: Cholera dose 2
    language:
      v: text/cql-identifier
    expression:
      v: Cholera dose 2
definition: Canonical
  v: http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR
  l: IMMZD2DTCR
dynamic value:
  path:
    v: status
  expression:
    language:
      v: text/cql-expression
    expression:
      v: 'active'
dynamic value:
  path:
    v: payload.contentString
  expression:
    language:
      v: text/cql-identifier
    expression:
      v: Cholera dose 2 Create
dynamic value:
  path:
    v: category.coding
  expression:
    description:
      v: Category of communication
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
dynamic value:
  path:
    v: priority
  expression:
    description:
      v: Alert priority
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }

title:
  v: Cholera booster dose 1
description:
  v: 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 Trigger pseudo: "Completed the primary vaccination series" (where "Vaccine type" = "Cholera vaccines") = TRUE AND Today's date − latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") ≥ 3 years Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Cholera vaccines") Create condition: For WC vaccines, revaccination is recommended after 3 years.
condition:
  kind:
    v: applicability
  expression:
    description:
      v: Cholera booster dose 1
    language:
      v: text/cql-identifier
    expression:
      v: Cholera booster dose 1
definition: Canonical
  v: http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR
  l: IMMZD2DTCR
dynamic value:
  path:
    v: status
  expression:
    language:
      v: text/cql-expression
    expression:
      v: 'active'
dynamic value:
  path:
    v: payload.contentString
  expression:
    language:
      v: text/cql-identifier
    expression:
      v: Cholera booster dose 1 Create
dynamic value:
  path:
    v: category.coding
  expression:
    description:
      v: Category of communication
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
dynamic value:
  path:
    v: priority
  expression:
    description:
      v: Alert priority
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }

title:
  v: Cholera booster dose 2
description:
  v: Provision of the cholera booster dose 1 Trigger event: First cholera booster dose administered Trigger pseudo: 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.
condition:
  kind:
    v: applicability
  expression:
    description:
      v: Cholera booster dose 2
    language:
      v: text/cql-identifier
    expression:
      v: Cholera booster dose 2
definition: Canonical
  v: http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR
  l: IMMZD2DTCR
dynamic value:
  path:
    v: status
  expression:
    language:
      v: text/cql-expression
    expression:
      v: 'active'
dynamic value:
  path:
    v: payload.contentString
  expression:
    language:
      v: text/cql-identifier
    expression:
      v: Cholera booster dose 2 Create
dynamic value:
  path:
    v: category.coding
  expression:
    description:
      v: Category of communication
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
dynamic value:
  path:
    v: priority
  expression:
    description:
      v: Alert priority
    language:
      v: text/cql-expression
    expression:
      v: Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }