WHO Immunization Implementation Guide
0.2.0 - ci-build
WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/tree/123/merge and changes regularly. See the Directory of published versions
| Draft as of 2026-03-03 |
{
"resourceType" : "PlanDefinition",
"id" : "IMMZD2DTHepatitisALiveAttenuatedHAV1Dose",
"meta" : {
"profile" : [
🔗 "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-recommendationdefinition"🔗 ,
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableplandefinition"🔗 ,
"http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableplandefinition"
]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n<div>\n <table class=\"grid dict\">\n \n <tr>\n <th scope=\"row\"><b>Id: </b></th>\n <td style=\"padding-left: 4px;\">IMMZD2DTHepatitisALiveAttenuatedHAV1Dose</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Url: </b></th>\n <td style=\"padding-left: 4px;\"><a href=\"PlanDefinition-IMMZD2DTHepatitisALiveAttenuatedHAV1Dose.html\">IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose</a></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Version: </b></th>\n <td style=\"padding-left: 4px;\">0.2.0</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Title: </b></th>\n <td style=\"padding-left: 4px;\">IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Status: </b></th>\n <td style=\"padding-left: 4px;\">draft</td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Type: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n \n <p style=\"margin-bottom: 5px;\">\n <b>system: </b> <span><a href=\"http://terminology.hl7.org/7.0.1/CodeSystem-plan-definition-type.html\">http://terminology.hl7.org/CodeSystem/plan-definition-type</a></span>\n </p>\n \n \n <p style=\"margin-bottom: 5px;\">\n <b>code: </b> <span>eca-rule</span>\n </p>\n \n \n \n \n \n </td>\n </tr>\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Date: </b></th>\n <td style=\"padding-left: 4px;\">2026-03-03 13:07:11+0000</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Publisher: </b></th>\n <td style=\"padding-left: 4px;\">WHO</td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Description: </b></th>\n <td style=\"padding-left: 4px;\"><div><p>IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose\nLive attenuated hepatitis A virus (HAV), 1 dose schedule</p>\n</div></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Knowledge Capability: </b></th>\n <td style=\"padding-left: 4px;\">\n \n computable \n </td>\n </tr>\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n <tr>\n <th scope=\"row\"><b>Related Artifacts: </b></th>\n <td style=\"padding-left: 4px;\">\n \n \n <p><b>References</b></p>\n <ul>\n \n <li><div><p>WHO recommendations for routine immunization - summary tables (January 2025)</p>\n</div><br/><a href=\"null\"/></li>\n \n </ul>\n \n \n \n \n \n \n </td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Libraries: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n \n <tr>\n <td><a href=\"Library-IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic.html\">IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic</a></td>\n </tr>\n \n </table>\n </td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Actions: </b></th>\n <td style=\"padding-left: 4px;\">\n <table class=\"grid-dict\">\n \n <tr>\n <td>\n \n <b> Determine if the client is due for HepatitisA.:</b> Determine if the client is due for HepatitisA vaccine according to the national immunization protocol.\nLive attenuated hepatitis A virus (HAV), 1 dose schedule\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Client is due for Hepatitis A vaccination\n \n <i>(Client is due for Hepatitis A vaccination)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTMR.html\">IMMZD2DTMR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('draft')</i>\n <br/>\n \n intent: <i>('proposal')</i>\n <br/>\n \n medication: <i>(Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE5', display: 'Hepatitis A-containing vaccines' } }, display: 'Hepatitis A-containing vaccines' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n <tr>\n <td>\n \n <b> Check for Guidance for the patient regarding IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose.:</b> Show Guidance for the patient regarding IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose.\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Has Guidance\n \n <i>(Has Guidance)</i>\n <br/>\n \n \n \n \n <b>Then:</b> <i>Definition:</i> <a href=\"ActivityDefinition-IMMZD2DTCR.html\">IMMZ.D2.DT.CR</a><br/>\n \n <i>Dynamic Values:</i><br/>\n \n status: <i>('active')</i>\n <br/>\n \n payload.contentString: <i>(Guidance)</i>\n <br/>\n \n category.coding: <i>(Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' })</i>\n <br/>\n \n priority: <i>(Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' })</i>\n <br/>\n \n \n \n \n </td>\n </tr>\n \n </table>\n </td>\n </tr>\n \n </table>\n</div>\n</div>"
},
"contained" : [
{
"resourceType" : "Library",
"id" : "effective-data-requirements",
"extension" : [
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Current Patient Age In Months"
},
{
"url" : "statement",
"valueString" : "/** \n * @dataElement Patient age in months\n */\ndefine \"Current Patient Age In Months\":\n AgeInMonthsAt(Today)"
},
{
"url" : "displaySequence",
"valueInteger" : 0
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is less than 18 months"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is less than 18 months\n@pseudocode: Today's date − \"Date of birth\" < 18 months\n@code: Client's age is less than 18 months-42\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"Client's age is less than 18 months\":\n Encounter.\"Current Patient Age In Months\" < 18"
},
{
"url" : "displaySequence",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for Hepatitis A vaccination Case 1"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for Hepatitis A vaccination Case 1\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for Hepatitis A vaccination Case 1\":\n Encounter.\"Client's age is less than 18 months\""
},
{
"url" : "displaySequence",
"valueInteger" : 2
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZElements"
},
{
"url" : "name",
"valueString" : "Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/**\n * @dataElement All Doses Administered to Patient\n */\ndefine \"Doses Administered to Patient\":\n [Immunization] I\n where I.status = 'completed'\n and I.isSubpotent is not true"
},
{
"url" : "displaySequence",
"valueInteger" : 3
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/**\n * @dataElement All Doses Administered to Patient\n */\ndefine \"Doses Administered to Patient\":\n Elements.\"Doses Administered to Patient\" I\n where I.occurrence.toInterval() same day or before Today"
},
{
"url" : "displaySequence",
"valueInteger" : 4
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Hepatitis A Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis A containing Doses Administered to Patient\n*/\ndefine \"Hepatitis A Doses Administered to Patient\":\n Encounter.\"Doses Administered to Patient\" I\n where\n I.vaccineCode in Concepts.\"Hepatitis A-containing vaccines\""
},
{
"url" : "displaySequence",
"valueInteger" : 5
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Hepatitis A Primary Series Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis A containing Doses Administered to Patient that are in the Primary series\n*/\ndefine \"Hepatitis A Primary Series Doses Administered to Patient\":\n \"Hepatitis A Doses Administered to Patient\".seriesPrimary()"
},
{
"url" : "displaySequence",
"valueInteger" : 6
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Number of Hepatitis A Primary Series Doses Administered"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Number of Hepatitis A Primary Series doses\n*/\ndefine \"Number of Hepatitis A Primary Series Doses Administered\":\n Count(\"Hepatitis A Primary Series Doses Administered to Patient\")"
},
{
"url" : "displaySequence",
"valueInteger" : 7
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "No hepatitis A primary series doses were administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: No hepatitis A primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis A-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 0\n@code: No hepatitis A primary series doses were administered-131\n@decision: IMMZ.D2.DT.Hepatitis A.Inactivated HAV 2 doses: Inactivated hepatitis A virus (HAV), 2-dose schedule\n*/\ndefine \"No hepatitis A primary series doses were administered\":\n \"Number of Hepatitis A Primary Series Doses Administered\" = 0"
},
{
"url" : "displaySequence",
"valueInteger" : 8
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "No hepatitis A primary series dose was administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: No hepatitis A primary series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis A-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 0\n@code: No hepatitis A primary series dose was administered-131\n@decision: IMMZ.D2.DT.Hepatitis A.Inactivated HAV 1 dose: Inactivated hepatitis A virus (HAV), 1-dose schedule\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"No hepatitis A primary series dose was administered\":\n \"No hepatitis A primary series doses were administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 9
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is more than or equal to 18 months"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is more than or equal to 18 months\n@pseudocode: Today's date − \"Date of birth\" ≥ 18 months\n@code: Client's age is more than or equal to 18 months-42\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"Client's age is more than or equal to 18 months\":\n Encounter.\"Current Patient Age In Months\" >= 18"
},
{
"url" : "displaySequence",
"valueInteger" : 10
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZElements"
},
{
"url" : "name",
"valueString" : "Live Attenuated Vaccines"
},
{
"url" : "statement",
"valueString" : "/*\n @dataElement: Live attenuated vaccines\n*/\ndefine \"Live Attenuated Vaccines\":\n \"Doses Administered to Patient\" I \n where I.vaccineCode in Concepts.\"Live Attenuated\""
},
{
"url" : "displaySequence",
"valueInteger" : 11
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Live Attenuated Vaccines"
},
{
"url" : "statement",
"valueString" : "/*\n@dataElement Live attenuated vaccines\n*/\ndefine \"Live Attenuated Vaccines\":\n Elements.\"Live Attenuated Vaccines\" I\n where I.occurrence.toInterval() same day or before Today"
},
{
"url" : "displaySequence",
"valueInteger" : 12
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Date of Latest Live Attenuated Vaccine"
},
{
"url" : "statement",
"valueString" : "/*\n@dataElement Date and time of last live attenuated vaccine\n*/\ndefine \"Date of Latest Live Attenuated Vaccine\":\n date from start of \"Live Attenuated Vaccines\".mostRecent().occurrence.toInterval()"
},
{
"url" : "displaySequence",
"valueInteger" : 13
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Live vaccine was administered in the last 4 weeks"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Live vaccine was administered in the last 4 weeks\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Live vaccine\" = TRUE) < 4 weeks\n*/\ndefine \"Live vaccine was administered in the last 4 weeks\":\n\t\"Date of Latest Live Attenuated Vaccine\" is not null \n and duration in weeks between \"Date of Latest Live Attenuated Vaccine\" and Today < 4"
},
{
"url" : "displaySequence",
"valueInteger" : 14
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "Live vaccine was administered in the last 4 weeks"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Live vaccine was administered in the last 4 weeks\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Live vaccine\" = TRUE) < 4 weekS\n@code: Live vaccine was administered in the last 4 weeks-92\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"Live vaccine was administered in the last 4 weeks\":\n Encounter.\"Live vaccine was administered in the last 4 weeks\""
},
{
"url" : "displaySequence",
"valueInteger" : 15
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for Hepatitis A vaccination Case 2"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for Hepatitis A vaccination Case 2\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for Hepatitis A vaccination Case 2\":\n Encounter.\"No hepatitis A primary series dose was administered\"\n and Encounter.\"Client's age is more than or equal to 18 months\"\n and Encounter.\"Live vaccine was administered in the last 4 weeks\""
},
{
"url" : "displaySequence",
"valueInteger" : 16
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for Hepatitis A vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for Hepatitis A vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for Hepatitis A vaccination\":\n \"Client is not due for Hepatitis A vaccination Case 1\"\n or \"Client is not due for Hepatitis A vaccination Case 2\""
},
{
"url" : "displaySequence",
"valueInteger" : 17
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for Hepatitis A vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for Hepatitis A vaccination Guidance\n@guidance = Should not vaccinate client with Hepatitis A dose as client's age is less than 18 months. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.\n@guidance = Should not vaccinate client with Hepatitis A dose as live vaccine was administered in the last 4 weeks. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.\n*/\ndefine \"Client is not due for Hepatitis A vaccination Guidance\":\n case\n when \"Client is not due for Hepatitis A vaccination Case 1\" then 'Should not vaccinate client with Hepatitis A dose as client\\'s age is less than 18 months. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.'\n when \"Client is not due for Hepatitis A vaccination Case 2\" then 'Should not vaccinate client with Hepatitis A dose as live vaccine was administered in the last 4 weeks. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.'\n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 18
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "No live vaccine was administered in the last 4 weeks"
},
{
"url" : "statement",
"valueString" : "/*\n@input: No live vaccine was administered in the last 4 weeks\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Live vaccine\" = TRUE) ≥ 4 weeks\n*/\ndefine \"No live vaccine was administered in the last 4 weeks\":\n not(\"Live vaccine was administered in the last 4 weeks\")"
},
{
"url" : "displaySequence",
"valueInteger" : 19
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "No live vaccine was administered in the last 4 weeks"
},
{
"url" : "statement",
"valueString" : "/*\n@input: No live vaccine was administered in the last 4 weeks\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Live vaccine\" = TRUE) ≥ 4 weeks\n@code: No live vaccine was administered in the last 4 weeks-92\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"No live vaccine was administered in the last 4 weeks\":\n Encounter.\"No live vaccine was administered in the last 4 weeks\""
},
{
"url" : "displaySequence",
"valueInteger" : 20
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is due for Hepatitis A vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for Hepatitis A vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for Hepatitis A vaccination\":\n Encounter.\"No hepatitis A primary series dose was administered\"\n and Encounter.\"Client's age is more than or equal to 18 months\"\n and Encounter.\"No live vaccine was administered in the last 4 weeks\""
},
{
"url" : "displaySequence",
"valueInteger" : 21
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Client is due for Hepatitis A vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for Hepatitis A vaccination Guidance\n@guidance: Should vaccinate client with hepatitis A dose as no Hepatitis A dose was administered, client is within appropriate age range and no live vaccine was administered in the last 4 weeks. \nCheck for contraindications.\n*/\ndefine \"Client is due for Hepatitis A vaccination Guidance\":\n 'Should vaccinate client with hepatitis A dose as no Hepatitis A dose was administered, client is within appropriate age range and no live vaccine was administered in the last 4 weeks. \nCheck for contraindications.'"
},
{
"url" : "displaySequence",
"valueInteger" : 22
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisAEncounterElements"
},
{
"url" : "name",
"valueString" : "One hepatitis A primary series dose was administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: One hepatitis A primary series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis A-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n@code: One hepatitis A primary series dose was administered-131\n@decision: IMMZ.D2.DT.Hepatitis A.Inactivated HAV 2 doses: Inactivated hepatitis A virus (HAV), 2-dose schedule\n@decision: IMMZ.D2.DT.Hepatitis A.Inactivated HAV 1 dose: Inactivated hepatitis A virus (HAV), 1-dose schedule\n@decision: IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose: Live attenuated hepatitis A virus (HAV), 1 dose schedule\n*/\ndefine \"One hepatitis A primary series dose was administered\":\n \"Number of Hepatitis A Primary Series Doses Administered\" = 1"
},
{
"url" : "displaySequence",
"valueInteger" : 23
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Hepatitis A immunization schedule is complete"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Hepatitis A immunization schedule is complete\n@pseudocode: \"Immunization recommendation status\" = \"Complete\"\n\"Completed the primary vaccination series\" = TRUE (where \"Vaccine type\" = \"Hepatitis A-containing vaccines\")\n*/\ndefine \"Hepatitis A immunization schedule is complete\":\n Encounter.\"One hepatitis A primary series dose was administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 24
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Hepatitis A immunization schedule is complete Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Hepatitis A immunization schedule is complete Guidance\n@guidance: Hepatitis A immunization schedule is complete. One hepatitis A primary series dose was administered. \nCheck for any other vaccines due.\n*/\ndefine \"Hepatitis A immunization schedule is complete Guidance\":\n 'Hepatitis A immunization schedule is complete. One hepatitis A primary series dose was administered. \nCheck for any other vaccines due.'"
},
{
"url" : "displaySequence",
"valueInteger" : 25
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Guidance\n*/\ndefine \"Guidance\":\n case \n when \"Client is not due for Hepatitis A vaccination\" then \"Client is not due for Hepatitis A vaccination Guidance\"\n when \"Client is due for Hepatitis A vaccination\" then \"Client is due for Hepatitis A vaccination Guidance\"\n when \"Hepatitis A immunization schedule is complete\" then \"Hepatitis A immunization schedule is complete Guidance\" \n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 26
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
},
{
"url" : "name",
"valueString" : "Has Guidance"
},
{
"url" : "statement",
"valueString" : "define \"Has Guidance\":\n \"Guidance\" is not null and \"Guidance\" != ''"
},
{
"url" : "displaySequence",
"valueInteger" : 27
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZCommon"
},
{
"url" : "name",
"valueString" : "seriesPrimary"
},
{
"url" : "statement",
"valueString" : "/**\n * @description: Gets the doses from the primary series\n */\ndefine fluent function seriesPrimary(immunizations List<Immunization>):\n immunizations I where\n exists( I.protocolApplied pa where pa.series = 'Primary series' )"
},
{
"url" : "displaySequence",
"valueInteger" : 28
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToString"
},
{
"url" : "statement",
"valueString" : "define function ToString(value string): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 29
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToString"
},
{
"url" : "statement",
"valueString" : "define function ToString(value ImmunizationStatus): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 30
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToBoolean"
},
{
"url" : "statement",
"valueString" : "define function ToBoolean(value boolean): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 31
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToConcept"
},
{
"url" : "statement",
"valueString" : "define function ToConcept(concept FHIR.CodeableConcept):\n if concept is null then\n null\n else\n System.Concept {\n codes: concept.coding C return ToCode(C),\n display: concept.text.value\n }"
},
{
"url" : "displaySequence",
"valueInteger" : 32
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToCode"
},
{
"url" : "statement",
"valueString" : "define function ToCode(coding FHIR.Coding):\n if coding is null then\n null\n else\n System.Code {\n code: coding.code.value,\n system: coding.system.value,\n version: coding.version.value,\n display: coding.display.value\n }"
},
{
"url" : "displaySequence",
"valueInteger" : 33
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "WHOCommon"
},
{
"url" : "name",
"valueString" : "mostRecent"
},
{
"url" : "statement",
"valueString" : "define fluent function mostRecent(immunizations List<Immunization>):\n Last(\n immunizations I\n sort by start of occurrence.toInterval()\n )"
},
{
"url" : "displaySequence",
"valueInteger" : 34
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
}
],
"name" : "EffectiveDataRequirements",
"status" : "active",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/library-type",
"code" : "module-definition"
}
]
},
"relatedArtifact" : [
{
"type" : "depends-on",
"display" : "FHIR model information",
"resource" : "http://fhir.org/guides/cqf/common/Library/FHIR-ModelInfo|4.0.1"
},
{
"type" : "depends-on",
"display" : "Library Encounter",
"resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisAEncounterElements"
},
{
"type" : "depends-on",
"display" : "Library Encounter",
"resource" : "http://smart.who.int/immunizations/Library/IMMZEncounterElements"
},
{
"type" : "depends-on",
"display" : "Library Common",
"resource" : "http://smart.who.int/immunizations/Library/IMMZCommon"
},
{
"type" : "depends-on",
"display" : "Library FHIRHelpers",
"resource" : "http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1"
},
{
"type" : "depends-on",
"display" : "Library Elements",
"resource" : "http://smart.who.int/immunizations/Library/IMMZElements"
},
{
"type" : "depends-on",
"display" : "Library WC",
"resource" : "http://smart.who.int/immunizations/Library/WHOCommon"
},
{
"type" : "depends-on",
"display" : "Library FHIRHelpers",
"resource" : "http://fhir.org/guides/cqf/common/Library/FHIRHelpers|4.0.1"
},
{
"type" : "depends-on",
"display" : "Library Concepts",
"resource" : "http://smart.who.int/immunizations/Library/IMMZConcepts"
},
{
"type" : "depends-on",
"display" : "Library Concepts",
"resource" : "http://smart.who.int/immunizations/Library/IMMZConcepts"
},
{
"type" : "depends-on",
"display" : "Value set Hepatitis A-containing vaccines",
"resource" : "http://smart.who.int/immunizations/ValueSet/IMMZ.Z.DE5"
},
{
"type" : "depends-on",
"display" : "Value set Live Attenuated",
"resource" : "http://smart.who.int/immunizations/ValueSet/IMMZ.Z.LiveAttenuated"
}
],
"parameter" : [
{
"name" : "Today",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "Guidance",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Client is due for Hepatitis A vaccination",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
},
{
"name" : "Has Guidance",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "boolean"
}
],
"dataRequirement" : [
{
"type" : "Patient",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Patient"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"occurrence"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"occurrence",
"vaccineCode"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"vaccineCode"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"vaccineCode",
"occurrence"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"occurrence",
"vaccineCode"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"occurrence",
"vaccineCode"
]
}
]
}
],
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-knowledgeCapability",
"valueCode" : "computable"
},
{
"url" : "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-effectiveDataRequirements",
"valueCanonical" : "#effective-data-requirements"
}
],
"url" : "http://smart.who.int/immunizations/PlanDefinition/IMMZD2DTHepatitisALiveAttenuatedHAV1Dose",
"version" : "0.2.0",
"name" : "IMMZD2DTHepatitisALiveAttenuatedHAV1Dose",
"title" : "IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "eca-rule"
}
]
},
"status" : "draft",
"experimental" : false,
"date" : "2026-03-03T13:07:11+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose\nLive attenuated hepatitis A virus (HAV), 1 dose schedule",
"relatedArtifact" : [
{
"type" : "citation",
"citation" : "WHO recommendations for routine immunization - summary tables (January 2025)"
}
],
"library" : [
🔗 "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisALiveAttenuatedHAV1DoseLogic"
],
"action" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale",
"valueMarkdown" : "Live vaccines are licensed for individuals aged ≥18 months and are administered as a single subcutaneous dose."
}
],
"title" : "Determine if the client is due for HepatitisA.",
"description" : "Determine if the client is due for HepatitisA vaccine according to the national immunization protocol.\nLive attenuated hepatitis A virus (HAV), 1 dose schedule",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Client is due for Hepatitis A vaccination",
"language" : "text/cql-identifier",
"expression" : "Client is due for Hepatitis A vaccination"
}
}
],
"definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTMR",
"dynamicValue" : [
{
"path" : "status",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'draft'"
}
},
{
"path" : "intent",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'proposal'"
}
},
{
"path" : "medication",
"expression" : {
"language" : "text/cql-expression",
"expression" : "Concept { codes: { Code { system: 'http://smart.who.int/immunizations/CodeSystem/IMMZ.Z', code: 'DE5', display: 'Hepatitis A-containing vaccines' } }, display: 'Hepatitis A-containing vaccines' }"
}
}
]
},
{
"title" : "Check for Guidance for the patient regarding IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose.",
"description" : "Show Guidance for the patient regarding IMMZ.D2.DT.Hepatitis A.Live attenuated HAV 1 dose.",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Has Guidance",
"language" : "text/cql-identifier",
"expression" : "Has Guidance"
}
}
],
"definitionCanonical" : "http://smart.who.int/immunizations/ActivityDefinition/IMMZD2DTCR",
"dynamicValue" : [
{
"path" : "status",
"expression" : {
"language" : "text/cql-expression",
"expression" : "'active'"
}
},
{
"path" : "payload.contentString",
"expression" : {
"language" : "text/cql-identifier",
"expression" : "Guidance"
}
},
{
"path" : "category.coding",
"expression" : {
"description" : "Category of communication",
"language" : "text/cql-expression",
"expression" : "Code { system: 'http://terminology.hl7.org/CodeSystem/communication-category', code: 'alert' }"
}
},
{
"path" : "priority",
"expression" : {
"description" : "Alert priority",
"language" : "text/cql-expression",
"expression" : "Code { system: 'http://hl7.org/fhir/request-priority', code: 'routine' }"
}
}
]
}
]
}