Id: IMMZD18STBEEnceVir Url: IMMZ.D18.S.TBE.EnceVir schedule Version: 1.0.0 Title: IMMZ.D18.S.TBE.EnceVir 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.TBE.EnceVir schedule EnceVir, 3-dose schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18STBEEnceVirLogic Actions: Tick-borne encephalitis (TBE) EnceVir dose 1: Provision of the TBE EnceVir dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: The TBE-Moscow vaccine is not licensed for use in children aged under 3 years. If: Applicability: Tick-borne encephalitis (TBE) EnceVir dose 1 (Tick-borne encephalitis (TBE) EnceVir dose 1) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Tick-borne encephalitis (TBE) EnceVir 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' }) TBE EnceVir Dose 2: Provision of the TBE EnceVir dose 2 Trigger event: First TBE dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 1 Trigger date: "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: The manufacturer of EnceVir recommends 2 doses given at an interval of 5–7 months. If: Applicability: TBE EnceVir Dose 2 (TBE EnceVir Dose 2) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (TBE EnceVir Dose 2 Create) category.coding: (Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }) priority: (Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }) TBE EnceVir dose 3: Provision of the TBE EnceVir dose 3 Trigger event: Second TBE dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 2 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: The recommended interval is 12 months between the second and third doses. If: Applicability: TBE EnceVir dose 3 (TBE EnceVir dose 3) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (TBE EnceVir dose 3 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' }) TBE EnceVir booster dose: Provision of the TBE EnceVir booster dose Trigger event: The primary series has been completed Trigger pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "TBE vaccines") Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: TBE booster dose should be provided every 3 years to the client if the country recognizes TBE as a priority and the client has completed the primary series. If: Applicability: TBE EnceVir booster dose (TBE EnceVir booster dose) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (TBE EnceVir booster dose 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: TBE containing Doses Administered to Patient */ define "TBE Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."TBE vaccines"
TBE Primary Series Doses Administered to Patient
/* @internal: TBE containing Doses Administered to Patient that are in the Primary series */ define "TBE Primary Series Doses Administered to Patient": "TBE Doses Administered to Patient".seriesPrimary()
Number of TBE Primary Series Doses Administered
/* @internal: Number of TBE Primary Series doses */ define "Number of TBE Primary Series Doses Administered": Count("TBE Primary Series Doses Administered to Patient")
No TBE primary series doses were administered
/* @input: No TBE primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 0 @code: No TBE primary series doses were administered-112 @decision: IMMZ.D2.DT.TBE.FSME-Immun: FSME-Immun schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children) @decision: IMMZ.D2.DT.TBE.Encepur: Encepur schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.TBE-Moscow: TBE-Moscow schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.EnceVir: EnceVir schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) */ define "No TBE primary series doses were administered": "Number of TBE Primary Series Doses Administered" = 0
One TBE primary series dose was administered
/* @input: One TBE primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 1 @code: One TBE primary series dose was administered-112 @decision: IMMZ.D2.DT.TBE.FSME-Immun: FSME-Immun schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children) @decision: IMMZ.D2.DT.TBE.Encepur: Encepur schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.TBE-Moscow: TBE-Moscow schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.EnceVir: EnceVir schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) */ define "One TBE primary series dose was administered": "Number of TBE Primary Series Doses Administered" = 1
First TBE dose from the primary series was administered
/* @complete: First TBE dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 1 */ define "First TBE dose from the primary series was administered": Encounter."One TBE primary series dose was administered"
Tick-borne encephalitis (TBE) EnceVir dose 1
/* @output: Tick-borne encephalitis (TBE) EnceVir dose 1 @description: Provision of the TBE EnceVir dose 1 @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "Tick-borne encephalitis (TBE) EnceVir dose 1": Encounter."No TBE primary series doses were administered" and not "First TBE dose from the primary series was administered"
Two TBE primary series doses were administered
/* @input: Two TBE primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 2 @code: Two TBE primary series doses were administered-112 @decision: IMMZ.D2.DT.TBE.FSME-Immun: FSME-Immun schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children) @decision: IMMZ.D2.DT.TBE.Encepur: Encepur schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.TBE-Moscow: TBE-Moscow schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.EnceVir: EnceVir schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) */ define "Two TBE primary series doses were administered": "Number of TBE Primary Series Doses Administered" = 2
Second TBE dose from the primary series was administered
/* @complete: Second TBE dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 2 */ define "Second TBE dose from the primary series was administered": Encounter."Two TBE primary series doses were administered"
Three TBE primary series doses were administered
/* @input: Three TBE primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 3 @code: Three TBE primary series doses were administered-112 @decision: IMMZ.D2.DT.TBE.FSME-Immun: FSME-Immun schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children) @decision: IMMZ.D2.DT.TBE.Encepur: Encepur schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.TBE-Moscow: TBE-Moscow schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) @decision: IMMZ.D2.DT.TBE.EnceVir: EnceVir schedule (In areas where the disease is highly endemic, implying that there is a high individual risk of infection, WHO recommends that vaccination be offered to all age groups, including children ) */ define "Three TBE primary series doses were administered": "Number of TBE Primary Series Doses Administered" = 3
Third TBE dose from the primary series was administered. The primary series has been completed
/* @complete: Third TBE dose from the primary series was administered. The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "TBE vaccines") */ define "Third TBE dose from the primary series was administered. The primary series has been completed": Encounter."Three TBE primary series doses were administered"
/* @output: TBE EnceVir dose 3 @description: Provision of the TBE EnceVir dose 3 @trigger: Second TBE dose from the primary series was administered @pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 2 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") */ define "TBE EnceVir dose 3": "Second TBE dose from the primary series was administered" and not "Third TBE dose from the primary series was administered. The primary series has been completed"
/* @internal: Date of Latest TBE Dose */ define "Date of Latest TBE Dose": date from start of "TBE Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: TBE EnceVir dose 3 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") + 12 months */ define "TBE EnceVir dose 3 Due Date": if "TBE EnceVir dose 3" then Encounter."Date of Latest TBE Dose" + 12 months else null
/* @output: TBE EnceVir dose 3 Create @create: The recommended interval is 12 months between the second and third doses. */ define "TBE EnceVir dose 3 Create": if "TBE EnceVir dose 3" then 'The recommended interval is 12 months between the second and third doses.' + ' Due Date: ' + ToString("TBE EnceVir dose 3 Due Date") else ''
/* @output: TBE EnceVir booster dose @description: Provision of the TBE EnceVir booster dose @trigger: The primary series has been completed @pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "TBE vaccines") @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") */ define "TBE EnceVir booster dose": "Third TBE dose from the primary series was administered. The primary series has been completed"
/* @dynamicValue: TBE EnceVir booster dose Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") + 3 years */ define "TBE EnceVir booster dose Due Date": if "TBE EnceVir booster dose" then Encounter."Date of Latest TBE Dose" + 3 years else null
/* @output: TBE EnceVir booster dose Create @create: TBE booster dose should be provided every 3 years to the client if the country recognizes TBE as a priority and the client has completed the primary series. */ define "TBE EnceVir booster dose Create": if "TBE EnceVir booster dose" then 'TBE booster dose should be provided every 3 years to the client if the country recognizes TBE as a priority and the client has completed the primary series.' + ' Due Date: ' + ToString("TBE EnceVir booster dose Due Date") else ''
/* @output: TBE EnceVir Dose 2 @description: Provision of the TBE EnceVir dose 2 @trigger: First TBE dose from the primary series was administered @pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 1 @triggerDate: "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") */ define "TBE EnceVir Dose 2": "First TBE dose from the primary series was administered" and not "Second TBE dose from the primary series was administered"
/* @dynamicValue: TBE EnceVir Dose 2 Due Date @pseudocode: "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") + 5 months */ define "TBE EnceVir Dose 2 Due Date": if "TBE EnceVir Dose 2" then Encounter."Date of Latest TBE Dose" + 5 months else null
/* @dynamicValue: TBE EnceVir Dose 2 Overdue @pseudocode: "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") + 7 months */ define "TBE EnceVir Dose 2 Overdue": if "TBE EnceVir Dose 2" then Encounter."Date of Latest TBE Dose" + 7 months else null
/* @output: TBE EnceVir Dose 2 Create @create: The manufacturer of EnceVir recommends 2 doses given at an interval of 5–7 months. */ define "TBE EnceVir Dose 2 Create": if "TBE EnceVir Dose 2" then 'The manufacturer of EnceVir recommends 2 doses given at an interval of 5–7 months.' + ' Due Date: ' + ToString("TBE EnceVir Dose 2 Due Date") + ' Overdue: ' + ToString("TBE EnceVir Dose 2 Overdue") else ''
Tick-borne encephalitis (TBE) EnceVir dose 1 Due Date
/* @dynamicValue: Tick-borne encephalitis (TBE) EnceVir dose 1 Due Date @pseudocode: "Date of birth" + 3 years */ define "Tick-borne encephalitis (TBE) EnceVir dose 1 Due Date": if "Tick-borne encephalitis (TBE) EnceVir dose 1" then Patient.birthDate + 3 years else null
Tick-borne encephalitis (TBE) EnceVir dose 1 Create
/* @output: Tick-borne encephalitis (TBE) EnceVir dose 1 Create @create: The TBE-Moscow vaccine is not licensed for use in children aged under 3 years. */ define "Tick-borne encephalitis (TBE) EnceVir dose 1 Create": if "Tick-borne encephalitis (TBE) EnceVir dose 1" then 'The TBE-Moscow vaccine is not licensed for use in children aged under 3 years.' + ' Due Date: ' + ToString("Tick-borne encephalitis (TBE) EnceVir dose 1 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.TBE.EnceVir schedule EnceVir, 3-dose schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of the TBE EnceVir dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: The TBE-Moscow vaccine is not licensed for use in children aged under 3 years.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }
Provision of the TBE EnceVir dose 2 Trigger event: First TBE dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 1 Trigger date: "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: The manufacturer of EnceVir recommends 2 doses given at an interval of 5–7 months.
Provision of the TBE EnceVir dose 3 Trigger event: Second TBE dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "TBE vaccines" and "Type of dose" = "Primary series") = 2 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: The recommended interval is 12 months between the second and third doses.
Provision of the TBE EnceVir booster dose Trigger event: The primary series has been completed Trigger pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "TBE vaccines") Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "TBE vaccines") Create condition: TBE booster dose should be provided every 3 years to the client if the country recognizes TBE as a priority and the client has completed the primary series.