Id: IMMZD18SMumps Url: IMMZ.D18.S.Mumps schedule Version: 1.0.0 Title: IMMZ.D18.S.Mumps 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.Mumps schedule 2-dose schedule Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD18SMumpsLogic Actions: Mumps dose 1: Provision of the mumps dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: The first dose of the mumps-containing vaccine (monovalent or MMR [measles, mumps and rubella]) should be given at 12–18 months of age. If: Applicability: Mumps dose 1 (Mumps dose 1) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Mumps 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' }) Mumps dose 2: Provision of the mumps dose 2 Trigger event: First mumps dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 1 Trigger date: "Date and time of vaccination" (where "Vaccine type" = "Mumps-containing vaccines") Create condition: The age of administration of the second dose may range from the second year of life to age at school entry (about 6 years of age). The minimum interval between the first and the second doses is 1 month. If: Applicability: Mumps dose 2 (Mumps dose 2) Then: Definition: IMMZ.D2.DT.CR Dynamic Values: status: ('active') payload.contentString: (Mumps 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' })
/** * @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: Mumps containing Doses Administered to Patient */ define "Mumps Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."Mumps-containing vaccines"
Mumps Primary Series Doses Administered to Patient
/* @internal: Mumps containing Doses Administered to Patient that are in the Primary series */ define "Mumps Primary Series Doses Administered to Patient": "Mumps Doses Administered to Patient".seriesPrimary()
Number of Mumps Primary Series Doses Administered
/* @internal: Number of Mumps Primary Series doses */ define "Number of Mumps Primary Series Doses Administered": Count("Mumps Primary Series Doses Administered to Patient")
One mumps primary series dose was administered
/* @input: One mumps primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 1 @code: One mumps primary series dose was administered-125 @decision: IMMZ.D2.DT.Mumps: 2-dose schedule (countries with mumps in schedule and low transmission of measles) */ define "One mumps primary series dose was administered": "Number of Mumps Primary Series Doses Administered" = 1
First mumps dose from the primary series was administered
/* @complete: First mumps dose from the primary series was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 1 */ define "First mumps dose from the primary series was administered": Encounter."One mumps primary series dose was administered"
Two mumps primary series doses were administered
/* @input: Two mumps primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 2 @code: Two mumps primary series doses were administered-125 @decision: IMMZ.D2.DT.Mumps: 2-dose schedule (countries with mumps in schedule and low transmission of measles) */ define "Two mumps primary series doses were administered": "Number of Mumps Primary Series Doses Administered" = 2
Second mumps dose from the primary series was administered. The primary series has been completed
/* @complete: Second mumps dose from the primary series was administered. The primary series has been completed @pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Mumps-containing vaccines")" */ define "Second mumps dose from the primary series was administered. The primary series has been completed": Encounter."Two mumps primary series doses were administered"
/* @output: Mumps dose 2 @description: Provision of the mumps dose 2 @trigger: First mumps dose from the primary series was administered @pseudo: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 1 @triggerDate: "Date and time of vaccination" (where "Vaccine type" = "Mumps-containing vaccines") */ define "Mumps dose 2": "First mumps dose from the primary series was administered" and not "Second mumps dose from the primary series was administered. The primary series has been completed"
/* @internal: Date of Latest Mumps Dose */ define "Date of Latest Mumps Dose": date from start of "Mumps Doses Administered to Patient".mostRecent().occurrence.toInterval()
/* @dynamicValue: Mumps dose 2 Due Date @pseudocode: "Date and time of vaccination" (where "Vaccine type" = "Mumps-containing vaccines") + 1 month */ define "Mumps dose 2 Due Date": if "Mumps dose 2" then Encounter."Date of Latest Mumps Dose" + 1 month else null
/* @dynamicValue: Mumps dose 2 Overdue @pseudocode: "Date of birth" + 6 years */ define "Mumps dose 2 Overdue": if "Mumps dose 2" then Patient.birthDate + 6 years else null
/* @output: Mumps dose 2 Create @create: The age of administration of the second dose may range from the second year of life to age at school entry (about 6 years of age). The minimum interval between the first and the second doses is 1 month. */ define "Mumps dose 2 Create": if "Mumps dose 2" then 'The age of administration of the second dose may range from the second year of life to age at school entry (about 6 years of age). The minimum interval between the first and the second doses is 1 month.' + ' Due Date: ' + ToString("Mumps dose 2 Due Date") + ' Overdue: ' + ToString("Mumps dose 2 Overdue") else ''
No mumps primary series doses were administered
/* @input: No mumps primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 0 @code: No mumps primary series doses were administered-125 @decision: IMMZ.D2.DT.Mumps: 2-dose schedule (countries with mumps in schedule and low transmission of measles) */ define "No mumps primary series doses were administered": "Number of Mumps Primary Series Doses Administered" = 0
/* @output: Mumps dose 1 @description: Provision of the mumps dose 1 @trigger: Child's birth @pseudo: @triggerDate: "Date of birth" */ define "Mumps dose 1": Encounter."No mumps primary series doses were administered" and not "First mumps dose from the primary series was administered"
/* @dynamicValue: Mumps dose 1 Due Date @pseudocode: "Date of birth" + 12 months */ define "Mumps dose 1 Due Date": if "Mumps dose 1" then Patient.birthDate + 12 months else null
/* @dynamicValue: Mumps dose 1 Overdue @pseudocode: "Date of birth" + 18 months */ define "Mumps dose 1 Overdue": if "Mumps dose 1" then Patient.birthDate + 18 months else null
/* @output: Mumps dose 1 Create @create: The first dose of the mumps-containing vaccine (monovalent or MMR [measles, mumps and rubella]) should be given at 12–18 months of age. */ define "Mumps dose 1 Create": if "Mumps dose 1" then 'The first dose of the mumps-containing vaccine (monovalent or MMR [measles, mumps and rubella]) should be given at 12–18 months of age.' + ' Due Date: ' + ToString("Mumps dose 1 Due Date") + ' Overdue: ' + ToString("Mumps dose 1 Overdue") 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.Mumps schedule 2-dose schedule
WHO recommendations for routine immunization - summary tables (January 2025)
Provision of the mumps dose 1 Trigger event: Child's birth Trigger pseudo: Trigger date: "Date of birth" Create condition: The first dose of the mumps-containing vaccine (monovalent or MMR [measles, mumps and rubella]) should be given at 12–18 months of age.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }
Provision of the mumps dose 2 Trigger event: First mumps dose from the primary series was administered Trigger pseudo: Count of vaccines administered (where "Vaccine type" = "Mumps-containing vaccines" and "Type of dose" = "Primary series") = 1 Trigger date: "Date and time of vaccination" (where "Vaccine type" = "Mumps-containing vaccines") Create condition: The age of administration of the second dose may range from the second year of life to age at school entry (about 6 years of age). The minimum interval between the first and the second doses is 1 month.