{ "resourceType": "Library", "id": "IMMZD18SPolioBOPVPlusIPVLogic", "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: IMMZD18SPolioBOPVPlusIPVLogic
Id: IMMZD18SPolioBOPVPlusIPVLogic
Version: 0.2.0
Url: IMMZD18SPolioBOPVPlusIPVLogic
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.Polio.bOPV plus IPV 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 \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
First bOPV dose from the primary series was administeredboolean01Out
bOPV dose 1boolean01Out
bOPV dose 1 Due Datedate01Out
bOPV dose 1 Createstring01Out
bOPV dose 1 OverdueResource01Out
bOPV dose 1 ExpirationResource01Out
First IPV dose from the primary series was administeredboolean01Out
IPV dose 1boolean01Out
IPV dose 1 Due Datedate01Out
IPV dose 1 Createstring01Out
IPV dose 1 OverdueResource01Out
IPV dose 1 ExpirationResource01Out
Second bOPV dose from the primary series was administeredboolean01Out
bOPV dose 2boolean01Out
bOPV dose 2 Due Datedate01Out
bOPV dose 2 Createstring01Out
bOPV dose 2 OverdueResource01Out
bOPV dose 2 ExpirationResource01Out
Second IPV dose from the primary series was administeredboolean01Out
IPV dose 2boolean01Out
IPV dose 2 Due Datedate01Out
IPV dose 2 Createstring01Out
IPV dose 2 OverdueResource01Out
IPV dose 2 ExpirationResource01Out
Third bOPV dose from the primary series was administered. The primary series has been completedboolean01Out
bOPV dose 3boolean01Out
bOPV dose 3 Due Datedate01Out
bOPV dose 3 Createstring01Out
bOPV dose 3 OverdueResource01Out
bOPV dose 3 ExpirationResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SPolioBOPVPlusIPVLogic (IMMZ.D18.S.Polio.bOPV plus IPV schedule)\n * Schedule Table: Bivalent oral polio vaccine (bOPV) plus inactivated polio vaccine (IPV) schedule\n */\nlibrary IMMZD18SPolioBOPVPlusIPVLogic\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 IMMZD2DTPolioEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: bOPV dose 1\n@description: Provision of bOPV dose 1\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "bOPV dose 1":\n  not "First bOPV dose from the primary series was administered"\n\n\n/*\n@output: bOPV dose 1 Create\n@create: The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.\n*/\ndefine "bOPV dose 1 Create":\n  if "bOPV dose 1"\n  then 'The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.' + '\nDue Date: ' + ToString("bOPV dose 1 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: bOPV dose 1 Due Date\n@pseudocode: "Date of birth" + 6 weeks\n*/\ndefine "bOPV dose 1 Due Date":\n  if "bOPV dose 1" then Patient.birthDate + 6 weeks\n  else null\n\n\n/*\n@dynamicValue: bOPV dose 1 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 "bOPV dose 1 Overdue":\n  null\n\n\n/*\n@dynamicValue: bOPV dose 1 Expiration\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 "bOPV dose 1 Expiration":\n  null\n\n  \n/*\n@complete: First bOPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Type of dose" = "Primary series" and "Type of poliovirus dose" = "bOPV") = 1\n*/\ndefine "First bOPV dose from the primary series was administered":\n  Encounter."Number of Polio bOPV Primary Series Doses Administered" >= 1\n\n\n\n/*\n@output: IPV dose 1\n@description: Provision of IPV dose 1\n@trigger: Child's birth\n@pseudo: \n@triggerDate: "Date of birth"\n*/\ndefine "IPV dose 1":\n  not "First IPV dose from the primary series was administered"\n\n\n/*\n@output: IPV dose 1 Create\n@create: The first IPV dose should be administered from a minimum of 14 weeks of age.\n*/\ndefine "IPV dose 1 Create":\n  if "IPV dose 1"\n  then 'The first IPV dose should be administered from a minimum of 14 weeks of age.' + '\nDue Date: ' + ToString("IPV dose 1 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: IPV dose 1 Due Date\n@pseudocode: "Date of birth" + 14 weeks\n*/\ndefine "IPV dose 1 Due Date":\n  if "IPV dose 1" then Patient.birthDate + 14 weeks\n  else null\n\n\n/*\n@dynamicValue: IPV dose 1 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 "IPV dose 1 Overdue":\n  null\n\n\n/*\n@dynamicValue: IPV dose 1 Expiration\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 "IPV dose 1 Expiration":\n  null\n\n  \n/*\n@complete: First IPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Type of poliovirus dose" = "IPV") = 1\n*/\ndefine "First IPV dose from the primary series was administered":\n  Encounter."Number of Polio IPV Primary Series Doses Administered" >= 1\n\n\n\n/*\n@output: bOPV dose 2\n@description: Provision of bOPV dose 2\n@trigger: First bOPV dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Type of dose" = "Primary series" and "Type of poliovirus dose" = "bOPV") = 1\n@triggerDate: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "bOPV")\n*/\ndefine "bOPV dose 2":\n  "First bOPV dose from the primary series was administered" and not "Second bOPV dose from the primary series was administered"\n\n\n/*\n@output: bOPV dose 2 Create\n@create: The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.\n*/\ndefine "bOPV dose 2 Create":\n  if "bOPV dose 2"\n  then 'The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.' + '\nDue Date: ' + ToString("bOPV dose 2 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: bOPV dose 2 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "bOPV") + 4 weeks\n*/\ndefine "bOPV dose 2 Due Date":\n  if "bOPV dose 2" then Encounter."Date of Latest bOPV Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: bOPV dose 2 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 "bOPV dose 2 Overdue":\n  null\n\n\n/*\n@dynamicValue: bOPV dose 2 Expiration\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 "bOPV dose 2 Expiration":\n  null\n\n  \n/*\n@complete: Second bOPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Type of dose" = "Primary series" and "Type of poliovirus dose" = "bOPV") = 2\n*/\ndefine "Second bOPV dose from the primary series was administered":\n  Encounter."Number of Polio bOPV Primary Series Doses Administered" >= 2\n\n\n\n/*\n@output: IPV dose 2\n@description: Provision of IPV dose 2\n@trigger: First IPV dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Type of poliovirus dose" = "IPV") = 1\n@triggerDate: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "IPV")\n*/\ndefine "IPV dose 2":\n  "First IPV dose from the primary series was administered" and not "Second IPV dose from the primary series was administered"\n\n\n/*\n@output: IPV dose 2 Create\n@create: The first IPV dose should be administered from a minimum of 14 weeks of age (with the third dose of the diphtheria–tetanus–pertussis vaccine [DTP3] or pentavalent vaccine [penta3]), with the second IPV dose being given at least 4 months later (possibly coinciding with other vaccines administered at 9 months of age).\n*/\ndefine "IPV dose 2 Create":\n  if "IPV dose 2"\n  then 'The first IPV dose should be administered from a minimum of 14 weeks of age (with the third dose of the diphtheria–tetanus–pertussis vaccine [DTP3] or pentavalent vaccine [penta3]), with the second IPV dose being given at least 4 months later (possibly coinciding with other vaccines administered at 9 months of age).' + '\nDue Date: ' + ToString("IPV dose 2 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: IPV dose 2 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "IPV") + 4 months\n*/\ndefine "IPV dose 2 Due Date":\n  if "IPV dose 2" then Encounter."Date of Latest IPV Dose" + 4 months\n  else null\n\n\n/*\n@dynamicValue: IPV dose 2 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 "IPV dose 2 Overdue":\n  null\n\n\n/*\n@dynamicValue: IPV dose 2 Expiration\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 "IPV dose 2 Expiration":\n  null\n\n  \n/*\n@complete: Second IPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Type of poliovirus dose" = "IPV") = 2\n*/\ndefine "Second IPV dose from the primary series was administered":\n  Encounter."Number of Polio IPV Primary Series Doses Administered" >= 2\n\n\n\n/*\n@output: bOPV dose 3\n@description: Provision of bOPV dose 3\n@trigger: Second bOPV dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Type of dose" = "Primary series" and "Type of poliovirus dose" = "bOPV") = 2\n@triggerDate: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "bOPV")\n*/\ndefine "bOPV dose 3":\n  "Second bOPV dose from the primary series was administered" and not "Third bOPV dose from the primary series was administered. The primary series has been completed"\n\n\n/*\n@output: bOPV dose 3 Create\n@create: The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.\n*/\ndefine "bOPV dose 3 Create":\n  if "bOPV dose 3"\n  then 'The preferred schedule is to administer the 3 doses of bOPV starting from the minimum age of 6 weeks, with at least a 4 week-interval between doses.' + '\nDue Date: ' + ToString("bOPV dose 3 Due Date")\n  else ''\n\n\n/*\n@dynamicValue: bOPV dose 3 Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Type of poliovirus dose" = "bOPV") + 4 weeks\n*/\ndefine "bOPV dose 3 Due Date":\n  if "bOPV dose 3" then Encounter."Date of Latest bOPV Dose" + 4 weeks\n  else null\n\n\n/*\n@dynamicValue: bOPV dose 3 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 "bOPV dose 3 Overdue":\n  null\n\n\n/*\n@dynamicValue: bOPV dose 3 Expiration\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 "bOPV dose 3 Expiration":\n  null\n\n  \n/*\n@complete: Third bOPV dose from the primary series was administered. The primary series has been completed\n@pseudocode: "Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Poliovirus-containing vaccines")\n*/\ndefine "Third bOPV dose from the primary series was administered. The primary series has been completed":\n  Encounter."Number of Polio bOPV Primary Series Doses Administered" >= 3\n\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Polio18.1' then "bOPV dose 1" and "IPV dose 1"\n    when Patient.id = 'Polio19.2' then "bOPV dose 1" and "IPV dose 1"\n    when Patient.id = 'Polio20.2' then "bOPV dose 1" and "IPV dose 1"\n    when Patient.id = 'Polio21.3' then "IPV dose 1" and "bOPV dose 2"\n    when Patient.id = 'Polio22.3' then "IPV dose 1" and "bOPV dose 2"\n    when Patient.id = 'Polio23.4' then "IPV dose 1" and "bOPV dose 2"\n    when Patient.id = 'Polio24.4' then "IPV dose 1" and "bOPV dose 2"\n    when Patient.id = 'Polio25.4' then "IPV dose 2" and "bOPV dose 1"\n    when Patient.id = 'Polio26.4' then "IPV dose 2" and "bOPV dose 1"\n    when Patient.id = 'Polio27.4' then "IPV dose 1" and "bOPV dose 3"\n    when Patient.id = 'Polio28.4' then "IPV dose 1" and "bOPV dose 3"\n    when Patient.id = 'Polio29.4' then "IPV dose 1" and "bOPV dose 3"\n    when Patient.id = 'Polio30.4' then "IPV dose 1" and "bOPV dose 3"\n    when Patient.id = 'Polio31.4' then "IPV dose 2" and "bOPV dose 2"\n    when Patient.id = 'Polio32.4' then "IPV dose 2" and "bOPV dose 2"\n    when Patient.id = 'Polio33.4' then "IPV dose 2" and "bOPV dose 2"\n    when Patient.id = 'Polio34.4' then "IPV dose 2" and "bOPV dose 2"\n    when Patient.id = 'Polio35.2' then "bOPV dose 1"\n    when Patient.id = 'Polio36.3' then "IPV dose 1"\n    when Patient.id = 'Polio37.3' then "IPV dose 1"\n    when Patient.id = 'Polio38.4' then "IPV dose 2" and "bOPV dose 3"\n    when Patient.id = 'Polio39.4' then "IPV dose 2" and "bOPV dose 3"\n    when Patient.id = 'Polio40.4' then "IPV dose 2" and "bOPV dose 3"\n    when Patient.id = 'Polio41.4' then "IPV dose 2" and "bOPV dose 3"\n    when Patient.id = 'Polio42.3' then "bOPV dose 2"\n    when Patient.id = 'Polio43.3' then "bOPV dose 2"\n    when Patient.id = 'Polio44.3' then "IPV dose 2"\n    when Patient.id = 'Polio45.3' then "IPV dose 2"\n    when Patient.id = 'Polio46.3' then "bOPV dose 3"\n    when Patient.id = 'Polio47.3' then "bOPV dose 3"\n    when Patient.id = 'Polio48.1' then "Third bOPV dose from the primary series was administered. The primary series has been completed"\n      and "Second IPV dose from the primary series was administered"\n    else 'No test case set'\n  end\n
\n
\n \n \n \n
Content: application/elm+xml
Encoded data (193400 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SPolioBOPVPlusIPVLogic", "version": "0.2.0", "name": "IMMZD18SPolioBOPVPlusIPVLogic", "title": "IMMZD18SPolioBOPVPlusIPVLogic", "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.Polio.bOPV plus IPV 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/IMMZD2DTPolioEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "First bOPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "bOPV dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "bOPV dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "bOPV dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "First IPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "IPV dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "IPV dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "IPV dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "IPV dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "IPV dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Second bOPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "bOPV dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "bOPV dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "bOPV dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Second IPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "IPV dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "IPV dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "IPV dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "IPV dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "IPV dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Third bOPV dose from the primary series was administered. The primary series has been completed", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 3", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "bOPV dose 3 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "bOPV dose 3 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "bOPV dose 3 Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "bOPV 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-IMMZD18SPolioBOPVPlusIPVLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SPolioBOPVPlusIPVLogic.elm.xml" } ] }