{ "resourceType": "Library", "id": "IMMZD18SHib3DosesLogic", "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: IMMZD18SHib3DosesLogic
Id: IMMZD18SHib3DosesLogic
Version: 0.2.0
Url: IMMZD18SHib3DosesLogic
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.D18.S.Hib.3 doses schedule 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Haemophilus influenzae type b (Hib) dose 1 Expirationdate01Out
Haemophilus influenzae type b (Hib) dose 1boolean01Out
Haemophilus influenzae type b (Hib) dose 1 Due Datedate01Out
Haemophilus influenzae type b (Hib) dose 1 Createstring01Out
Haemophilus influenzae type b (Hib) dose 1 OverdueResource01Out
First Hib dose from the primary series was administeredboolean01Out
Second Hib dose from the primary series was administeredboolean01Out
Hib dose 2 Expirationdate01Out
Hib dose 2boolean01Out
Hib dose 2 Due Datedate01Out
Hib dose 2 Createstring01Out
Hib dose 2 OverdueResource01Out
Third Hib dose from the primary series was administered. The primary series has been completedboolean01Out
Hib dose 3 Expirationdate01Out
Hib dose 3boolean01Out
Hib dose 3 Due Datedate01Out
Hib dose 3 Createstring01Out
Hib dose 3 OverdueResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SHib3DosesLogic (IMMZ.D18.S.Hib.3 doses schedule)\n * Schedule Table: 3 primary doses without a booster dose (3p) schedule\n */\nlibrary IMMZD18SHib3DosesLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude WHOCommon called WC\n\ninclude IMMZCommon called Common\ninclude IMMZConcepts called Concepts\n\ninclude IMMZEncounterElements called IE\ninclude IMMZD2DTHibEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: Haemophilus influenzae type b (Hib) dose 1\n@description: Provision of the Hib dose 1\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "Haemophilus influenzae type b (Hib) dose 1":\n  Encounter."No Hib primary series doses were administered"\n  and "Haemophilus influenzae type b (Hib) dose 1 Expiration" after day of Today\n\n\n/*\n@output: Haemophilus influenzae type b (Hib) dose 1 Create\n@create: Immunization should start from 6 weeks of age, or as early as possible thereafter.\nHib-containing vaccine is not required for healthy children aged over 5 years.\n*/\ndefine "Haemophilus influenzae type b (Hib) dose 1 Create":\n  if "Haemophilus influenzae type b (Hib) dose 1"\n  then 'Immunization should start from 6 weeks of age, or as early as possible thereafter.\nHib-containing vaccine is not required for healthy children aged over 5 years.' + '\nDue Date: ' + ToString("Haemophilus influenzae type b (Hib) dose 1 Due Date") + '\nExpiration: ' + ToString("Haemophilus influenzae type b (Hib) dose 1 Expiration")\n  else ''\n\n\n/*\n@dynamicValue: Haemophilus influenzae type b (Hib) dose 1 Due Date\n@pseudocode: "Date of birth" + 6 weeks\n*/\ndefine "Haemophilus influenzae type b (Hib) dose 1 Due Date":\n  if "Haemophilus influenzae type b (Hib) dose 1" then Patient.birthDate + 6 weeks\n  else null\n\n\n/*\n@dynamicValue: Haemophilus influenzae type b (Hib) dose 1 Overdue\n@pseudocode: To be determined by Member States\n*/\ndefine "Haemophilus influenzae type b (Hib) dose 1 Overdue":\n  null\n\n\n/*\n@dynamicValue: Haemophilus influenzae type b (Hib) dose 1 Expiration\n@pseudocode: "Date of birth" + 6 years\n*/\ndefine "Haemophilus influenzae type b (Hib) dose 1 Expiration":\n  Patient.birthDate + 6 years\n\n  \n/*\n@complete: First Hib dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 1\nThe primary series has been completed for delayed start\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "First Hib dose from the primary series was administered":\n  Encounter."One Hib primary series dose was administered"\n\n\n\n/*\n@output: Hib dose 2\n@description: Provision of the Hib dose 2\n@trigger: First Hib dose from the primary series was administered to the client within 1 year of age. Client's age is less than 5 years\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose" = "Primary series") = 1 AND "Date and time of vaccination" (where "Vaccine type"= "Hib-containing vaccines" and "Dose number" = 1) − "Date of birth" < 1 year AND Today's date − "Date of birth" ≤ 5 years\n@triggerDate: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Hib dose 2":\n  "First Hib dose from the primary series was administered"\n  and Encounter."Client's age was less than 1 year when first Hib dose was administered"\n  and Encounter."Client's age is between 6 weeks and 5 years"\n  and not "Second Hib dose from the primary series was administered"\n  and "Hib dose 2 Expiration" after day of Today\n\n\n/*\n@output: Hib dose 2 Create\n@create: Hib dose 2 should be provided if the client was given the previous dose more than 4 weeks ago and the first Hib dose was received by the time the child turned 1 year old\n*/\ndefine "Hib dose 2 Create":\n  if "Hib dose 2"\n  then 'Hib dose 2 should be provided if the client was given the previous dose more than 4 weeks ago and the first Hib dose was received by the time the child turned 1 year old' + '\nDue Date: ' + ToString("Hib dose 2 Due Date") + '\nExpiration: ' + ToString("Hib dose 2 Expiration")\n  else ''\n\n\n/*\n@dynamicValue: Hib dose 2 Due Date\n@pseudocode: "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") + 4 weeks\n*/\ndefine "Hib dose 2 Due Date":\n  if "Hib dose 2" then Encounter."Date of Latest Hib Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: Hib dose 2 Overdue\n@pseudocode: To be determined by Member States\n*/\ndefine "Hib dose 2 Overdue":\n  null\n\n\n/*\n@dynamicValue: Hib dose 2 Expiration\n@pseudocode: "Date of birth" + 6 years\n*/\ndefine "Hib dose 2 Expiration":\n  Patient.birthDate + 6 years\n\n  \n/*\n@complete: Second Hib dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 2\n*/\ndefine "Second Hib dose from the primary series was administered":\n  Encounter."Two Hib primary series doses were administered"\n\n\n\n/*\n@output: Hib dose 3\n@description: Provision of the Hib dose 3\n@trigger: Second Hib dose from the primary series was administered. Client's age is less than 5 years\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Hib-containing vaccines" and "Type of dose"= "Primary series") = 2 AND Today's date − "Date of birth" ≤ 5 years\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Hib dose 3":\n  "Second Hib dose from the primary series was administered"\n  and Encounter."Client's age is between 6 weeks and 5 years"\n  and not "Third Hib dose from the primary series was administered. The primary series has been completed"\n  and "Hib dose 3 Expiration" after day of Today\n\n\n/*\n@output: Hib dose 3 Create\n@create: Hib dose 3 should be provided if the client was given the previous dose more than 4 weeks before and the first Hib dose was received by the time the child turned 1 year old\n*/\ndefine "Hib dose 3 Create":\n  if "Hib dose 3"\n  then 'Hib dose 3 should be provided if the client was given the previous dose more than 4 weeks before and the first Hib dose was received by the time the child turned 1 year old' + '\nDue Date: ' + ToString("Hib dose 3 Due Date") + '\nExpiration: ' + ToString("Hib dose 3 Expiration")\n  else ''\n\n\n/*\n@dynamicValue: Hib dose 3 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Hib-containing vaccines") + 4 weeks\n*/\ndefine "Hib dose 3 Due Date":\n  if "Hib dose 3" then Encounter."Date of Latest Hib Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: Hib dose 3 Overdue\n@pseudocode: To be determined by Member States\n*/\ndefine "Hib dose 3 Overdue":\n  null\n\n\n/*\n@dynamicValue: Hib dose 3 Expiration\n@pseudocode: "Date of birth" + 6 years\n*/\ndefine "Hib dose 3 Expiration":\n  Patient.birthDate + 6 years\n\n  \n/*\n@complete: Third Hib dose from the primary series was administered. The primary series has been completed\n@pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hib-containing vaccines")\n*/\ndefine "Third Hib dose from the primary series was administered. The primary series has been completed":\n  Encounter."Three Hib primary series doses were administered"\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Hib08.1' then "Haemophilus influenzae type b (Hib) dose 1"\n    when Patient.id = 'Hib09.2' then "Haemophilus influenzae type b (Hib) dose 1"\n    when Patient.id = 'Hib10.4' then "Hib dose 2"\n    when Patient.id = 'Hib11.4' then "Hib dose 2"\n    when Patient.id = 'Hib12.3' then "First Hib dose from the primary series was administered" and not "Hib dose 2"\n    when Patient.id = 'Hib13.3' then "Hib dose 3"\n    when Patient.id = 'Hib14.3' then "Hib dose 3"\n    when Patient.id = 'Hib15.1' then not "Hib dose 3" and "Third Hib dose from the primary series was administered. The primary series has been completed"\n    when Patient.id = 'Hib16.1' then not "Haemophilus influenzae type b (Hib) dose 1"\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (101812 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SHib3DosesLogic", "version": "0.2.0", "name": "IMMZD18SHib3DosesLogic", "title": "IMMZD18SHib3DosesLogic", "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.D18.S.Hib.3 doses schedule table in the Immunization CPG", "relatedArtifact": [ { "type": "depends-on", "display": "Library WC", "resource": "http://smart.who.int/immunizations/Library/WHOCommon" }, { "type": "depends-on", "display": "Library Common", "resource": "http://smart.who.int/immunizations/Library/IMMZCommon" }, { "type": "depends-on", "display": "Library Concepts", "resource": "http://smart.who.int/immunizations/Library/IMMZConcepts" }, { "type": "depends-on", "display": "Library IE", "resource": "http://smart.who.int/immunizations/Library/IMMZEncounterElements" }, { "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": "Haemophilus influenzae type b (Hib) dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Haemophilus influenzae type b (Hib) dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Haemophilus influenzae type b (Hib) dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Haemophilus influenzae type b (Hib) dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Haemophilus influenzae type b (Hib) dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "First Hib dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Second Hib dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hib dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hib dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hib dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Third Hib dose from the primary series was administered. The primary series has been completed", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib dose 3 Expiration", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hib dose 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Hib dose 3 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Hib dose 3 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Hib dose 3 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Test Validation", "use": "out", "min": 0, "max": "1", "type": "Resource" } ], "content": [ { "contentType": "text/cql", "url": "Library-IMMZD18SHib3DosesLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SHib3DosesLogic.elm.xml" } ] }