Id: IMMZD18STyphoidTy21a Url: IMMZ.D18.S.Typhoid.Ty21a schedule Version: 1.0.0 Title: IMMZ.D18.S.Typhoid.Ty21a schedule Status: draft Type: system: http://terminology.hl7.org/CodeSystem/plan-definition-type code: eca-rule Date: 2026-03-31 13:54:17+0000 Publisher: WHO Description: IMMZ.D18.S.Typhoid.Ty21a schedule Live attenuated Ty21a vaccine, 3-dose schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18STyphoidTy21aLogic Actions: Typhoid Ty21a primary series: Provision of the typhoid Ty21a, 3-dose oral primary series immunization Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Ty21a – 3-doses to be administered orally every second day from 6 years of age. If: Applicability: Typhoid Ty21a primary series (Typhoid Ty21a primary series) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Typhoid Ty21a primary series 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' }) Typhoid booster dose(s) repeat 3-doses series: Provision of the typhoid booster dose(s): revaccination Trigger event: The primary series has been completed Trigger pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") Create condition: Revaccination (3-doses) is recommended every 3–7 years for Ty21a. If: Applicability: Typhoid booster dose(s) repeat 3-doses series (Typhoid booster dose(s) repeat 3-doses series) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Typhoid booster dose(s) repeat 3-doses series 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' })
Completed the primary vaccination series
/** * @dataElement All Doses Administered to Patient */ define "Doses Administered to Patient": [Immunization] I where I.status = 'completed' and I.isSubpotent is not true
/** * @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
/* @internal: Typhoid containing Doses Administered to Patient */ define "Typhoid Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."Typhoid vaccines"
Typhoid Primary Series Doses Administered to Patient
/* @internal: Typhoid containing Doses Administered to Patient that are in the Primary series */ define "Typhoid Primary Series Doses Administered to Patient": "Typhoid Doses Administered to Patient".seriesPrimary()
Number of Typhoid Primary Series Doses Administered
/* @internal: Number of Typhoid Primary Series doses */ define "Number of Typhoid Primary Series Doses Administered": Count("Typhoid Primary Series Doses Administered to Patient")
One typhoid primary series dose was administered
/* @input: One typhoid primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Typhoid vaccines" and "Type of dose" = "Primary series") = 1 @code: One typhoid primary series dose was administered-116 @decision: IMMZ.D2.DT.Typhoid.TCV: Typhoid conjugate vaccine (TCV) schedule @decision: IMMZ.D2.DT.Typhoid.ViPS: Unconjugated Vi polysaccharide (ViPS) schedule */ define "One typhoid primary series dose was administered": "Number of Typhoid Primary Series Doses Administered" = 1
Completed the primary vaccination series Observation
/* @internal: Completed the primary vaccination series Observation */ define "Completed the primary vaccination series Observation": ([Observation: Concepts."Completed the primary vaccination series"]).complete()
/* @internal: Completed the primary vaccination series Observation */ define "Completed the primary vaccination series Observation": Elements."Completed the primary vaccination series Observation".encounterOrOnBefore(EncounterId, Today)
/* @input: Primary series is complete @pseudocode: "Completed the primary vaccination series" (where "Vaccine type" = "Typhoid vaccines") = TRUE @code: Primary series is complete-93 @decision: IMMZ.D2.DT.Typhoid.Ty21a: Live attenuated Ty21a vaccine schedule */ define "Primary series is complete": "One typhoid primary series dose was administered" or Coalesce( "Typhoid Doses Administered to Patient" Dose aggregate Result: Encounter."Completed the primary vaccination series Observation".partOf.references(Dose) or Result, false )
/* @complete: The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") */ define "The primary series has been completed": Encounter."Primary series is complete"
Typhoid booster dose(s) repeat 3-doses series
/* @output: Typhoid booster dose(s) repeat 3-doses series @description: Provision of the typhoid booster dose(s): revaccination @trigger: The primary series has been completed @pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") */ define "Typhoid booster dose(s) repeat 3-doses series": "The primary series has been completed"
/* @internal: Date of Latest Typhoid Dose */ define "Date of Latest Typhoid Dose": date from start of "Typhoid Doses Administered to Patient".mostRecent().occurrence.toInterval()
Typhoid booster dose(s) repeat 3-doses series Due Date
/* @dynamicValue: Typhoid booster dose(s) repeat 3-doses series Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") + 3 years */ define "Typhoid booster dose(s) repeat 3-doses series Due Date": if "Typhoid booster dose(s) repeat 3-doses series" then Encounter."Date of Latest Typhoid Dose" + 3 years else null
Typhoid booster dose(s) repeat 3-doses series Overdue
/* @dynamicValue: Typhoid booster dose(s) repeat 3-doses series Overdue @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") + 7 years */ define "Typhoid booster dose(s) repeat 3-doses series Overdue": if "Typhoid booster dose(s) repeat 3-doses series" then Encounter."Date of Latest Typhoid Dose" + 7 years else null
Typhoid booster dose(s) repeat 3-doses series Create
/* @output: Typhoid booster dose(s) repeat 3-doses series Create @create: Revaccination (3-doses) is recommended every 3–7 years for Ty21a. */ define "Typhoid booster dose(s) repeat 3-doses series Create": if "Typhoid booster dose(s) repeat 3-doses series" then 'Revaccination (3-doses) is recommended every 3–7 years for Ty21a.' + ' Due Date: ' + ToString("Typhoid booster dose(s) repeat 3-doses series Due Date") + ' Overdue: ' + ToString("Typhoid booster dose(s) repeat 3-doses series Overdue") else ''
No typhoid primary series doses were administered
/* @input: No typhoid primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Typhoid vaccines" and "Type of dose" = "Primary series") = 0 @code: No typhoid primary series doses were administered-116 @decision: IMMZ.D2.DT.Typhoid.TCV: Typhoid conjugate vaccine (TCV) schedule @decision: IMMZ.D2.DT.Typhoid.ViPS: Unconjugated Vi polysaccharide (ViPS) schedule */ define "No typhoid primary series doses were administered": "Number of Typhoid Primary Series Doses Administered" = 0
/* @output: Typhoid Ty21a primary series @description: Provision of the typhoid Ty21a, 3-dose oral primary series immunization @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "Typhoid Ty21a primary series": Encounter."No typhoid primary series doses were administered" and not "The primary series has been completed"
/* @dynamicValue: Typhoid Ty21a primary series Due Date @pseudocode: "Date of birth" + 6 years */ define "Typhoid Ty21a primary series Due Date": if "Typhoid Ty21a primary series" then Patient.birthDate + 6 years else null
/* @output: Typhoid Ty21a primary series Create @create: Ty21a – 3-doses to be administered orally every second day from 6 years of age. */ define "Typhoid Ty21a primary series Create": if "Typhoid Ty21a primary series" then 'Ty21a – 3-doses to be administered orally every second day from 6 years of age.' + ' Due Date: ' + ToString("Typhoid Ty21a primary series Due Date") else ''
/** * @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' )
define function ToString(value string): value.value
define function ToString(value ImmunizationStatus): value.value
define function ToBoolean(value boolean): value.value
/* From FHIRCommon 4.1.0: */ /* @description: Normalizes a value that is a choice of timing-valued types to an equivalent interval @comment: Normalizes a choice type of FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instance, FHIR.string, FHIR.Age, or FHIR.Range types to an equivalent interval. This selection of choice types is a superset of the majority of choice types that are used as possible representations for timing-valued elements in FHIR, allowing this function to be used across any resource. The input can be provided as a dateTime, Period, Timing, instant, string, Age, or Range. The intent of this function is to provide a clear and concise mechanism to treat single elements that have multiple possible representations as intervals so that logic doesn't have to account for the variability. More complex calculations (such as medication request period or dispense period calculation) need specific guidance and consideration. That guidance may make use of this function, but the focus of this function is on single element calculations where the semantics are unambiguous. If the input is a dateTime, the result a DateTime Interval beginning and ending on that dateTime. If the input is a Period, the result is a DateTime Interval. If the input is a Timing, an error is raised indicating a single interval cannot be computed from a Timing. If the input is an instant, the result is a DateTime Interval beginning and ending on that instant. If the input is a string, an error is raised indicating a single interval cannot be computed from a string. If the input is an Age, the result is a DateTime Interval beginning when the patient was the given Age, and ending immediately prior to when the patient was the given Age plus one year. If the input is a Range, the result is a DateTime Interval beginning when the patient was the Age given by the low end of the Range, and ending immediately prior to when the patient was the Age given by the high end of the Range plus one year. NOTE: Due to the complexity of determining a single interval from a Timing or String type, this function will throw a run-time exception if it is used with a Timing or String. */ define fluent function toInterval(choice Choice<FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instant, FHIR.string, FHIR.Age, FHIR.Range>): case when choice is FHIR.dateTime then Interval[FHIRHelpers.ToDateTime(choice as FHIR.dateTime), FHIRHelpers.ToDateTime(choice as FHIR.dateTime)] when choice is FHIR.Period then FHIRHelpers.ToInterval(choice as FHIR.Period) when choice is FHIR.instant then Interval[FHIRHelpers.ToDateTime(choice as FHIR.instant), FHIRHelpers.ToDateTime(choice as FHIR.instant)] when choice is FHIR.Age then Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age), FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age) + 1 year) when choice is FHIR.Range then Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).low), FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).high) + 1 year) when choice is FHIR.Timing then Message(null as Interval<DateTime>, true, 'NOT_IMPLEMENTED', 'Error', 'Calculation of an interval from a Timing value is not supported') when choice is FHIR.string then Message(null as Interval<DateTime>, true, 'NOT_IMPLEMENTED', 'Error', 'Calculation of an interval from a String value is not supported') else null as Interval<DateTime> end
define function ToDateTime(value dateTime): value.value
define function ToInterval(period FHIR.Period): if period is null then null else if period."start" is null then Interval(period."start".value, period."end".value] else Interval[period."start".value, period."end".value]
define function ToDateTime(value instant): value.value
define function ToDate(value date): value.value
define function ToQuantity(quantity FHIR.Quantity): case when quantity is null then null when quantity.value is null then null when quantity.comparator is not null then Message(null, true, 'FHIRHelpers.ToQuantity.ComparatorQuantityNotSupported', 'Error', 'FHIR Quantity value has a comparator and cannot be converted to a System.Quantity value.') when quantity.system is null or quantity.system.value = 'http://unitsofmeasure.org' or quantity.system.value = 'http://hl7.org/fhirpath/CodeSystem/calendar-units' then System.Quantity { value: quantity.value.value, unit: ToCalendarUnit(Coalesce(quantity.code.value, quantity.unit.value, '1')) } else Message(null, true, 'FHIRHelpers.ToQuantity.InvalidFHIRQuantity', 'Error', 'Invalid FHIR Quantity code: ' & quantity.unit.value & ' (' & quantity.system.value & '|' & quantity.code.value & ')') end
define function ToCalendarUnit(unit System.String): case unit when 'ms' then 'millisecond' when 's' then 'second' when 'min' then 'minute' when 'h' then 'hour' when 'd' then 'day' when 'wk' then 'week' when 'mo' then 'month' when 'a' then 'year' else unit end
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 }
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 }
/* @description: Returns true if any of the given references are to the given resource @comment: Returns true if the `id` element of the given resource exactly equals the tail of any of the given references. NOTE: This function assumes resources from the same source server. */ define fluent function references(references List<FHIR.Reference>, resource FHIR.Resource): exists (references R where R.references(resource))
/* @description: Returns true if the given reference is to the given resource @comment: Returns true if the `id` element of the given resource exactly equals the tail of the given reference. NOTE: This function assumes resources from the same source server. */ define fluent function references(reference FHIR.Reference, resource FHIR.Resource): resource.id = Last(Split(reference.reference, '/'))
/** * @description: Gets observation from an encounter or on or before a date */ define fluent function encounterOrOnBefore(observations List<Observation>, EncounterId String, beforeDate Date): observations O where (O.encounter.references(EncounterId) or O.effective.toInterval() starts same day or before beforeDate)
/* @description: Returns true if the given reference is to the given resourceId @comment: Returns true if the `resourceId` parameter exactly equals the tail of the given reference. NOTE: This function assumes resources from the same source server. */ define fluent function references(reference FHIR.Reference, resourceId String): resourceId = Last(Split(reference.reference, '/'))
define fluent function complete(observations List<Observation>): observations O where O.status in { 'final', 'amended', 'corrected' }
define function ToString(value ObservationStatus): value.value
define fluent function mostRecent(immunizations List<Immunization>): Last( immunizations I sort by start of occurrence.toInterval() )
IMMZ.D18.S.Typhoid.Ty21a schedule Live attenuated Ty21a vaccine, 3-dose schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of the typhoid Ty21a, 3-dose oral primary series immunization Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Ty21a – 3-doses to be administered orally every second day from 6 years of age.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }
Provision of the typhoid booster dose(s): revaccination Trigger event: The primary series has been completed Trigger pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") Create condition: Revaccination (3-doses) is recommended every 3–7 years for Ty21a.