Id: IMMZD18SHib2DosesWithBoosterDose Url: IMMZ.D18.S.Hib.2 doses with booster dose schedule Version: 1.0.0 Title: IMMZ.D18.S.Hib.2 doses with booster dose 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.Hib.2 doses with booster dose schedule 2 primary doses with a booster dose (2p+1) schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18SHib2DosesWithBoosterDoseLogic Actions: Haemophilus influenzae type b (Hib) dose 1: Provision of the Hib dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Hib dose 1 should be provided if the client is older than 6 weeks If: Applicability: Haemophilus influenzae type b (Hib) dose 1 (Haemophilus influenzae type b (Hib) dose 1) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Haemophilus influenzae type b (Hib) 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' }) Hib dose 2: Provision of the Hib dose 2 Trigger event: First Hib dose from the primary series was administered to the client within 1 year of age. Client's age is less than 5 years Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series") = 1 AND "Date and time of vaccination" (where "Vaccine type"= "Hib-containing vaccines" and "Dose number" = 1) − "Date of birth" < 1 year AND Today's date − "Date of birth" ≤ 5 years Trigger date: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") Create condition: Hib dose 2 should be provided if the client was given the previous dose more than 8 weeks ago If: Applicability: Hib dose 2 (Hib dose 2) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Hib 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' }) Hib booster dose: Provision of the Hib booster dose Trigger event: Second Hib dose from the primary series was administered. Client's age is less than 5 years Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 2 AND Today's date − "Date of birth" ≤ 5 years Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") Create condition: Hib booster dose should be provided if the client was given the previous dose more than 6 months ago If: Applicability: Hib booster dose (Hib booster dose) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Hib 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: Hib containing Doses Administered to Patient */ define "Hib Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."Hib-containing vaccines"
Hib Primary Series Doses Administered to Patient
/* @internal: Hib containing Doses Administered to Patient that are in the Primary series */ define "Hib Primary Series Doses Administered to Patient": "Hib Doses Administered to Patient".seriesPrimary()
Number of Hib Primary Series Doses Administered
/* @internal: Number of Hib Primary Series doses */ define "Number of Hib Primary Series Doses Administered": Count("Hib Primary Series Doses Administered to Patient")
One Hib primary series dose was administered
/* @input: One Hib primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 1 @code: One Hib primary series dose was administered-122 @decision: IMMZ.D2.DT.Hib.3 doses: 3 primary doses without a booster dose (3p) @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) */ define "One Hib primary series dose was administered": "Number of Hib Primary Series Doses Administered" = 1
First Hib dose from the primary series was administered
/* @complete: First Hib dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 1 The primary series has been completed for delayed start "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines") */ define "First Hib dose from the primary series was administered": Encounter."One Hib primary series dose was administered"
/* @internal: Date of First Hib Dose */ define "Date of First Hib Dose": date from start of "Hib Doses Administered to Patient".earliest().occurrence.toInterval()
Client's age was less than 1 year when first Hib dose was administered
/* @input: Client's age was less than 1 year when first Hib dose was administered @pseudocode: "Date and time of vaccination" (where "Vaccine type"= "Hib-containing vaccines" and "Dose number" = 1) − "Date of birth" < 1 year @code: Client's age was less than 1 year when first Hib dose was administered-129 @decision: IMMZ.D2.DT.Hib.3 doses: 3 primary doses without a booster dose (3p) @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) @decision: IMMZ.D2.DT.Hib.2 doses with booster dose: 2 primary doses with a booster dose (2p+1) */ define "Client's age was less than 1 year when first Hib dose was administered": AgeInYearsAt("Date of First Hib Dose") < 1
/** * @dataElement Patient age in weeks */ define "Current Patient Age In Weeks": AgeInWeeksAt(Today)
/** * @dataElement Patient age in years */ define "Current Patient Age In Years": AgeInYearsAt(Today)
Client's age is between 6 weeks and 5 years
/* @input: Client's age is between 6 weeks and 5 years @pseudocode: 6 weeks ≤ Today's date − "Date of birth" ≤ 5 years @code: Client's age is between 6 weeks and 5 years-50 @decision: IMMZ.D2.DT.Hib.3 doses: 3 primary doses without a booster dose (3p) @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) @decision: IMMZ.D2.DT.Hib.2 doses with booster dose: 2 primary doses with a booster dose (2p+1) */ define "Client's age is between 6 weeks and 5 years": 6 <= Encounter."Current Patient Age In Weeks" and Encounter."Current Patient Age In Years" <= 5
Two Hib primary series doses were administered
/* @input: Two Hib primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series" ) = 2 @code: Two Hib primary series doses were administered-124 @decision: IMMZ.D2.DT.Hib.3 doses: 3 primary doses without a booster dose (3p) @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) @decision: IMMZ.D2.DT.Hib.2 doses with booster dose: 2 primary doses with a booster dose (2p+1) */ define "Two Hib primary series doses were administered": "Number of Hib Primary Series Doses Administered" = 2
Second Hib dose from the primary series was administered. The primary series has been completed
/* @complete: Second Hib dose from the primary series was administered. The primary series has been completed @pseudocode: Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines") */ define "Second Hib dose from the primary series was administered. The primary series has been completed": Encounter."Two Hib primary series doses were administered"
/* @dynamicValue: Hib dose 2 Expiration @pseudocode: "Date of birth" + 6 years */ define "Hib dose 2 Expiration": Patient.birthDate + 6 years
/* @output: Hib dose 2 @description: Provision of the Hib dose 2 @trigger: First Hib dose from the primary series was administered to the client within 1 year of age. Client's age is less than 5 years @pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series") = 1 AND "Date and time of vaccination" (where "Vaccine type"= "Hib-containing vaccines" and "Dose number" = 1) − "Date of birth" < 1 year AND Today's date − "Date of birth" ≤ 5 years @triggerDate: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") */ define "Hib dose 2": "First Hib dose from the primary series was administered" and Encounter."Client's age was less than 1 year when first Hib dose was administered" and Encounter."Client's age is between 6 weeks and 5 years" and not "Second Hib dose from the primary series was administered. The primary series has been completed" and "Hib dose 2 Expiration" after day of Today
/* @internal: Date of Latest Hib Dose */ define "Date of Latest Hib Dose": date from start of "Hib Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: Hib dose 2 Due Date @pseudocode: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") + 8 weeks */ define "Hib dose 2 Due Date": if "Hib dose 2" then Encounter."Date of Latest Hib Dose" + 8 weeks else null
/* @output: Hib dose 2 Create @create: Hib dose 2 should be provided if the client was given the previous dose more than 8 weeks ago */ define "Hib dose 2 Create": if "Hib dose 2" then 'Hib dose 2 should be provided if the client was given the previous dose more than 8 weeks ago' + ' Due Date: ' + ToString("Hib dose 2 Due Date") + ' Expiration: ' + ToString("Hib dose 2 Expiration") else ''
No Hib primary series doses were administered
/* @input: No Hib primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series") = 0 @code: No Hib primary series doses were administered-123 @decision: IMMZ.D2.DT.Hib.3 doses: 3 primary doses without a booster dose (3p) @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) @decision: IMMZ.D2.DT.Hib.2 doses with booster dose: 2 primary doses with a booster dose (2p+1) */ define "No Hib primary series doses were administered": "Number of Hib Primary Series Doses Administered" = 0
Haemophilus influenzae type b (Hib) dose 1 Expiration
/* @dynamicValue: Haemophilus influenzae type b (Hib) dose 1 Expiration @pseudocode: "Date of birth" + 6 years */ define "Haemophilus influenzae type b (Hib) dose 1 Expiration": Patient.birthDate + 6 years
Haemophilus influenzae type b (Hib) dose 1
/* @output: Haemophilus influenzae type b (Hib) dose 1 @description: Provision of the Hib dose 1 @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "Haemophilus influenzae type b (Hib) dose 1": Encounter."No Hib primary series doses were administered" and "Haemophilus influenzae type b (Hib) dose 1 Expiration" after day of Today
Haemophilus influenzae type b (Hib) dose 1 Due Date
/* @dynamicValue: Haemophilus influenzae type b (Hib) dose 1 Due Date @pseudocode: "Date of birth" + 6 weeks */ define "Haemophilus influenzae type b (Hib) dose 1 Due Date": if "Haemophilus influenzae type b (Hib) dose 1" then Patient.birthDate + 6 weeks else null
Haemophilus influenzae type b (Hib) dose 1 Create
/* @output: Haemophilus influenzae type b (Hib) dose 1 Create @create: Hib dose 1 should be provided if the client is older than 6 weeks */ define "Haemophilus influenzae type b (Hib) dose 1 Create": if "Haemophilus influenzae type b (Hib) dose 1" then 'Hib dose 1 should be provided if the client is older than 6 weeks' + ' Due Date: ' + ToString("Haemophilus influenzae type b (Hib) dose 1 Due Date") + ' Expiration: ' + ToString("Haemophilus influenzae type b (Hib) dose 1 Expiration") else ''
Hib Booster Series Doses Administered to Patient
/* @internal: Hib Booster Series Doses Administered to Patient */ define "Hib Booster Series Doses Administered to Patient": "Hib Doses Administered to Patient".seriesBooster()
Number of Hib Booster Series Doses Administered
/* @internal: Number of Hib Booster Series Doses Administered */ define "Number of Hib Booster Series Doses Administered": Count("Hib Booster Series Doses Administered to Patient")
/* @input: One Hib booster dose was administered @pseudocode: Count of vaccines administered where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Booster dose") = 1 @code: One Hib booster dose was administered-120 @decision: IMMZ.D2.DT.Hib.3 doses with booster dose: 3 primary doses with a booster dose (3p+1) @decision: IMMZ.D2.DT.Hib.2 doses with booster dose: 2 primary doses with a booster dose (2p+1) */ define "One Hib booster dose was administered": "Number of Hib Booster Series Doses Administered" = 1
One Hib booster dose was administered. Hib immunization schedule has been completed
/* @complete: One Hib booster dose was administered. Hib immunization schedule has been completed @pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Booster dose") = 1 */ define "One Hib booster dose was administered. Hib immunization schedule has been completed": Encounter."One Hib booster dose was administered"
/* @dynamicValue: Hib booster dose Expiration @pseudocode: "Date of birth" + 6 years */ define "Hib booster dose Expiration": Patient.birthDate + 6 years
/* @output: Hib booster dose @description: Provision of the Hib booster dose @trigger: Second Hib dose from the primary series was administered. Client's age is less than 5 years @pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 2 AND Today's date − "Date of birth" ≤ 5 years @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") */ define "Hib booster dose": "Second Hib dose from the primary series was administered. The primary series has been completed" and Encounter."Client's age is between 6 weeks and 5 years" and not "One Hib booster dose was administered. Hib immunization schedule has been completed" and "Hib booster dose Expiration" after day of Today
/* @dynamicValue: Hib booster dose Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") + 6 months */ define "Hib booster dose Due Date": if "Hib booster dose" then Encounter."Date of Latest Hib Dose" + 6 months else null
/* @output: Hib booster dose Create @create: Hib booster dose should be provided if the client was given the previous dose more than 6 months ago */ define "Hib booster dose Create": if "Hib booster dose" then 'Hib booster dose should be provided if the client was given the previous dose more than 6 months ago' + ' Due Date: ' + ToString("Hib booster dose Due Date") + ' Expiration: ' + ToString("Hib booster dose Expiration") 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 earliest(immunizations List<Immunization>): First( immunizations I sort by start of occurrence.toInterval() )
define fluent function mostRecent(immunizations List<Immunization>): Last( immunizations I sort by start of occurrence.toInterval() )
/** * @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' )
IMMZ.D18.S.Hib.2 doses with booster dose schedule
IMMZ.D18.S.Hib.2 doses with booster dose schedule 2 primary doses with a booster dose (2p+1) schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of the Hib dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: Hib dose 1 should be provided if the client is older than 6 weeks
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }
Provision of the Hib dose 2 Trigger event: First Hib dose from the primary series was administered to the client within 1 year of age. Client's age is less than 5 years Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series") = 1 AND "Date and time of vaccination" (where "Vaccine type"= "Hib-containing vaccines" and "Dose number" = 1) − "Date of birth" < 1 year AND Today's date − "Date of birth" ≤ 5 years Trigger date: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") Create condition: Hib dose 2 should be provided if the client was given the previous dose more than 8 weeks ago
Provision of the Hib booster dose Trigger event: Second Hib dose from the primary series was administered. Client's age is less than 5 years Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 2 AND Today's date − "Date of birth" ≤ 5 years Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") Create condition: Hib booster dose should be provided if the client was given the previous dose more than 6 months ago