Id: IMMZD18SPolioIPVOnly Url: IMMZ.D18.S.Polio.IPV-only schedule Version: 1.0.0 Title: IMMZ.D18.S.Polio.IPV-only 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.Polio.IPV-only schedule Inactivated polio vaccine (IPV)-only schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18SPolioIPVOnlyLogic Actions: IPV dose 1: Provision of IPV dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. If: Applicability: IPV dose 1 (IPV dose 1) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (IPV 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' }) IPV dose 2: Provision of IPV dose 2 Trigger event: First IPV dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 1 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. If: Applicability: IPV dose 2 (IPV dose 2) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (IPV 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' }) IPV dose 3: Provision of IPV dose 3 Trigger event: Second IPV dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 2 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. If: Applicability: IPV dose 3 (IPV dose 3) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (IPV 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' }) IPV booster: Provision of IPV booster Trigger event: Third IPV dose from the primary series was administered and the client's age was 6 weeks when the primary series was started Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 3 AND "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines" AND "Dose number" = 1) − "Date of birth" = 6 weeks Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: If the primary series begins at 6 weeks, a booster dose should be given 6 months or more after the third dose If: Applicability: IPV booster (IPV booster) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (IPV booster 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
/* @internal: Polio containing Doses Administered to Patient */ define "Polio Doses Administered to Patient": Elements."Doses Administered to Patient" I where I.vaccineCode in Concepts."Poliovirus-containing vaccines"
Polio Primary Series Doses Administered to Patient
/* @internal: Polio containing Doses Administered to Patient that are in the Primary series */ define "Polio Primary Series Doses Administered to Patient": "Polio Doses Administered to Patient".seriesPrimary()
/* @internal: Polio containing Doses Administered to Patient that are in the Primary series */ define "Polio Primary Series Doses Administered to Patient": PolioElements."Polio Primary Series Doses Administered to Patient".onOrBefore(Today)
Polio IPV Primary Series Doses Administered to Patient
/* @internal: Polio IPV Primary Series Doses Administered to Patient */ define "Polio IPV Primary Series Doses Administered to Patient": "Polio Primary Series Doses Administered to Patient" I where I.typeOfDose() ~ Concepts."IPV"
Number of Polio IPV Primary Series Doses Administered
/* @internal: Number of Polio IPV Primary Series Doses Administered */ define "Number of Polio IPV Primary Series Doses Administered": Count("Polio IPV Primary Series Doses Administered to Patient")
Second IPV dose from the primary series was administered
/* @complete: Second IPV dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 2 */ define "Second IPV dose from the primary series was administered": Encounter."Number of Polio IPV Primary Series Doses Administered" >= 2
Third IPV dose from the primary series was administered. The primary series has been completed
/* @complete: Third IPV dose from the primary series was administered. The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Poliovirus-containing vaccines") */ define "Third IPV dose from the primary series was administered. The primary series has been completed": Encounter."Number of Polio IPV Primary Series Doses Administered" >= 3
/* @output: IPV dose 3 @description: Provision of IPV dose 3 @trigger: Second IPV dose from the primary series was administered @pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 2 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") */ define "IPV dose 3": "Second IPV dose from the primary series was administered" and not "Third IPV dose from the primary series was administered. The primary series has been completed"
/* @internal: Polio containing Doses Administered to Patient */ define "Polio Doses Administered to Patient": PolioElements."Polio Doses Administered to Patient".onOrBefore(Today)
/* @internal: IPV Doses Administered to Patient */ define "IPV Doses Administered to Patient": "Polio Doses Administered to Patient" I where I.typeOfDose() ~ Concepts."IPV"
/* @internal: Date of Latest IPV Dose */ define "Date of Latest IPV Dose": date from start of "IPV Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: IPV dose 3 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "IPV") + 4 weeks */ define "IPV dose 3 Due Date": if "IPV dose 3" then Encounter."Date of Latest IPV Dose" + 4 weeks else null
/* @output: IPV dose 3 Create @create: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. */ define "IPV dose 3 Create": if "IPV dose 3" then 'A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.' + ' Due Date: ' + ToString("IPV dose 3 Due Date") else ''
Polio Booster Series Doses Administered to Patient
/* @internal: Polio Booster Series Doses Administered to Patient */ define "Polio Booster Series Doses Administered to Patient": "Polio Doses Administered to Patient".seriesBooster()
/* @internal: Polio Booster Series Doses Administered to Patient */ define "Polio Booster Series Doses Administered to Patient": PolioElements."Polio Booster Series Doses Administered to Patient".onOrBefore(Today)
Number of Polio Booster Series Doses Administered
/* @internal: Number of Polio Booster Series Doses Administered */ define "Number of Polio Booster Series Doses Administered": Count("Polio Booster Series Doses Administered to Patient")
Booster IPV dose was administered. Polio immunization schedule has been completed
/* @complete: Booster IPV dose was administered. Polio immunization schedule has been completed @pseudocode: Count of vaccines administered (where "Type of poliovirus dose" = "IPV" and "Type of dose" = "Booster dose") = 1 */ define "Booster IPV dose was administered. Polio immunization schedule has been completed": Encounter."Number of Polio Booster Series Doses Administered" >= 1
/* @output: IPV booster @description: Provision of IPV booster @trigger: Third IPV dose from the primary series was administered and the client's age was 6 weeks when the primary series was started @pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 3 AND "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines" AND "Dose number" = 1) − "Date of birth" = 6 weeks @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") */ define "IPV booster": "Third IPV dose from the primary series was administered. The primary series has been completed" and not "Booster IPV dose was administered. Polio immunization schedule has been completed"
First IPV dose from the primary series was administered
/* @complete: First IPV dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 1 */ define "First IPV dose from the primary series was administered": Encounter."Number of Polio IPV Primary Series Doses Administered" >= 1
/* @output: IPV dose 1 @description: Provision of IPV dose 1 @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "IPV dose 1": not "First IPV dose from the primary series was administered"
/* @dynamicValue: IPV dose 1 Due Date @pseudocode: "Date of birth" + 6 weeks */ define "IPV dose 1 Due Date": if "IPV dose 1" then Patient.birthDate + 6 weeks else null
/* @output: IPV dose 1 Create @create: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. */ define "IPV dose 1 Create": if "IPV dose 1" then 'A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.' + ' Due Date: ' + ToString("IPV dose 1 Due Date") else ''
/* @output: IPV dose 2 @description: Provision of IPV dose 2 @trigger: First IPV dose from the primary series was administered @pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 1 @triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") */ define "IPV dose 2": "First IPV dose from the primary series was administered" and not "Second IPV dose from the primary series was administered"
/* @dynamicValue: IPV dose 2 Due Date @pseudocode: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "IPV") + 4 weeks */ define "IPV dose 2 Due Date": if "IPV dose 2" then Encounter."Date of Latest IPV Dose" + 4 weeks else null
/* @output: IPV dose 2 Create @create: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended. */ define "IPV dose 2 Create": if "IPV dose 2" then 'A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.' + ' Due Date: ' + ToString("IPV dose 2 Due Date") else ''
/* @internal: Date of Latest Polio Dose */ define "Date of Latest Polio Dose": date from start of "Polio Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: IPV booster Due Date @pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") + 6 months */ define "IPV booster Due Date": if "IPV booster" then Encounter."Date of Latest Polio Dose" + 6 months else null
/* @output: IPV booster Create @create: If the primary series begins at 6 weeks, a booster dose should be given 6 months or more after the third dose */ define "IPV booster Create": if "IPV booster" then 'If the primary series begins at 6 weeks, a booster dose should be given 6 months or more after the third dose' + ' Due Date: ' + ToString("IPV booster Due Date") else ''
/** * @description: Gets immunizations on or before a date */ define fluent function onOrBefore(immunizations List<Immunization>, beforeDate Date): immunizations I where I.occurrence.toInterval() same day or before beforeDate
/* 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
/** * @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
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: Gets the type of antigen dose extension value from an Immunization */ define fluent function typeOfDose(immz Immunization): (First( immz.extension E where E.url = 'http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose' )).value as FHIR.CodeableConcept
define function ToString(value uri): value.value
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' )
Value set Poliovirus-containing vaccines
IMMZ.D18.S.Polio.IPV-only schedule Inactivated polio vaccine (IPV)-only schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of IPV dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }
Provision of IPV dose 2 Trigger event: First IPV dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 1 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.
Provision of IPV dose 3 Trigger event: Second IPV dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 2 Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: A primary 3-dose series of IPV administered beginning at 6 or 8 weeks of age, with a minimum 4 week-interval between doses, is recommended.
Provision of IPV booster Trigger event: Third IPV dose from the primary series was administered and the client's age was 6 weeks when the primary series was started Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Poliovirus-containing vaccines") = 3 AND "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines" AND "Dose number" = 1) − "Date of birth" = 6 weeks Trigger date: Latest "Date and time of vaccination" (where "Vaccine type" = "Poliovirus-containing vaccines") Create condition: If the primary series begins at 6 weeks, a booster dose should be given 6 months or more after the third dose