{ "resourceType": "Library", "id": "IMMZD18SDTPPregnancyStartingWith4DosesLogic", "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: IMMZD18SDTPPregnancyStartingWith4DosesLogic
Id: IMMZD18SDTPPregnancyStartingWith4DosesLogic
Version: 0.2.0
Url: IMMZD18SDTPPregnancyStartingWith4DosesLogic
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.DTP.Pregnancy starting with 4 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Second tetanus and diphtheria booster dose was administeredboolean01Out
Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)boolean01Out
Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Due Datedate01Out
Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Overduedate01Out
Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Expirationstring01Out
Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Createstring01Out
Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed.boolean01Out
Tetanus and diphtheria-containing vaccine booster dose 3boolean01Out
Tetanus and diphtheria-containing vaccine booster dose 3 Due Datedate01Out
Tetanus and diphtheria-containing vaccine booster dose 3 Createstring01Out
Tetanus and diphtheria-containing vaccine booster dose 3 OverdueResource01Out
Tetanus and diphtheria-containing vaccine booster dose 3 ExpirationResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SDTPPregnancyStartingWith4DosesLogic (IMMZ.D18.S.DTP.Pregnancy starting with 4 doses schedule)\n * Schedule Table: Diphtheria and tetanus vaccination schedule in pregnant women who received 4 childhood diphtheria–tetanus–pertussis (DTP) doses\n */\nlibrary IMMZD18SDTPPregnancyStartingWith4DosesLogic\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 IMMZD2DTDTPEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)\n@description: Provision of tetanus and diphtheria booster dose 2 for pregnant women who received 4 tetanus-containing vaccines doses during childhood or pre-adulthood\n@trigger: The primary DTP series has been completed, first tetanus and diphtheria booster dose was administered and client is currently pregnant\n@pseudo: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "DTP-containing vaccines") AND Count of vaccines administered where "Vaccine type" = "Tetanus and diphtheria-containing vaccines" and "Type of dose" = "Booster dose") = 1 AND "Currently pregnant" = TRUE\n@triggerDate: First ANC contact date\n"Contact date" WHEN "ANC contact number" = 1\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)":\n  Encounter."Three DTP primary series doses were administered" and\n  Encounter."One tetanus and diphtheria booster dose was administered" and\n  Encounter."Client is currently pregnant" and\n  not "Second tetanus and diphtheria booster dose was administered"\n\n\n/*\n@output: Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Create\n@create: Women who received 4 tetanus-containing vaccine doses during childhood or pre-adulthood need only 1 booster dose, which should be given at the first opportunity.\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Create":\n  if "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)"\n  then 'Women who received 4 tetanus-containing vaccine doses during childhood or pre-adulthood need only 1 booster dose, which should be given at the first opportunity.' + '\nDue Date: ' + ToString("Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Due Date") + '\nOverdue: ' + ToString("Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Overdue") + '\nExpiration: ' + "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Expiration"\n  else ''\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Due Date\n@pseudocode: "Contact date" WHEN "ANC contact number" = 1\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Due Date":\n  if "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)" then Today\n  else null\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Overdue\n@pseudocode: Every subsequent contact until 38 weeks\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Overdue":\n  if "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)" then Today\n  else null\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Expiration\n@pseudocode: Two weeks before birth for the pregnancy; however individuals remain eligible to be vaccinated\n"Gestational age" < 38 weeks\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Expiration":\n  if "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)" then 'Two weeks before birth'\n  else null\n\n  \n/*\n@complete: Second tetanus and diphtheria booster dose was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Tetanus and diphtheria-containing vaccines" and "Type of dose" = "Booster dose") = 2\n*/\ndefine "Second tetanus and diphtheria booster dose was administered":\n  Encounter."Two tetanus and diphtheria booster doses were administered"\n\n\n\n/*\n@output: Tetanus and diphtheria-containing vaccine booster dose 3\n@description: Provision of tetanus and diphtheria booster dose 3 for pregnant women who received 4 tetanus-containing vaccines doses during childhood or pre-adulthood\n@trigger: Second tetanus and diphtheria booster dose was administered\n@pseudo: Count of vaccines administered (where "Vaccine type" = "Tetanus and diphtheria-containing vaccines" and "Type of dose" = "Booster dose") = 2\n@triggerDate: Latest "Date and time of vaccination" where "Vaccine type" = "Tetanus and diphtheria-containing vaccines"\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 3":\n  "Second tetanus and diphtheria booster dose was administered" and\n  not "Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed."\n\n\n/*\n@output: Tetanus and diphtheria-containing vaccine booster dose 3 Create\n@create: To provide lifelong protection for tetanus, a sixth dose should be provided at least 1 year after the fifth dose, or in next pregnancy.\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 3 Create":\n  if "Tetanus and diphtheria-containing vaccine booster dose 3"\n  then 'To provide lifelong protection for tetanus, a sixth dose should be provided at least 1 year after the fifth dose, or in next pregnancy.' + '\nDue Date: ' + ToString("Tetanus and diphtheria-containing vaccine booster dose 3 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 3 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "Tetanus and diphtheria-containing vaccines") + 1 year or during next pregnancy\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 3 Due Date":\n  if "Tetanus and diphtheria-containing vaccine booster dose 3" then Encounter."Date of Latest Td Dose" + 1 year\n  else null\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 3 Overdue\n@pseudocode: To be determined by Member States\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 3 Overdue":\n  null\n\n\n/*\n@dynamicValue: Tetanus and diphtheria-containing vaccine booster dose 3 Expiration\n@pseudocode: To be determined by Member States. However, there is no recommended expiration date and individuals remain eligible to be vaccinated.\n*/\ndefine "Tetanus and diphtheria-containing vaccine booster dose 3 Expiration":\n  null\n\n  \n/*\n@complete: Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed.\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "Tetanus and diphtheria-containing vaccines" and "Type of dose" = "Booster dose") = 3\n"Immunization recommendation status" = "Complete" (where "Vaccine type" = "Tetanus and diphtheria-containing vaccines")\n*/\ndefine "Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed.":\n  Encounter."Three tetanus and diphtheria booster 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 = 'DTP79.3' then "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)"\n    when Patient.id = 'DTP80.3' then "Tetanus and diphtheria-containing vaccine booster dose 3"\n    when Patient.id = 'DTP81.3' then "Tetanus and diphtheria-containing vaccine booster dose 3"\n    when Patient.id = 'DTP82.2' then "Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed."\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (65040 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SDTPPregnancyStartingWith4DosesLogic", "version": "0.2.0", "name": "IMMZD18SDTPPregnancyStartingWith4DosesLogic", "title": "IMMZD18SDTPPregnancyStartingWith4DosesLogic", "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.DTP.Pregnancy starting with 4 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/IMMZD2DTDTPEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "Second tetanus and diphtheria booster dose was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy)", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Overdue", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Expiration", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 2 (during pregnancy) Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Third tetanus and diphtheria-containing booster dose was administered. Tetanus and diphtheria immunization schedule has been completed.", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 3 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 3 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 3 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Tetanus and diphtheria-containing vaccine booster dose 3 Expiration", "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-IMMZD18SDTPPregnancyStartingWith4DosesLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SDTPPregnancyStartingWith4DosesLogic.elm.xml" } ] }