Id: IMMZD2DTTyphoidTCV Url: IMMZ.D2.DT.Typhoid.TCV Version: 1.0.0 Title: IMMZ.D2.DT.Typhoid.TCV 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.D2.DT.Typhoid.TCV Typhoid conjugate vaccine (TCV) schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD2DTTyphoidTCVLogic Actions: Determine if the client is due for Typhoid.: Determine if the client is due for Typhoid vaccine according to the national immunization protocol. Typhoid conjugate vaccine (TCV) schedule If: Applicability: Client is due for Typhoid vaccination (Client is due for Typhoid vaccination) Then: Definition: IMMZD2DTMR Dynamic Values: status: ('draft') intent: ('proposal') medication: (Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE21', display: 'Typhoid vaccines' } }, display: 'Typhoid vaccines' }) Check for Guidance for the patient regarding IMMZ.D2.DT.Typhoid.TCV.: Show Guidance for the patient regarding IMMZ.D2.DT.Typhoid.TCV. If: Applicability: Has Guidance (Has Guidance) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Guidance) 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 Patient age in months */ define "Current Patient Age In Months": AgeInMonthsAt(Today)
/* @input: Client's age is less than 6 months @pseudocode: Today's date − "Date of birth" < 6 months @code: Client's age is less than 6 months-41 @decision: IMMZ.D2.DT.Typhoid.TCV: Typhoid conjugate vaccine (TCV) schedule */ define "Client's age is less than 6 months": Encounter."Current Patient Age In Months" < 6
Client is not due for Typhoid vaccination
/* @output: Client is not due for Typhoid vaccination @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for Typhoid vaccination": Encounter."Client's age is less than 6 months"
Client is not due for Typhoid vaccination Guidance
/* @output: Client is not due for Typhoid vaccination Guidance @guidance: Should not vaccinate client with typhoid dose as client's age is less than 6 months. Check for any vaccines due and inform the caregiver of when to come back for the first dose. */ define "Client is not due for Typhoid vaccination Guidance": 'Should not vaccinate client with typhoid dose as client\'s age is less than 6 months. Check for any vaccines due and inform the caregiver of when to come back for the first dose.'
/** * @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")
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
/** * @dataElement Patient age in years */ define "Current Patient Age In Years": AgeInYearsAt(Today)
Client's age is between 6 months and 45 years
/* @input: Client's age is between 6 months and 45 years @pseudocode: 6 months ≤ Today's date − "Date of birth" < 45 years @code: Client's age is between 6 months and 45 years-52 @decision: IMMZ.D2.DT.Typhoid.TCV: Typhoid conjugate vaccine (TCV) schedule */ define "Client's age is between 6 months and 45 years": 6 <= Encounter."Current Patient Age In Months" and Encounter."Current Patient Age In Years" < 45
/* @output: Client is due for Typhoid vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for Typhoid vaccination": Encounter."No typhoid primary series doses were administered" and Encounter."Client's age is between 6 months and 45 years"
Client is due for Typhoid vaccination Guidance
/* @output: Client is due for Typhoid vaccination Guidance @guidance: Should vaccinate client with typhoid dose as no typhoid doses were administered and client is within appropriate age range. Check for contraindications. */ define "Client is due for Typhoid vaccination Guidance": 'Should vaccinate client with typhoid dose as no typhoid doses were administered and client is within appropriate age range. Check for contraindications.'
Client's age is more than or equal to 45 years
/* @input: Client's age is more than or equal to 45 years @pseudocode: Today's date − "Date of birth" ≥ 45 years @code: Client's age is more than or equal to 45 years-41 @decision: IMMZ.D2.DT.Typhoid.TCV: Typhoid conjugate vaccine (TCV) schedule */ define "Client's age is more than or equal to 45 years": Encounter."Current Patient Age In Years" >= 45
Clinical judgement is required. Create a clinical note
/* @output: Clinical judgement is required. Create a clinical note @pseudocode: "Immunization recommendation status" = "Further evaluation needed" */ define "Clinical judgement is required. Create a clinical note": Encounter."No typhoid primary series doses were administered" and Encounter."Client's age is more than or equal to 45 years"
Clinical judgement is required. Create a clinical note Guidance
/* @output: Clinical judgement is required. Create a clinical note Guidance @guidance: Member States should update this action according to the national immunization programme. */ define "Clinical judgement is required. Create a clinical note Guidance": 'Member States should update this action according to the national immunization programme.'
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
Typhoid immunization schedule is complete
/* @output: Typhoid immunization schedule is complete @pseudocode: "Immunization recommendation status" = "Complete" "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines") */ define "Typhoid immunization schedule is complete": Encounter."One typhoid primary series dose was administered"
Typhoid immunization schedule is complete Guidance
/* @output: Typhoid immunization schedule is complete Guidance @guidance: Typhoid immunization schedule is complete. One typhoid primary series dose was administered. Check for any other vaccines due. */ define "Typhoid immunization schedule is complete Guidance": 'Typhoid immunization schedule is complete. One typhoid primary series dose was administered. Check for any other vaccines due.'
/* @dynamicValue: Guidance */ define "Guidance": case when "Client is not due for Typhoid vaccination" then "Client is not due for Typhoid vaccination Guidance" when "Client is due for Typhoid vaccination" then "Client is due for Typhoid vaccination Guidance" when "Clinical judgement is required. Create a clinical note" then "Clinical judgement is required. Create a clinical note Guidance" when "Typhoid immunization schedule is complete" then "Typhoid immunization schedule is complete Guidance" else '' end
define "Has Guidance": "Guidance" is not null and "Guidance" != ''
/** * @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 }
IMMZ.D2.DT.Typhoid.TCV Typhoid conjugate vaccine (TCV) schedule
WHO recommendations for routine immunization - summary tables (January 2025)
WHO recommends the TCV as a 0.5 mL single dose for infants and children from 6 months of age and in adults up to 45 years in typhoid endemic regions.
Determine if the client is due for Typhoid.
Determine if the client is due for Typhoid vaccine according to the national immunization protocol. Typhoid conjugate vaccine (TCV) schedule
Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE21', display: 'Typhoid vaccines' } }, display: 'Typhoid vaccines' }
Check for Guidance for the patient regarding IMMZ.D2.DT.Typhoid.TCV.
Show Guidance for the patient regarding IMMZ.D2.DT.Typhoid.TCV.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }