Id: IMMZD18STyphoidViPS Url: IMMZ.D18.S.Typhoid.ViPS schedule Version: 1.0.0 Title: IMMZ.D18.S.Typhoid.ViPS 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.ViPS schedule Unconjugated Vi polysaccharide (ViPS), 1 dose schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18STyphoidViPSLogic Actions: Typhoid dose 1: Provision of the typhoid ViPS dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Typhoid dose 1 should be provided if the client's age is over 2 years, and the region recommends typhoid vaccination. If: Applicability: Typhoid dose 1 (Typhoid dose 1) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Typhoid 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' }) Typhoid booster dose(s): Provision of the typhoid ViPS booster dose 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 is recommended every 3 years for ViPS. If: Applicability: Typhoid booster dose(s) (Typhoid booster dose(s)) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Typhoid booster dose(s) 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' })
/** * @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
One typhoid dose from the primary series was administered. The primary series has been completed
/* @complete: One typhoid dose from the primary series was administered. The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") */ define "One typhoid dose from the primary series was administered. The primary series has been completed": Encounter."One typhoid primary series dose was administered"
/* @output: Typhoid booster dose(s) @description: Provision of the typhoid ViPS booster dose @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)": "One typhoid dose from the primary series was administered. The primary series has been completed"
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 dose 1 @description: Provision of the typhoid ViPS dose 1 @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "Typhoid dose 1": Encounter."No typhoid primary series doses were administered" and not "One typhoid dose from the primary series was administered. The primary series has been completed"
/* @dynamicValue: Typhoid dose 1 Due Date @pseudocode: "Date of birth" + 2 years */ define "Typhoid dose 1 Due Date": if "Typhoid dose 1" then Patient.birthDate + 2 years else null
/* @output: Typhoid dose 1 Create @create: Typhoid dose 1 should be provided if the client's age is over 2 years, and the region recommends typhoid vaccination. */ define "Typhoid dose 1 Create": if "Typhoid dose 1" then 'Typhoid dose 1 should be provided if the client\'s age is over 2 years, and the region recommends typhoid vaccination.' + ' Due Date: ' + ToString("Typhoid dose 1 Due Date") else ''
/* @internal: Date of Latest Typhoid Dose */ define "Date of Latest Typhoid Dose": date from start of "Typhoid Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: Typhoid booster dose(s) Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") + 3 years */ define "Typhoid booster dose(s) Due Date": if "Typhoid booster dose(s)" then Encounter."Date of Latest Typhoid Dose" + 3 years else null
/* @output: Typhoid booster dose(s) Create @create: Revaccination is recommended every 3 years for ViPS. */ define "Typhoid booster dose(s) Create": if "Typhoid booster dose(s)" then 'Revaccination is recommended every 3 years for ViPS.' + ' Due Date: ' + ToString("Typhoid booster dose(s) 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 }
define fluent function mostRecent(immunizations List<Immunization>): Last( immunizations I sort by start of occurrence.toInterval() )
IMMZ.D18.S.Typhoid.ViPS schedule Unconjugated Vi polysaccharide (ViPS), 1 dose schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of the typhoid ViPS dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Typhoid dose 1 should be provided if the client's age is over 2 years, and the region recommends typhoid vaccination.
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 ViPS booster dose 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 is recommended every 3 years for ViPS.