WHO Immunization Implementation Guide
1.0.0 - release
WHO Immunization Implementation Guide
1.0.0 - release
WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.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/132/merge and changes regularly. See the Directory of published versions
| Draft as of 2026-03-31 |
{
"resourceType" : "PlanDefinition",
"id" : "IMMZD2DTHepatitisB4Doses",
"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;\">IMMZD2DTHepatitisB4Doses</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-IMMZD2DTHepatitisB4Doses.html\">IMMZ.D2.DT.Hepatitis B.4 doses</a></td>\n </tr>\n \n\n \n <tr>\n <th scope=\"row\"><b>Version: </b></th>\n <td style=\"padding-left: 4px;\">1.0.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 B.4 doses</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.1.0/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-31 13:54:17+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 B.4 doses\n4-dose schedule (birth dose + 3 primary series doses), on-time start</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-IMMZD2DTHepatitisB4DosesLogic.html\">IMMZD2DTHepatitisB4DosesLogic</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 a hepatitis B vaccination according to the national immunization schedule:</b> Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule\n4-dose schedule (birth dose + 3 primary series doses), on-time start\n \n <br/>\n \n \n <b>If:</b>\n \n <i>Applicability:</i>\n \n Client is due for a hepatitis B vaccination\n \n <i>(Client is due for a hepatitis B 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: 'DE6', display: 'Hepatitis B-containing vaccines' } }, display: 'Hepatitis B-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 B.4 doses.:</b> Show Guidance for the patient regarding IMMZ.D2.DT.Hepatitis B.4 doses.\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" : "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" : 0
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBElements"
},
{
"url" : "name",
"valueString" : "Hepatitis B Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis B containing Doses Administered to Patient\n*/\ndefine \"Hepatitis B Doses Administered to Patient\":\n Elements.\"Doses Administered to Patient\" I\n where\n I.vaccineCode in Concepts.\"Hepatitis B-containing vaccines\""
},
{
"url" : "displaySequence",
"valueInteger" : 1
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBElements"
},
{
"url" : "name",
"valueString" : "Hepatitis B Primary Series Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis B containing Doses Administered to Patient that are in the Primary series\n*/\ndefine \"Hepatitis B Primary Series Doses Administered to Patient\":\n \"Hepatitis B Doses Administered to Patient\".seriesPrimary()"
},
{
"url" : "displaySequence",
"valueInteger" : 2
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Hepatitis B Primary Series Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis B containing Doses Administered to Patient that are in the Primary series\n*/\ndefine \"Hepatitis B Primary Series Doses Administered to Patient\":\n HepatitisBElements.\"Hepatitis B Primary Series Doses Administered to Patient\".onOrBefore(Today)"
},
{
"url" : "displaySequence",
"valueInteger" : 3
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Number of Hepatitis B Primary Series Doses Administered"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Number of Hepatitis B Primary Series doses\n*/\ndefine \"Number of Hepatitis B Primary Series Doses Administered\":\n Count(\"Hepatitis B Primary Series Doses Administered to Patient\")"
},
{
"url" : "displaySequence",
"valueInteger" : 4
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "No hepatitis B primary series doses were administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: No hepatitis B primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\"and \"Type of dose\" = \"Primary series\") = 0\n@code: No hepatitis B primary series doses were administered-130\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"No hepatitis B primary series doses were administered\":\n \"Number of Hepatitis B Primary Series Doses Administered\" = 0"
},
{
"url" : "displaySequence",
"valueInteger" : 5
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZEncounterElements"
},
{
"url" : "name",
"valueString" : "Current Patient Age In Weeks"
},
{
"url" : "statement",
"valueString" : "/** \n * @dataElement Patient age in weeks\n */\ndefine \"Current Patient Age In Weeks\":\n AgeInWeeksAt(Today)"
},
{
"url" : "displaySequence",
"valueInteger" : 6
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is less than {Member States defined lower limit}"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is less than {Member States defined lower limit}\n@pseudocode: Today's date − \"Date of birth\" < Member States defined lower limit\n@code: Client's age is less than {Member States defined lower limit}-66\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"Client's age is less than {Member States defined lower limit}\":\n Encounter.\"Current Patient Age In Weeks\" < HepBLowerLimitWeeks"
},
{
"url" : "displaySequence",
"valueInteger" : 7
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for a hepatitis B vaccination Case 1"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for a hepatitis B vaccination Case 1\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for a hepatitis B vaccination Case 1\":\n Encounter.\"No hepatitis B primary series doses were administered\"\n and Encounter.\"Client's age is less than {Member States defined lower limit}\""
},
{
"url" : "displaySequence",
"valueInteger" : 8
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "One hepatitis B primary series dose was administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: One hepatitis B primary series dose was administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n@code: One hepatitis B primary series dose was administered-131\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n*/\ndefine \"One hepatitis B primary series dose was administered\":\n \"Number of Hepatitis B Primary Series Doses Administered\" = 1"
},
{
"url" : "displaySequence",
"valueInteger" : 9
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "One hepatitis B primary series doses were administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: One hepatitis B primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 1\n@code: One hepatitis B primary series doses were administered-131\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"One hepatitis B primary series doses were administered\":\n \"One hepatitis B primary series dose was administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 10
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Hepatitis B Doses Administered to Patient"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Hepatitis B containing Doses Administered to Patient\n*/\ndefine \"Hepatitis B Doses Administered to Patient\":\n HepatitisBElements.\"Hepatitis B Doses Administered to Patient\".onOrBefore(Today)"
},
{
"url" : "displaySequence",
"valueInteger" : 11
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Date of Latest Hepatitis B Dose"
},
{
"url" : "statement",
"valueString" : "/*\n@internal: Date of Latest Hepatitis B Dose\n*/\ndefine \"Date of Latest Hepatitis B Dose\":\n date from start of \"Hepatitis B Doses Administered to Patient\".mostRecent().occurrence.toInterval()"
},
{
"url" : "displaySequence",
"valueInteger" : 12
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest hepatitis B dose was administered less than 4 weeks ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest hepatitis B dose was administered less than 4 weeks ago\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\") < 4 weeks\n@code: The latest hepatitis B dose was administered less than 4 weeks ago-121\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.Delayed start: 3-dose schedule (no birth dose + 3 doses), delayed start\n*/\ndefine \"The latest hepatitis B dose was administered less than 4 weeks ago\":\n \"Date of Latest Hepatitis B Dose\" is not null\n and duration in weeks between \"Date of Latest Hepatitis B Dose\" and Today < 4"
},
{
"url" : "displaySequence",
"valueInteger" : 13
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for a hepatitis B vaccination Case 2"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for a hepatitis B vaccination Case 2\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for a hepatitis B vaccination Case 2\":\n Encounter.\"One hepatitis B primary series doses were administered\"\n and Encounter.\"The latest hepatitis B dose was administered less than 4 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 14
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Two hepatitis B primary series doses were administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Two hepatitis B primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 2\n@code: Two hepatitis B primary series doses were administered-131\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"Two hepatitis B primary series doses were administered\":\n \"Number of Hepatitis B Primary Series Doses Administered\" = 2"
},
{
"url" : "displaySequence",
"valueInteger" : 15
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for a hepatitis B vaccination Case 3"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for a hepatitis B vaccination Case 3\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for a hepatitis B vaccination Case 3\":\n Encounter.\"Two hepatitis B primary series doses were administered\"\n and Encounter.\"The latest hepatitis B dose was administered less than 4 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 16
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for a hepatitis B vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for a hepatitis B vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Not due\"\n*/\ndefine \"Client is not due for a hepatitis B vaccination\":\n \"Client is not due for a hepatitis B vaccination Case 1\"\n or \"Client is not due for a hepatitis B vaccination Case 2\"\n or \"Client is not due for a hepatitis B vaccination Case 3\""
},
{
"url" : "displaySequence",
"valueInteger" : 17
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is not due for a hepatitis B vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is not due for a hepatitis B vaccination Guidance\n@guidance = Should not vaccinate client with first hepatitis B dose as client's age is not within appropriate age range.\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 second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago.\nCheck for any other vaccines due and inform the caregiver of when to come back for the second dose.\n@guidance = Should not vaccinate client with third hepatitis B dose as the latest Hepatitis B dose was administered less than 4 weeks ago.\nCheck for any other vaccines due, and inform the caregiver of when to come back for the third dose.\n*/\ndefine \"Client is not due for a hepatitis B vaccination Guidance\":\n case\n when \"Client is not due for a hepatitis B vaccination Case 1\" then 'Should not vaccinate client with first hepatitis B dose as client\\'s age is not within appropriate age range.\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 a hepatitis B vaccination Case 2\" then 'Should not vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered less than 4 weeks ago.\nCheck for any other vaccines due and inform the caregiver of when to come back for the second dose.'\n when \"Client is not due for a hepatitis B vaccination Case 3\" then 'Should not vaccinate client with third hepatitis B dose as the latest Hepatitis B dose was administered less than 4 weeks ago.\nCheck for any other vaccines due, and inform the caregiver of when to come back for the third dose.'\n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 18
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Client's age is more than or equal to {Member States defined lower limit}"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Client's age is more than or equal to {Member States defined lower limit}\n@pseudocode: Today's date − \"Date of birth\" ≥ Member States defined lower limit\n@code: Client's age is more than or equal to {Member States defined lower limit}-66\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"Client's age is more than or equal to {Member States defined lower limit}\":\n Encounter.\"Current Patient Age In Weeks\" >= HepBLowerLimitWeeks"
},
{
"url" : "displaySequence",
"valueInteger" : 19
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for a hepatitis B vaccination Case 1"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for a hepatitis B vaccination Case 1\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for a hepatitis B vaccination Case 1\":\n Encounter.\"No hepatitis B primary series doses were administered\"\n and Encounter.\"Client's age is more than or equal to {Member States defined lower limit}\""
},
{
"url" : "displaySequence",
"valueInteger" : 20
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "The latest hepatitis B dose was administered more than 4 weeks ago"
},
{
"url" : "statement",
"valueString" : "/*\n@input: The latest hepatitis B dose was administered more than 4 weeks ago\n@pseudocode: Today's date − latest \"Date and time of vaccination\" (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\") ≥ 4 weeks\n@code: The latest hepatitis B dose was administered more than 4 weeks ago-121\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.Delayed start: 3-dose schedule (no birth dose + 3 doses), delayed start\n*/\ndefine \"The latest hepatitis B dose was administered more than 4 weeks ago\":\n not(\"The latest hepatitis B dose was administered less than 4 weeks ago\")"
},
{
"url" : "displaySequence",
"valueInteger" : 21
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for a hepatitis B vaccination Case 2"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for a hepatitis B vaccination Case 2\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for a hepatitis B vaccination Case 2\":\n Encounter.\"One hepatitis B primary series doses were administered\"\n and Encounter.\"The latest hepatitis B dose was administered more than 4 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 22
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for a hepatitis B vaccination Case 3"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for a hepatitis B vaccination Case 3\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for a hepatitis B vaccination Case 3\":\n Encounter.\"Two hepatitis B primary series doses were administered\"\n and Encounter.\"The latest hepatitis B dose was administered more than 4 weeks ago\""
},
{
"url" : "displaySequence",
"valueInteger" : 23
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for a hepatitis B vaccination"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for a hepatitis B vaccination\n@pseudocode: \"Immunization recommendation status\" = \"Due\"\n*/\ndefine \"Client is due for a hepatitis B vaccination\":\n \"Client is due for a hepatitis B vaccination Case 1\"\n or \"Client is due for a hepatitis B vaccination Case 2\"\n or \"Client is due for a hepatitis B vaccination Case 3\""
},
{
"url" : "displaySequence",
"valueInteger" : 24
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Client is due for a hepatitis B vaccination Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Client is due for a hepatitis B vaccination Guidance\n@guidance = Should vaccinate client with first hepatitis B dose as client's age is within appropriate age range.\nCheck for contraindications.\n@guidance = Should vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered more than 4 weeks ago.\nCheck for contraindications.\n@guidance = Should vaccinate client with third hepatitis B dose as the latest Hepatitis B dose was administered more than 4 weeks ago.\nCheck for contraindications.\n*/\ndefine \"Client is due for a hepatitis B vaccination Guidance\":\n case\n when \"Client is due for a hepatitis B vaccination Case 1\" then 'Should vaccinate client with first hepatitis B dose as client\\'s age is within appropriate age range.\nCheck for contraindications.'\n when \"Client is due for a hepatitis B vaccination Case 2\" then 'Should vaccinate client with second hepatitis B dose as the latest hepatitis B dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n when \"Client is due for a hepatitis B vaccination Case 3\" then 'Should vaccinate client with third hepatitis B dose as the latest Hepatitis B dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 25
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisBEncounterElements"
},
{
"url" : "name",
"valueString" : "Three hepatitis B primary series doses were administered"
},
{
"url" : "statement",
"valueString" : "/*\n@input: Three hepatitis B primary series doses were administered\n@pseudocode: Count of vaccines administered (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\" and \"Type of dose\" = \"Primary series\") = 3\n@code: Three hepatitis B primary series doses were administered-131\n@decision: IMMZ.D2.DT.Hepatitis B.3 doses: 3-dose schedule (birth dose + 2 primary series doses), on-time start\n@decision: IMMZ.D2.DT.Hepatitis B.4 doses: 4-dose schedule (birth dose + 3 primary series doses), on-time start\n*/\ndefine \"Three hepatitis B primary series doses were administered\":\n \"Number of Hepatitis B Primary Series Doses Administered\" = 3"
},
{
"url" : "displaySequence",
"valueInteger" : 26
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Hepatitis B immunization schedule is complete"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Hepatitis B immunization schedule is complete\n@pseudocode: '\"Immunization recommendation status\" = \"Complete\"\n\"Completed the primary vaccination series\" = TRUE (where \"Vaccine type\" = \"Hepatitis B-containing vaccines\")\n*/\ndefine \"Hepatitis B immunization schedule is complete\":\n Encounter.\"Three hepatitis B primary series doses were administered\""
},
{
"url" : "displaySequence",
"valueInteger" : 27
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Hepatitis B immunization schedule is complete Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@output: Hepatitis B immunization schedule is complete Guidance\n@guidance: The hepatitis B immunization schedule is complete. Three hepatitis B primary series doses were administered.\nCheck for any other vaccines due.\n*/\ndefine \"Hepatitis B immunization schedule is complete Guidance\":\n 'The hepatitis B immunization schedule is complete. Three hepatitis B primary series doses were administered.\nCheck for any other vaccines due.'"
},
{
"url" : "displaySequence",
"valueInteger" : 28
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Guidance"
},
{
"url" : "statement",
"valueString" : "/*\n@dynamicValue: Guidance\n*/\ndefine \"Guidance\":\n case \n when \"Client is not due for a hepatitis B vaccination\" then \"Client is not due for a hepatitis B vaccination Guidance\"\n when \"Client is due for a hepatitis B vaccination\" then \"Client is due for a hepatitis B vaccination Guidance\"\n when \"Hepatitis B immunization schedule is complete\" then \"Hepatitis B immunization schedule is complete Guidance\" \n else ''\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 29
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZD2DTHepatitisB4DosesLogic"
},
{
"url" : "name",
"valueString" : "Has Guidance"
},
{
"url" : "statement",
"valueString" : "define \"Has Guidance\":\n \"Guidance\" is not null and \"Guidance\" != ''"
},
{
"url" : "displaySequence",
"valueInteger" : 30
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "IMMZCommon"
},
{
"url" : "name",
"valueString" : "onOrBefore"
},
{
"url" : "statement",
"valueString" : "/**\n * @description: Gets immunizations on or before a date\n */\ndefine fluent function onOrBefore(immunizations List<Immunization>, beforeDate Date):\n immunizations I where\n I.occurrence.toInterval() same day or before beforeDate"
},
{
"url" : "displaySequence",
"valueInteger" : 31
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "WHOCommon"
},
{
"url" : "name",
"valueString" : "toInterval"
},
{
"url" : "statement",
"valueString" : "/*\nFrom FHIRCommon 4.1.0:\n*/\n\n/*\n@description: Normalizes a value that is a choice of timing-valued types to an equivalent interval\n@comment: Normalizes a choice type of FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instance, FHIR.string, FHIR.Age, or FHIR.Range types\nto an equivalent interval. This selection of choice types is a superset of the majority of choice types that are used as possible\nrepresentations for timing-valued elements in FHIR, allowing this function to be used across any resource.\n\nThe input can be provided as a dateTime, Period, Timing, instant, string, Age, or Range.\nThe intent of this function is to provide a clear and concise mechanism to treat single\nelements that have multiple possible representations as intervals so that logic doesn't have to account\nfor the variability. More complex calculations (such as medication request period or dispense period\ncalculation) need specific guidance and consideration. That guidance may make use of this function, but\nthe focus of this function is on single element calculations where the semantics are unambiguous.\nIf the input is a dateTime, the result a DateTime Interval beginning and ending on that dateTime.\nIf the input is a Period, the result is a DateTime Interval.\nIf the input is a Timing, an error is raised indicating a single interval cannot be computed from a Timing.\nIf the input is an instant, the result is a DateTime Interval beginning and ending on that instant.\nIf the input is a string, an error is raised indicating a single interval cannot be computed from a string.\nIf the input is an Age, the result is a DateTime Interval beginning when the patient was the given Age,\nand ending immediately prior to when the patient was the given Age plus one year.\nIf the input is a Range, the result is a DateTime Interval beginning when the patient was the Age given\nby the low end of the Range, and ending immediately prior to when the patient was the Age given by the\nhigh end of the Range plus one year.\n\nNOTE: Due to the\ncomplexity of determining a single interval from a Timing or String type, this function will throw a run-time exception if it is used\nwith a Timing or String.\n*/\ndefine fluent function toInterval(choice Choice<FHIR.dateTime, FHIR.Period, FHIR.Timing, FHIR.instant, FHIR.string, FHIR.Age, FHIR.Range>):\n case\n when choice is FHIR.dateTime then\n Interval[FHIRHelpers.ToDateTime(choice as FHIR.dateTime), FHIRHelpers.ToDateTime(choice as FHIR.dateTime)]\n when choice is FHIR.Period then\n FHIRHelpers.ToInterval(choice as FHIR.Period)\n when choice is FHIR.instant then\n Interval[FHIRHelpers.ToDateTime(choice as FHIR.instant), FHIRHelpers.ToDateTime(choice as FHIR.instant)]\n when choice is FHIR.Age then\n Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age),\n FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity(choice as FHIR.Age) + 1 year)\n when choice is FHIR.Range then\n Interval[FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).low),\n FHIRHelpers.ToDate(Patient.birthDate) + FHIRHelpers.ToQuantity((choice as FHIR.Range).high) + 1 year)\n when choice is FHIR.Timing then\n Message(null as Interval<DateTime>, true, 'NOT_IMPLEMENTED', 'Error', 'Calculation of an interval from a Timing value is not supported')\n when choice is FHIR.string then\n Message(null as Interval<DateTime>, true, 'NOT_IMPLEMENTED', 'Error', 'Calculation of an interval from a String value is not supported')\n else\n null as Interval<DateTime>\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 32
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToDateTime"
},
{
"url" : "statement",
"valueString" : "define function ToDateTime(value dateTime): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 33
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToInterval"
},
{
"url" : "statement",
"valueString" : "define function ToInterval(period FHIR.Period):\n if period is null then\n null\n else\n if period.\"start\" is null then\n Interval(period.\"start\".value, period.\"end\".value]\n else\n Interval[period.\"start\".value, period.\"end\".value]"
},
{
"url" : "displaySequence",
"valueInteger" : 34
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToDateTime"
},
{
"url" : "statement",
"valueString" : "define function ToDateTime(value instant): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 35
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToDate"
},
{
"url" : "statement",
"valueString" : "define function ToDate(value date): value.value"
},
{
"url" : "displaySequence",
"valueInteger" : 36
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToQuantity"
},
{
"url" : "statement",
"valueString" : "define function ToQuantity(quantity FHIR.Quantity):\n case\n when quantity is null then null\n when quantity.value is null then null\n when quantity.comparator is not null then\n Message(null, true, 'FHIRHelpers.ToQuantity.ComparatorQuantityNotSupported', 'Error', 'FHIR Quantity value has a comparator and cannot be converted to a System.Quantity value.')\n when quantity.system is null or quantity.system.value = 'http://unitsofmeasure.org'\n or quantity.system.value = 'http://hl7.org/fhirpath/CodeSystem/calendar-units' then\n System.Quantity { value: quantity.value.value, unit: ToCalendarUnit(Coalesce(quantity.code.value, quantity.unit.value, '1')) }\n else\n Message(null, true, 'FHIRHelpers.ToQuantity.InvalidFHIRQuantity', 'Error', 'Invalid FHIR Quantity code: ' & quantity.unit.value & ' (' & quantity.system.value & '|' & quantity.code.value & ')')\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 37
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/cqf-logicDefinition"
},
{
"extension" : [
{
"url" : "libraryName",
"valueString" : "FHIRHelpers"
},
{
"url" : "name",
"valueString" : "ToCalendarUnit"
},
{
"url" : "statement",
"valueString" : "define function ToCalendarUnit(unit System.String):\n case unit\n when 'ms' then 'millisecond'\n when 's' then 'second'\n when 'min' then 'minute'\n when 'h' then 'hour'\n when 'd' then 'day'\n when 'wk' then 'week'\n when 'mo' then 'month'\n when 'a' then 'year'\n else unit\n end"
},
{
"url" : "displaySequence",
"valueInteger" : 38
}
],
"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" : 39
}
],
"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" : 40
}
],
"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" : 41
}
],
"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" : 42
}
],
"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" : 43
}
],
"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" : 44
}
],
"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" : 45
}
],
"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/IMMZD2DTHepatitisBEncounterElements"
},
{
"type" : "depends-on",
"display" : "Library Common",
"resource" : "http://smart.who.int/immunizations/Library/IMMZCommon"
},
{
"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 HepatitisBElements",
"resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisBElements"
},
{
"type" : "depends-on",
"display" : "Library Elements",
"resource" : "http://smart.who.int/immunizations/Library/IMMZElements"
},
{
"type" : "depends-on",
"display" : "Library Concepts",
"resource" : "http://smart.who.int/immunizations/Library/IMMZConcepts"
},
{
"type" : "depends-on",
"display" : "Library Encounter",
"resource" : "http://smart.who.int/immunizations/Library/IMMZEncounterElements"
},
{
"type" : "depends-on",
"display" : "Value set Hepatitis B-containing vaccines",
"resource" : "http://smart.who.int/immunizations/ValueSet/IMMZ.Z.DE6"
}
],
"parameter" : [
{
"name" : "Today",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "date"
},
{
"name" : "HepBLowerLimitWeeks",
"use" : "in",
"min" : 0,
"max" : "1",
"type" : "integer"
},
{
"name" : "Guidance",
"use" : "out",
"min" : 0,
"max" : "1",
"type" : "string"
},
{
"name" : "Client is due for a hepatitis B 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"
],
"mustSupport" : [
"birthDate"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"occurrence",
"protocolApplied"
],
"codeFilter" : [
{
"path" : "status",
"code" : [
{
"code" : "completed"
}
]
}
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"occurrence",
"protocolApplied"
]
},
{
"type" : "Immunization",
"profile" : [
🔗 "http://hl7.org/fhir/StructureDefinition/Immunization"
],
"mustSupport" : [
"status",
"isSubpotent",
"vaccineCode",
"occurrence",
"protocolApplied"
],
"codeFilter" : [
{
"path" : "status",
"code" : [
{
"code" : "completed"
}
]
},
{
"path" : "vaccineCode",
"valueSet" : "http://smart.who.int/immunizations/ValueSet/IMMZ.Z.DE6"
}
]
}
]
}
],
"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/IMMZD2DTHepatitisB4Doses",
"version" : "1.0.0",
"name" : "IMMZD2DTHepatitisB4Doses",
"title" : "IMMZ.D2.DT.Hepatitis B.4 doses",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "eca-rule"
}
]
},
"status" : "draft",
"experimental" : false,
"date" : "2026-03-31T13:54:17+00:00",
"publisher" : "WHO",
"contact" : [
{
"name" : "WHO",
"telecom" : [
{
"system" : "url",
"value" : "http://who.int"
}
]
}
],
"description" : "IMMZ.D2.DT.Hepatitis B.4 doses\n4-dose schedule (birth dose + 3 primary series doses), on-time start",
"relatedArtifact" : [
{
"type" : "citation",
"citation" : "WHO recommendations for routine immunization - summary tables (January 2025)"
}
],
"library" : [
🔗 "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisB4DosesLogic"
],
"action" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-rationale",
"valueMarkdown" : "Monovalent birth dose is followed by 3 (monovalent or combined vaccine) doses, usually given with other routine infant vaccines; \n the additional dose does not cause any harm. The interval between doses should be at least 4 weeks."
}
],
"title" : "Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule",
"description" : "Determine if the client is due for a hepatitis B vaccination according to the national immunization schedule\n4-dose schedule (birth dose + 3 primary series doses), on-time start",
"condition" : [
{
"kind" : "applicability",
"expression" : {
"description" : "Client is due for a hepatitis B vaccination",
"language" : "text/cql-identifier",
"expression" : "Client is due for a hepatitis B 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: 'DE6', display: 'Hepatitis B-containing vaccines' } }, display: 'Hepatitis B-containing vaccines' }"
}
}
]
},
{
"title" : "Check for Guidance for the patient regarding IMMZ.D2.DT.Hepatitis B.4 doses.",
"description" : "Show Guidance for the patient regarding IMMZ.D2.DT.Hepatitis B.4 doses.",
"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' }"
}
}
]
}
]
}