Id: IMMZD2DTYellowfeverYellowFever Url: IMMZ.D2.DT.Yellow fever Version: 0.2.0 Title: IMMZ.D2.DT.Yellow fever Status: draft Type: system: http://terminology.hl7.org/CodeSystem/plan-definition-type code: eca-rule Date: 2026-03-25 23:30:34+0000 Publisher: WHO Description: IMMZ.D2.DT.Yellow fever IMMZ.D2.DT.Yellow fever Knowledge Capability: computable Related Artifacts: References WHO recommendations for routine immunization - summary tables (January 2025) Libraries: IMMZD2DTYellowfeverYellowFeverLogic Actions: Determine if the client is due for Yellow fever.: Determine if the client is due for Yellow fever vaccine according to the national immunization protocol. If: Applicability: Client is due for yellow fever vaccination (Client is due for yellow fever vaccination) Then: Definition: IMMZD2DTMR Dynamic Values: status: ('draft') intent: ('proposal') medication: (Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE23', display: 'Yellow fever vaccines' } }, display: 'Yellow fever vaccines' }) Check for Guidance for the patient regarding IMMZ.D2.DT.Yellow fever.: Show Guidance for the patient regarding IMMZ.D2.DT.Yellow fever. 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 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
Yellow fever Doses Administered to Patient
/* @internal: Yellow fever containing Doses Administered to Patient */ define "Yellow fever Doses Administered to Patient": Encounter."Doses Administered to Patient" I where I.vaccineCode in Concepts."Yellow fever vaccines"
Yellow fever Primary Series Doses Administered to Patient
/* @internal: Yellow fever containing Doses Administered to Patient that are in the Primary series */ define "Yellow fever Primary Series Doses Administered to Patient": "Yellow fever Doses Administered to Patient".seriesPrimary()
Number of Yellow fever Primary Series Doses Administered
/* @internal: Number of Yellow fever Primary Series doses */ define "Number of Yellow fever Primary Series Doses Administered": Count("Yellow fever Primary Series Doses Administered to Patient")
No yellow fever primary series doses were administered
/* @input: No yellow fever primary series doses were administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Yellow fever vaccines" and "Type of dose" = "Primary series") = 0 @code: No yellow fever primary series doses were administered-121 @decision: IMMZ.D2.DT.Yellow fever */ define "No yellow fever primary series doses were administered": "Number of Yellow fever Primary Series Doses Administered" = 0
/** * @dataElement Patient age in months */ define "Current Patient Age In Months": AgeInMonthsAt(Today)
/* @input: Client's age is less than 9 months @pseudocode: Today's date − "Date of birth" < 9 months @code: Client's age is less than 9 months-41 @decision: IMMZ.D2.DT.Yellow fever */ define "Client's age is less than 9 months": Encounter."Current Patient Age In Months" < 9
Client is not due for yellow fever vaccination Case 1
/* @output: Client is not due for yellow fever vaccination Case 1 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for yellow fever vaccination Case 1": Encounter."No yellow fever primary series doses were administered" and Encounter."Client's age is less than 9 months"
Client's age is more than or equal to 9 months
/* @input: Client's age is more than or equal to 9 months @pseudocode: Today's date − "Date of birth" ≥ 9 months @code: Client's age is more than or equal to 9 months-41 @decision: IMMZ.D2.DT.Yellow fever */ define "Client's age is more than or equal to 9 months": Encounter."Current Patient Age In Months" >= 9
/* @dataElement: Live attenuated vaccines */ define "Live Attenuated Vaccines": "Doses Administered to Patient" I where I.vaccineCode in Concepts."Live Attenuated"
/* @dataElement Live attenuated vaccines */ define "Live Attenuated Vaccines": Elements."Live Attenuated Vaccines" I where I.occurrence.toInterval() same day or before Today
/* @dataElement Date and time of last live attenuated vaccine */ define "Date of Latest Live Attenuated Vaccine": date from start of "Live Attenuated Vaccines".mostRecent().occurrence.toInterval()
Live vaccine was administered in the last 4 weeks
/* @input: Live vaccine was administered in the last 4 weeks @pseudocode: Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) < 4 weeks */ define "Live vaccine was administered in the last 4 weeks": "Date of Latest Live Attenuated Vaccine" is not null and duration in weeks between "Date of Latest Live Attenuated Vaccine" and Today < 4
Live vaccine was administered in the past 4 weeks
/* @input: Live vaccine was administered in the past 4 weeks @pseudocode: Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) < 4 weeks @code: Live vaccine was administered in the past 4 weeks-92 @decision: IMMZ.D2.DT.Yellow fever */ define "Live vaccine was administered in the past 4 weeks": Encounter."Live vaccine was administered in the last 4 weeks"
Client is not due for yellow fever vaccination Case 2
/* @output: Client is not due for yellow fever vaccination Case 2 @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for yellow fever vaccination Case 2": Encounter."No yellow fever primary series doses were administered" and Encounter."Client's age is more than or equal to 9 months" and Encounter."Live vaccine was administered in the past 4 weeks"
Client is not due for yellow fever vaccination
/* @output: Client is not due for yellow fever vaccination @pseudocode: "Immunization recommendation status" = "Not due" */ define "Client is not due for yellow fever vaccination": "Client is not due for yellow fever vaccination Case 1" or "Client is not due for yellow fever vaccination Case 2"
Client is not due for yellow fever vaccination Guidance
/* @output: Client is not due for yellow fever vaccination Guidance @guidance = Should not vaccinate client with yellow fever dose as client's age is less than 9 months. Check for any vaccines due and inform the caregiver of when to come back for the next dose. @guidance = Should not vaccinate client with yellow fever dose as live vaccine was administered in the past 4 weeks. Check for any vaccines due and inform the caregiver of when to come back for the first dose. */ define "Client is not due for yellow fever vaccination Guidance": case when "Client is not due for yellow fever vaccination Case 1" then 'Should not vaccinate client with yellow fever dose as client\'s age is less than 9 months. Check for any vaccines due and inform the caregiver of when to come back for the next dose.' when "Client is not due for yellow fever vaccination Case 2" then 'Should not vaccinate client with yellow fever dose as live vaccine was administered in the past 4 weeks. Check for any vaccines due and inform the caregiver of when to come back for the first dose.' else '' end
No live vaccine was administered in the last 4 weeks
/* @input: No live vaccine was administered in the last 4 weeks @pseudocode: Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) ≥ 4 weeks */ define "No live vaccine was administered in the last 4 weeks": not("Live vaccine was administered in the last 4 weeks")
No live vaccine was administered in the past 4 weeks
/* @input: No live vaccine was administered in the past 4 weeks @pseudocode: Today's date − latest "Date and time of vaccination" (where "Live vaccine" = TRUE) ≥ 4 weeks @code: No live vaccine was administered in the past 4 weeks-92 @decision: IMMZ.D2.DT.Yellow fever */ define "No live vaccine was administered in the past 4 weeks": Encounter."No live vaccine was administered in the last 4 weeks"
Client is due for yellow fever vaccination
/* @output: Client is due for yellow fever vaccination @pseudocode: "Immunization recommendation status" = "Due" */ define "Client is due for yellow fever vaccination": Encounter."No yellow fever primary series doses were administered" and Encounter."Client's age is more than or equal to 9 months" and Encounter."No live vaccine was administered in the past 4 weeks"
Client is due for yellow fever vaccination Guidance
/* @output: Client is due for yellow fever vaccination Guidance @guidance: Should vaccinate client with yellow fever dose as no yellow fever dose was administered, client is within appropriate age range and no live vaccine was administered in the past 4 weeks. Check for contraindications. */ define "Client is due for yellow fever vaccination Guidance": 'Should vaccinate client with yellow fever dose as no yellow fever dose was administered, client is within appropriate age range and no live vaccine was administered in the past 4 weeks. Check for contraindications.'
One yellow fever primary series dose was administered
/* @input: One yellow fever primary series dose was administered @pseudocode: Count of vaccines administered (where "Vaccine type" = "Yellow fever vaccines" and "Type of dose" = "Primary series") = 1 @code: One yellow fever primary series dose was administered-121 @decision: IMMZ.D2.DT.Yellow fever */ define "One yellow fever primary series dose was administered": "Number of Yellow fever Primary Series Doses Administered" = 1
Yellow fever immunization schedule is complete
/* @output: Yellow fever immunization schedule is complete @pseudocode: "Immunization recommendation status" = "Complete" "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Yellow fever vaccines") */ define "Yellow fever immunization schedule is complete": Encounter."One yellow fever primary series dose was administered"
Yellow fever immunization schedule is complete Guidance
/* @output: Yellow fever immunization schedule is complete Guidance @guidance: Yellow fever immunization schedule is complete. One yellow fever primary series dose was administered. Check for any other vaccines due. */ define "Yellow fever immunization schedule is complete Guidance": 'Yellow fever immunization schedule is complete. One yellow fever primary series dose was administered. Check for any other vaccines due.'
/* @dynamicValue: Guidance */ define "Guidance": case when "Client is not due for yellow fever vaccination" then "Client is not due for yellow fever vaccination Guidance" when "Client is due for yellow fever vaccination" then "Client is due for yellow fever vaccination Guidance" when "Yellow fever immunization schedule is complete" then "Yellow fever 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
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.D2.DT.Yellow fever IMMZ.D2.DT.Yellow fever
WHO recommendations for routine immunization - summary tables (January 2025)
In endemic countries, it is recommended that yellow fever vaccine be given to children aged 9–12 months at the same time as the measles vaccine. Preventive mass vaccination campaigns are recommended for inhabitants of areas at risk of yellow fever where there is low vaccination coverage. Vaccination should be provided to everyone aged 9 months and older in any area with reported cases. Vaccination should also be offered if the individual is travelling to and from at-risk areas, if not contraindicated. As a general rule, any live vaccine may be given either simultaneously or at an interval of 4 weeks. Oral poliovirus vaccine may be given at any time in relation to yellow fever vaccination.
Determine if the client is due for Yellow fever.
Determine if the client is due for Yellow fever vaccine according to the national immunization protocol.
Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE23', display: 'Yellow fever vaccines' } }, display: 'Yellow fever vaccines' }
Check for Guidance for the patient regarding IMMZ.D2.DT.Yellow fever.
Show Guidance for the patient regarding IMMZ.D2.DT.Yellow fever.
Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }
Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }