{ "resourceType": "Library", "id": "IMMZD18STyphoidTy21aLogic", "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: IMMZD18STyphoidTy21aLogic
Id: IMMZD18STyphoidTy21aLogic
Version: 0.2.0
Url: IMMZD18STyphoidTy21aLogic
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-25 23:30:34+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D18.S.Typhoid.Ty21a 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
The primary series has been completedboolean01Out
Typhoid Ty21a primary seriesboolean01Out
Typhoid Ty21a primary series Due Datedate01Out
Typhoid Ty21a primary series Createstring01Out
Typhoid Ty21a primary series OverdueResource01Out
Typhoid Ty21a primary series ExpirationResource01Out
Typhoid booster dose(s) repeat 3-doses seriesboolean01Out
Typhoid booster dose(s) repeat 3-doses series Due Datedate01Out
Typhoid booster dose(s) repeat 3-doses series Overduedate01Out
Typhoid booster dose(s) repeat 3-doses series Createstring01Out
Typhoid booster dose(s) repeat 3-doses series ExpirationResource01Out
The booster series has been completedboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18STyphoidTy21aLogic (IMMZ.D18.S.Typhoid.Ty21a schedule)\n * Schedule Table: Live attenuated Ty21a vaccine, 3-dose schedule\n */\nlibrary IMMZD18STyphoidTy21aLogic\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 IMMZD2DTTyphoidEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: Typhoid Ty21a primary series\n@description: Provision of the typhoid Ty21a, 3-dose oral primary series immunization\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "Typhoid Ty21a primary series":\n  Encounter."No typhoid primary series doses were administered"\n  and not "The primary series has been completed"\n\n\n/*\n@output: Typhoid Ty21a primary series Create\n@create: Ty21a – 3-doses to be administered orally every second day from 6 years of age.\n*/\ndefine "Typhoid Ty21a primary series Create":\n  if "Typhoid Ty21a primary series"\n  then 'Ty21a – 3-doses to be administered orally every second day from 6 years of age.' + '\nDue Date: ' + ToString("Typhoid Ty21a primary series Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Typhoid Ty21a primary series Due Date\n@pseudocode: "Date of birth" + 6 years\n*/\ndefine "Typhoid Ty21a primary series Due Date":\n  if "Typhoid Ty21a primary series" then Patient.birthDate + 6 years\n  else null\n\n\n/*\n@dynamicValue: Typhoid Ty21a primary series Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date and individuals are always eligible to be vaccinated.\n*/\ndefine "Typhoid Ty21a primary series Overdue":\n  null\n\n\n/*\n@dynamicValue: Typhoid Ty21a primary series Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Typhoid Ty21a primary series Expiration":\n  null\n\n  \n/*\n@complete: The primary series has been completed\n@pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines")\n*/\ndefine "The primary series has been completed":\n  Encounter."Primary series is complete"\n\n\n\n/*\n@output: Typhoid booster dose(s) repeat 3-doses series\n@description: Provision of the typhoid booster dose(s): revaccination\n@trigger: The primary series has been completed\n@pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Typhoid vaccines")\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines")\n*/\ndefine "Typhoid booster dose(s) repeat 3-doses series":\n  "The primary series has been completed"\n\n\n/*\n@output: Typhoid booster dose(s) repeat 3-doses series Create\n@create: Revaccination (3-doses) is recommended every 3–7 years for Ty21a.\n*/\ndefine "Typhoid booster dose(s) repeat 3-doses series Create":\n  if "Typhoid booster dose(s) repeat 3-doses series"\n  then 'Revaccination (3-doses) is recommended every 3–7 years for Ty21a.' + '\nDue Date: ' + ToString("Typhoid booster dose(s) repeat 3-doses series Due Date") + '\nOverdue: ' + ToString("Typhoid booster dose(s) repeat 3-doses series Overdue")\n  else ''\n\n\n/*\n@dynamicValue: Typhoid booster dose(s) repeat 3-doses series Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") + 3 years\n*/\ndefine "Typhoid booster dose(s) repeat 3-doses series Due Date":\n  if "Typhoid booster dose(s) repeat 3-doses series" then Encounter."Date of Latest Typhoid Dose" + 3 years\n  else null\n\n\n/*\n@dynamicValue: Typhoid booster dose(s) repeat 3-doses series Overdue\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Typhoid vaccines") + 7 years\n*/\ndefine "Typhoid booster dose(s) repeat 3-doses series Overdue":\n  if "Typhoid booster dose(s) repeat 3-doses series" then Encounter."Date of Latest Typhoid Dose" + 7 years\n  else null\n\n\n/*\n@dynamicValue: Typhoid booster dose(s) repeat 3-doses series Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date and individuals are always eligible to be vaccinated.\n*/\ndefine "Typhoid booster dose(s) repeat 3-doses series Expiration":\n  null\n\n  \n/*\n@complete: The booster series has been completed\n@pseudocode: "Completed the booster series" = TRUE (where "Vaccine type" = "Typhoid vaccines")\n*/\ndefine "The booster series has been completed":\n  Encounter."Date of Latest Typhoid Dose" is not null\n  and duration in years between Encounter."Date of Latest Typhoid Dose" and Today < 3\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Typhoid30.1' then "Typhoid Ty21a primary series"\n    when Patient.id = 'Typhoid31.3' then "Typhoid Ty21a primary series"\n    when Patient.id = 'Typhoid32.3' then "Typhoid Ty21a primary series"\n    when Patient.id = 'Typhoid33.3' then "Typhoid booster dose(s) repeat 3-doses series"\n    when Patient.id = 'Typhoid34.4' then "Typhoid booster dose(s) repeat 3-doses series"\n    when Patient.id = 'Typhoid35.4' then "Typhoid booster dose(s) repeat 3-doses series"\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (64040 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18STyphoidTy21aLogic", "version": "0.2.0", "name": "IMMZD18STyphoidTy21aLogic", "title": "IMMZD18STyphoidTy21aLogic", "status": "draft", "experimental": false, "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/library-type", "code": "logic-library" } ] }, "date": "2026-03-25T23:30:34+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.Typhoid.Ty21a 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/IMMZD2DTTyphoidEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "The primary series has been completed", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Typhoid Ty21a primary series", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Typhoid Ty21a primary series Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Typhoid Ty21a primary series Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Typhoid Ty21a primary series Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Typhoid Ty21a primary series Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Typhoid booster dose(s) repeat 3-doses series", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Typhoid booster dose(s) repeat 3-doses series Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Typhoid booster dose(s) repeat 3-doses series Overdue", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Typhoid booster dose(s) repeat 3-doses series Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Typhoid booster dose(s) repeat 3-doses series Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "The booster series has been completed", "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-IMMZD18STyphoidTy21aLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18STyphoidTy21aLogic.elm.xml" } ] }