{ "resourceType": "Library", "id": "IMMZD2DTPolioSequentialIPVbOPVLogic", "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: IMMZD2DTPolioSequentialIPVbOPVLogic
Id: IMMZD2DTPolioSequentialIPVbOPVLogic
Version: 0.2.0
Url: IMMZD2DTPolioSequentialIPVbOPVLogic
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.Polio.Sequential IPV–bOPV 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is not due for IPV vaccination Case 1boolean01Out
Client is not due for IPV vaccination Case 2boolean01Out
Client is not due for IPV vaccinationboolean01Out
Client is not due for IPV vaccination Guidancestring01Out
Client is due for IPV vaccination Case 1boolean01Out
Client is due for IPV vaccination Case 2boolean01Out
Client is due for IPV vaccinationboolean01Out
Client is due for IPV vaccination Guidancestring01Out
Client is due for bOPV vaccination Case 1boolean01Out
Client is due for bOPV vaccination Case 2boolean01Out
Client is due for bOPV vaccinationboolean01Out
Client is due for bOPV vaccination Guidancestring01Out
Client is not due for bOPV vaccinationboolean01Out
Client is not due for bOPV vaccination Guidancestring01Out
Primary series is completeboolean01Out
Primary series is complete Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD2DTPolioSequentialIPVbOPVLogic (IMMZ.D2.DT.Polio.Sequential IPV–bOPV)\n * Rule: Determine if the client is due for a poliovirus vaccination according to the national immunization schedule\n * Decision Table: Sequential "Bivalent oral polio vaccine (bOPV)–inactivated polio vaccine (IPV)" schedule (in countries with high vaccination coverage [e.g. 90–95%] and low importation risk [where neighbouring countries and/or countries that share substantial population movement have a similarly high coverage])\n * Trigger: IMMZ.D2 Determine required vaccination(s) if any\n */\nlibrary IMMZD2DTPolioSequentialIPVbOPVLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude IMMZD2DTPolioEncounterElements 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 IPV vaccination" then "Client is not due for IPV vaccination Guidance"\n    when "Client is due for IPV vaccination" then "Client is due for IPV vaccination Guidance"\n    when "Client is due for bOPV vaccination" then "Client is due for bOPV vaccination Guidance"\n    when "Client is not due for bOPV vaccination" then "Client is not due for bOPV vaccination Guidance"\n    when "Primary series is complete" then "Primary series is complete 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 IPV vaccination Case 1\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for IPV vaccination Case 1":\n  Encounter."No poliovirus primary series doses were administered"\n    and Encounter."Client's age is less than 8 weeks"\n\n/*\n@output: Client is not due for IPV vaccination Case 2\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for IPV vaccination Case 2":\n  Encounter."One poliovirus primary series dose was administered"\n    and Encounter."The latest poliovirus dose was administered less than 4 weeks ago"\n\n/*\n@output: Client is not due for IPV vaccination\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for IPV vaccination":\n  "Client is not due for IPV vaccination Case 1"\n    or "Client is not due for IPV vaccination Case 2"\n\n/*\n@output: Client is not due for IPV vaccination Guidance\n@guidance = Should not vaccinate client with first IPV dose as client's age is less than 8 weeks. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first poliovirus dose.\n@guidance = Should not vaccinate client with second IPV dose as the latest IPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose.\n*/\ndefine "Client is not due for IPV vaccination Guidance":\n  case\n    when "Client is not due for IPV vaccination Case 1" then 'Should not vaccinate client with first IPV dose as client\\'s age is less than 8 weeks. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first poliovirus dose.'\n    when "Client is not due for IPV vaccination Case 2" then 'Should not vaccinate client with second IPV dose as the latest IPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose.'\n    else ''\n  end\n\n/*\n@output: Client is due for IPV vaccination Case 1\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "IPV")\n*/\ndefine "Client is due for IPV vaccination Case 1":\n  Encounter."No poliovirus primary series doses were administered"\n    and Encounter."Client's age is more than or equal to 8 weeks"\n\n/*\n@output: Client is due for IPV vaccination Case 2\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "IPV")\n*/\ndefine "Client is due for IPV vaccination Case 2":\n  Encounter."One poliovirus primary series dose was administered"\n    and Encounter."The latest poliovirus dose was administered more than 4 weeks ago"\n\n/*\n@output: Client is due for IPV vaccination\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "IPV")\n*/\ndefine "Client is due for IPV vaccination":\n  "Client is due for IPV vaccination Case 1"\n    or "Client is due for IPV vaccination Case 2"\n\n/*\n@output: Client is due for IPV vaccination Guidance\n@guidance = Should vaccinate client with first IPV dose as client is within appropriate age range and IPV dose was not administered. \nCheck for contraindications.\n@guidance = Should vaccinate client with second IPV dose as the latest IPV dose was administered more than 4 weeks ago.\nCheck for contraindications.\n*/\ndefine "Client is due for IPV vaccination Guidance":\n  case\n    when "Client is due for IPV vaccination Case 1" then 'Should vaccinate client with first IPV dose as client is within appropriate age range and IPV dose was not administered. \nCheck for contraindications.'\n    when "Client is due for IPV vaccination Case 2" then 'Should vaccinate client with second IPV dose as the latest IPV dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n    else ''\n  end\n\n/*\n@output: Client is due for bOPV vaccination Case 1\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "bOPV")\n*/\ndefine "Client is due for bOPV vaccination Case 1":\n  Encounter."Two poliovirus primary series doses were administered"\n\n/*\n@output: Client is due for bOPV vaccination Case 2\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "bOPV")\n*/\ndefine "Client is due for bOPV vaccination Case 2":\n  Encounter."Three poliovirus primary series doses were administered"\n    and Encounter."The latest poliovirus dose was administered more than 4 weeks ago"\n\n/*\n@output: Client is due for bOPV vaccination\n@pseudocode: "Immunization recommendation status" = "Due" (where "Type of poliovirus dose" = "bOPV")\n*/\ndefine "Client is due for bOPV vaccination":\n  "Client is due for bOPV vaccination Case 1"\n    or "Client is due for bOPV vaccination Case 2"\n\n/*\n@output: Client is due for bOPV vaccination Guidance\n@guidance = Should vaccinate client with first bOPV dose as two IPV doses were administered.\nCheck for contraindications.\n@guidance = Should vaccinate client with second bOPV dose as the latest bOPV dose was administered more than 4 weeks ago.\nCheck for contraindications.\n*/\ndefine "Client is due for bOPV vaccination Guidance":\n  case\n    when "Client is due for bOPV vaccination Case 1" then 'Should vaccinate client with first bOPV dose as two IPV doses were administered.\nCheck for contraindications.'\n    when "Client is due for bOPV vaccination Case 2" then 'Should vaccinate client with second bOPV dose as the latest bOPV dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n    else ''\n  end\n\n/*\n@output: Client is not due for bOPV vaccination\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for bOPV vaccination":\n  Encounter."Three poliovirus primary series doses were administered"\n    and Encounter."The latest poliovirus dose was administered less than 4 weeks ago"\n\n/*\n@output: Client is not due for bOPV vaccination Guidance\n@guidance: Should not vaccinate client with second bOPV dose as the latest bOPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose\n*/\ndefine "Client is not due for bOPV vaccination Guidance":\n  'Should not vaccinate client with second bOPV dose as the latest bOPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose'\n\n/*\n@output: Primary series is complete\n@pseudocode: "Immunization recommendation status" = "Further evaluation needed"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Poliovirus-containing vaccines")\n*/\ndefine "Primary series is complete":\n  Encounter."Four poliovirus primary series doses were administered"\n\n/*\n@output: Primary series is complete Guidance\n@guidance: Poliovirus primary series is complete. Assess if supplementary bOPV dose(s) are necessary and create a clinical note.\nCheck for any other vaccines due.\n*/\ndefine "Primary series is complete Guidance":\n  'Poliovirus primary series is complete. Assess if supplementary bOPV dose(s) are necessary and create a clinical note.\nCheck for any other vaccines due.'\n\n\n/*\n@test: Test expected results based on example patients\n*/\ndefine "Test Validation":\n  case\n    when Patient.id = 'Polio56.2' then "Client is not due for IPV vaccination Case 1" and "Guidance" = 'Should not vaccinate client with first IPV dose as client\\'s age is less than 8 weeks. \nCheck for any other vaccines due and inform the caregiver of when to come back for the first poliovirus dose.'\n    when Patient.id = 'Polio57.2' then "Client is due for IPV vaccination Case 1" and "Guidance" = 'Should vaccinate client with first IPV dose as client is within appropriate age range and IPV dose was not administered. \nCheck for contraindications.'\n    when Patient.id = 'Polio58.2' then "Client is not due for IPV vaccination Case 2" and "Guidance" = 'Should not vaccinate client with second IPV dose as the latest IPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose.'\n    when Patient.id = 'Polio59.2' then "Client is due for IPV vaccination Case 2" and "Guidance" = 'Should vaccinate client with second IPV dose as the latest IPV dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n    when Patient.id = 'Polio60.1' then "Client is due for bOPV vaccination Case 1" and "Guidance" = 'Should vaccinate client with first bOPV dose as two IPV doses were administered.\nCheck for contraindications.'\n    when Patient.id = 'Polio61.2' then "Client is not due for bOPV vaccination" and "Guidance" = 'Should not vaccinate client with second bOPV dose as the latest bOPV dose was administered less than 4 weeks ago. \nCheck for any other vaccines due and inform the caregiver of when to come back for the next dose'\n    when Patient.id = 'Polio62.2' then "Client is due for bOPV vaccination Case 2" and "Guidance" = 'Should vaccinate client with second bOPV dose as the latest bOPV dose was administered more than 4 weeks ago.\nCheck for contraindications.'\n    when Patient.id = 'Polio63.1' then "Primary series is complete" and "Guidance" = 'Poliovirus primary series is complete. Assess if supplementary bOPV dose(s) are necessary and create a clinical note.\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 (100872 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD2DTPolioSequentialIPVbOPVLogic", "version": "0.2.0", "name": "IMMZD2DTPolioSequentialIPVbOPVLogic", "title": "IMMZD2DTPolioSequentialIPVbOPVLogic", "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.Polio.Sequential IPV–bOPV decision table in the Immunization CPG", "relatedArtifact": [ { "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": "Client is not due for IPV vaccination Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for IPV vaccination Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for IPV vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for IPV vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Client is due for IPV vaccination Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for IPV vaccination Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for IPV vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for IPV vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Client is due for bOPV vaccination Case 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for bOPV vaccination Case 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for bOPV vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is due for bOPV vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Client is not due for bOPV vaccination", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Client is not due for bOPV vaccination Guidance", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "Primary series is complete", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "Primary series is complete 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-IMMZD2DTPolioSequentialIPVbOPVLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD2DTPolioSequentialIPVbOPVLogic.elm.xml" } ] }