{ "resourceType": "Library", "id": "IMMZD2DTHib3DosesWithBoosterDoseLogic", "meta": { "profile": [ "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary", "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary", "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-library", "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-module" ] }, "text": { "status": "extensions", "div": "
\n
\n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n\n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Title: IMMZD2DTHib3DosesWithBoosterDoseLogic
Id: IMMZD2DTHib3DosesWithBoosterDoseLogic
Version: 0.2.0
Url: IMMZD2DTHib3DosesWithBoosterDoseLogic
Status: draft
Type: \n \n \n \n

\n system: http://terminology.hl7.org/CodeSystem/library-type\n

\n \n \n

\n code: logic-library\n

\n \n \n \n \n \n
Date: 2026-03-29 17:23:09+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D2.DT.Hib.3 doses with booster dose decision table in the Immunization CPG

\n
Related Artifacts: \n \n \n \n

Dependencies

\n \n \n \n \n \n \n
Parameters: \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is not due for Hib vaccination Case 1boolean01Out
Client is not due for Hib vaccination Case 2boolean01Out
Client is not due for Hib vaccination Case 3boolean01Out
Client is not due for Hib vaccination Case 4boolean01Out
Client is not due for Hib vaccinationboolean01Out
Client is not due for Hib vaccination Guidancestring01Out
Client is due for Hib vaccination Case 1boolean01Out
Client is due for Hib vaccination Case 2boolean01Out
Client is due for Hib vaccination Case 3boolean01Out
Client is due for Hib vaccinationboolean01Out
Client is due for Hib vaccination Guidancestring01Out
Hib immunization schedule is complete Case 1boolean01Out
Hib immunization schedule is complete Case 2boolean01Out
Hib immunization schedule is completeboolean01Out
Hib immunization schedule is complete Guidancestring01Out
Primary series is complete. Client is not due for Hib booster doseboolean01Out
Primary series is complete. Client is not due for Hib booster dose Guidancestring01Out
Primary series is complete. Client is due for Hib booster doseboolean01Out
Primary series is complete. Client is due for Hib booster dose Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD2DTHib3DosesWithBoosterDoseLogic (IMMZ.D2.DT.Hib.3 doses with booster dose)\n * Rule: Determine if the client is due for a Haemophilus influenzae type b (Hib) vaccination according to the national immunization schedule\n * Decision Table: 3 primary doses with a booster dose (3p+1)\n * Trigger: IMMZ.D2 Determine required vaccination(s) if any\n */\nlibrary IMMZD2DTHib3DosesWithBoosterDoseLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude IMMZD2DTHibEncounterElements called Encounter\n\nparameter Today Date default Today()\n\ncontext Patient\n\n\n/*\n@dynamicValue: Guidance\n*/\ndefine "Guidance":\n  case \n    when "Client is not due for Hib vaccination" then "Client is not due for Hib vaccination Guidance"\n    when "Client is due for Hib vaccination" then "Client is due for Hib vaccination Guidance"\n    when "Hib immunization schedule is complete" then "Hib immunization schedule is complete Guidance"\n    when "Primary series is complete. Client is not due for Hib booster dose" then "Primary series is complete. Client is not due for Hib booster dose Guidance"\n    when "Primary series is complete. Client is due for Hib booster dose" then "Primary series is complete. Client is due for Hib booster dose Guidance" \n    else ''\n  end\n  \ndefine "Has Guidance":\n  "Guidance" is not null and "Guidance" != ''\n\n/*\n@output: Client is not due for Hib vaccination Case 1\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hib vaccination Case 1":\n  Encounter."Client's age is less than 6 weeks"\n\n/*\n@output: Client is not due for Hib vaccination Case 2\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hib vaccination Case 2":\n  Encounter."One Hib primary series dose was administered"\n    and Encounter."Client's age is at least 6 weeks and not more than 5 years"\n    and Encounter."Client's age was less than 1 year when first Hib dose was administered"\n    and Encounter."The latest Hib dose was administered less than 4 weeks ago"\n\n/*\n@output: Client is not due for Hib vaccination Case 3\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hib vaccination Case 3":\n  Encounter."Two Hib primary series doses were administered"\n    and Encounter."Client's age is between 6 weeks and not more than 5 years"\n    and Encounter."The latest Hib dose was administered less than 4 weeks ago"\n\n/*\n@output: Client is not due for Hib vaccination Case 4\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hib vaccination Case 4":\n  Encounter."Client's age is more than 5 years"\n\n/*\n@output: Client is not due for Hib vaccination\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hib vaccination":\n  "Client is not due for Hib vaccination Case 1"\n    or "Client is not due for Hib vaccination Case 2"\n    or "Client is not due for Hib vaccination Case 3"\n    or "Client is not due for Hib vaccination Case 4"\n\n/*\n@output: Client is not due for Hib vaccination Guidance\n@guidance = Should not vaccinate client with first Hib dose as client is less than 6 weeks old. \nCheck for any other vaccines due and inform the caregiver of when to come back for first dose.\n@guidance = Should not vaccinate client with second Hib dose as latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for second dose.\n@guidance = Should not vaccinate client with third Hib dose as the latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for third dose.\n@guidance = Should not vaccinate client with Hib dose as client is more than 5 years old and Hib vaccination is not required for healthy children aged over 5 years. \nCheck for any other vaccines due.\n*/\ndefine "Client is not due for Hib vaccination Guidance":\n  case\n    when "Client is not due for Hib vaccination Case 1" then 'Should not vaccinate client with first Hib dose as client is less than 6 weeks old. \nCheck for any other vaccines due and inform the caregiver of when to come back for first dose.'\n    when "Client is not due for Hib vaccination Case 2" then 'Should not vaccinate client with second Hib dose as latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for second dose.'\n    when "Client is not due for Hib vaccination Case 3" then 'Should not vaccinate client with third Hib dose as the latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for third dose.'\n    when "Client is not due for Hib vaccination Case 4" then 'Should not vaccinate client with Hib dose as client is more than 5 years old and Hib vaccination is not required for healthy children aged over 5 years. \nCheck for any other vaccines due.'\n    else ''\n  end\n\n/*\n@output: Client is due for Hib vaccination Case 1\n@pseudocode: "Immunization recommendation status" = "Due"\n*/\ndefine "Client is due for Hib vaccination Case 1":\n  Encounter."No Hib primary series doses were administered"\n    and Encounter."Client's age is between 6 weeks and 5 years"\n\n/*\n@output: Client is due for Hib vaccination Case 2\n@pseudocode: "Immunization recommendation status" = "Due"\n*/\ndefine "Client is due for Hib vaccination Case 2":\n  Encounter."One Hib primary series dose was administered"\n    and Encounter."Client's age is at least 6 weeks and not more than 5 years"\n    and Encounter."Client's age was less than 1 year when first Hib dose was administered"\n    and Encounter."The latest Hib dose was administered more than 4 weeks ago"\n\n/*\n@output: Client is due for Hib vaccination Case 3\n@pseudocode: "Immunization recommendation status" = "Due"\n*/\ndefine "Client is due for Hib vaccination Case 3":\n  Encounter."Two Hib primary series doses were administered"\n    and Encounter."Client's age is between 6 weeks and not more than 5 years"\n    and Encounter."The latest Hib dose was administered more than 4 weeks ago"\n\n/*\n@output: Client is due for Hib vaccination\n@pseudocode: "Immunization recommendation status" = "Due"\n*/\ndefine "Client is due for Hib vaccination":\n  "Client is due for Hib vaccination Case 1"\n    or "Client is due for Hib vaccination Case 2"\n    or "Client is due for Hib vaccination Case 3"\n\n/*\n@output: Client is due for Hib vaccination Guidance\n@guidance = Should vaccinate client with first Hib dose as client is within appropriate age range. \nCheck for contraindications.\n@guidance = Should vaccinate client with second Hib dose as client's age was less than 1 year when first Hib dose was administered and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.\n@guidance = Should vaccinate client with third Hib dose as client is within appropriate age range and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.\n*/\ndefine "Client is due for Hib vaccination Guidance":\n  case\n    when "Client is due for Hib vaccination Case 1" then 'Should vaccinate client with first Hib dose as client is within appropriate age range. \nCheck for contraindications.'\n    when "Client is due for Hib vaccination Case 2" then 'Should vaccinate client with second Hib dose as client\\'s age was less than 1 year when first Hib dose was administered and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.'\n    when "Client is due for Hib vaccination Case 3" then 'Should vaccinate client with third Hib dose as client is within appropriate age range and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.'\n    else ''\n  end\n\n/*\n@output: Hib immunization schedule is complete Case 1\n@pseudocode: "Immunization recommendation status" = "Complete"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Hib immunization schedule is complete Case 1":\n  Encounter."One Hib primary series dose was administered"\n    and Encounter."Client's age is at least 6 weeks and not more than 5 years"\n    and Encounter."Client's age was more than 1 year when first Hib dose was administered"\n\n/*\n@output: Hib immunization schedule is complete Case 2\n@pseudocode: "Immunization recommendation status" = "Complete"\n*/\ndefine "Hib immunization schedule is complete Case 2":\n  Encounter."Three Hib primary series doses were administered"\n    and Encounter."One Hib booster dose was administered"\n\n/*\n@output: Hib immunization schedule is complete\n@pseudocode: "Immunization recommendation status" = "Complete"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Hib immunization schedule is complete":\n  "Hib immunization schedule is complete Case 1"\n    or "Hib immunization schedule is complete Case 2"\n\n/*\n@output: Hib immunization schedule is complete Guidance\n@guidance = Hib immunization schedule is complete as client's age was more than 1 year when first Hib dose was administered.\nCheck for any other vaccines due.\n@guidance = Hib immunization schedule is complete. Three Hib primary series doses and one booster dose have been administered. \nCheck for any vaccines due.\n*/\ndefine "Hib immunization schedule is complete Guidance":\n  case\n    when "Hib immunization schedule is complete Case 1" then 'Hib immunization schedule is complete as client\\'s age was more than 1 year when first Hib dose was administered.\nCheck for any other vaccines due.'\n    when "Hib immunization schedule is complete Case 2" then 'Hib immunization schedule is complete. Three Hib primary series doses and one booster dose have been administered. \nCheck for any vaccines due.'\n    else ''\n  end\n\n/*\n@output: Primary series is complete. Client is not due for Hib booster dose\n@pseudocode: "Immunization recommendation status" = "Not due"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Primary series is complete. Client is not due for Hib booster dose":\n  Encounter."Three Hib primary series doses were administered"\n    and Encounter."No Hib booster doses were administered"\n    and Encounter."Client's age is between 6 weeks and 5 years"\n    and Encounter."The latest Hib dose was administered less than 6 months ago"\n\n/*\n@output: Primary series is complete. Client is not due for Hib booster dose Guidance\n@guidance: Should not vaccinate client with Hib booster dose as the latest Hib dose was administered less than 6 months ago. Hib primary series is complete. \nCheck for any other vaccines due and inform the caregiver of when to come back for booster dose.\n*/\ndefine "Primary series is complete. Client is not due for Hib booster dose Guidance":\n  'Should not vaccinate client with Hib booster dose as the latest Hib dose was administered less than 6 months ago. Hib primary series is complete. \nCheck for any other vaccines due and inform the caregiver of when to come back for booster dose.'\n\n/*\n@output: Primary series is complete. Client is due for Hib booster dose\n@pseudocode: "Immunization recommendation status" = "Due"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Primary series is complete. Client is due for Hib booster dose":\n  Encounter."Three Hib primary series doses were administered"\n    and Encounter."No Hib booster doses were administered"\n    and Encounter."Client's age is between 6 weeks and 5 years"\n    and Encounter."The latest Hib dose was administered more than 6 months ago"\n\n/*\n@output: Primary series is complete. Client is due for Hib booster dose Guidance\n@guidance: Should vaccinate client with Hib booster dose as primary series is complete and the latest Hib dose was administered more than 6 months ago. \nCheck for contraindications.\n*/\ndefine "Primary series is complete. Client is due for Hib booster dose Guidance":\n  'Should vaccinate client with Hib booster dose as primary series is complete and the latest Hib dose was administered more than 6 months ago. \nCheck for contraindications.'\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Hib24.1' then "Client is not due for Hib vaccination Case 1" and "Guidance" = 'Should not vaccinate client with first Hib dose as client is less than 6 weeks old. \nCheck for any other vaccines due and inform the caregiver of when to come back for first dose.'\n    when Patient.id = 'Hib25.2' then "Client is due for Hib vaccination Case 1" and "Guidance" = 'Should vaccinate client with first Hib dose as client is within appropriate age range. \nCheck for contraindications.'\n    when Patient.id = 'Hib26.4' then "Client is not due for Hib vaccination Case 2" and "Guidance" = 'Should not vaccinate client with second Hib dose as latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for second dose.'\n    when Patient.id = 'Hib27.4' then "Client is due for Hib vaccination Case 2" and "Guidance" = 'Should vaccinate client with second Hib dose as client\\'s age was less than 1 year when first Hib dose was administered and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.'\n    when Patient.id = 'Hib28.3' then "Hib immunization schedule is complete Case 1" and "Guidance" = 'Hib immunization schedule is complete as client\\'s age was more than 1 year when first Hib dose was administered.\nCheck for any other vaccines due.'\n    when Patient.id = 'Hib29.3' then "Client is not due for Hib vaccination Case 3" and "Guidance" = 'Should not vaccinate client with third Hib dose as the latest Hib dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for third dose.'\n    when Patient.id = 'Hib30.3' then "Client is due for Hib vaccination Case 3" and "Guidance" = 'Should vaccinate client with third Hib dose as client is within appropriate age range and the latest Hib dose was administered more than 4 weeks ago. \nCheck for contraindications.'\n    when Patient.id = 'Hib31.4' then "Primary series is complete. Client is not due for Hib booster dose" and "Guidance" = 'Should not vaccinate client with Hib booster dose as the latest Hib dose was administered less than 6 months ago. Hib primary series is complete. \nCheck for any other vaccines due and inform the caregiver of when to come back for booster dose.'\n    when Patient.id = 'Hib32.4' then "Primary series is complete. Client is due for Hib booster dose" and "Guidance" = 'Should vaccinate client with Hib booster dose as primary series is complete and the latest Hib dose was administered more than 6 months ago. \nCheck for contraindications.'\n    when Patient.id = 'Hib33.2' then "Hib immunization schedule is complete Case 2" and "Guidance" = 'Hib immunization schedule is complete. Three Hib primary series doses and one booster dose have been administered. \nCheck for any vaccines due.'\n    when Patient.id = 'Hib34.1' then "Client is not due for Hib vaccination Case 4" and "Guidance" = 'Should not vaccinate client with Hib dose as client is more than 5 years old and Hib vaccination is not required for healthy children aged over 5 years. \nCheck for any other vaccines due.'\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (144532 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD2DTHib3DosesWithBoosterDoseLogic", "version": "0.2.0", "name": "IMMZD2DTHib3DosesWithBoosterDoseLogic", "title": "IMMZD2DTHib3DosesWithBoosterDoseLogic", "status": "draft", "experimental": false, "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/library-type", "code": "logic-library" } ] }, "date": "2026-03-29T17:23:09+00:00", "publisher": "WHO", "contact": [ { "name": "WHO", "telecom": [ { "system": "url", "value": "http://who.int" } ] } ], "description": "This library defines decision support logic for the IMMZ.D2.DT.Hib.3 doses with booster dose decision table in the Immunization CPG", "relatedArtifact": [ { "type": "depends-on", "display": "Library Encounter", "resource": "http://smart.who.int/immunizations/Library/IMMZD2DTHibEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "Client is not due for Hib vaccination Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for Hib vaccination Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for Hib vaccination Case 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for Hib vaccination Case 4", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for Hib vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for Hib vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Client is due for Hib vaccination Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for Hib vaccination Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for Hib vaccination Case 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for Hib vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for Hib vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hib immunization schedule is complete Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib immunization schedule is complete Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib immunization schedule is complete", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib immunization schedule is complete Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Primary series is complete. Client is not due for Hib booster dose", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Primary series is complete. Client is not due for Hib booster dose Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Primary series is complete. Client is due for Hib booster dose", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Primary series is complete. Client is due for Hib booster dose Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Has Guidance", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Test Validation", "use": "out", "min": 0, "max": "1", "type": "Resource" } ], "content": [ { "contentType": "text/cql", "url": "Library-IMMZD2DTHib3DosesWithBoosterDoseLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD2DTHib3DosesWithBoosterDoseLogic.elm.xml" } ] }