{ "resourceType": "Library", "id": "IMMZD18SHPV2DosesLogic", "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: IMMZD18SHPV2DosesLogic
Id: IMMZD18SHPV2DosesLogic
Version: 0.2.0
Url: IMMZD18SHPV2DosesLogic
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.HPV.2-dose 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
First HPV dose from the primary series was administeredboolean01Out
HPV dose 1boolean01Out
HPV dose 1 Due Datedate01Out
HPV dose 1 Overduedate01Out
HPV dose 1 Createstring01Out
HPV dose 1 ExpirationResource01Out
Second HPV dose from the primary series was administeredboolean01Out
HPV dose 2boolean01Out
HPV dose 2 Due Datedate01Out
HPV dose 2 Overduedate01Out
HPV dose 2 Createstring01Out
HPV dose 2 ExpirationResource01Out
Third HPV dose from the primary series was administeredboolean01Out
HPV dose 3 (immunocompromised or HIV-positive)boolean01Out
HPV dose 3 (immunocompromised or HIV-positive) Due Datedate01Out
HPV dose 3 (immunocompromised or HIV-positive) Createstring01Out
HPV dose 3 (immunocompromised or HIV-positive) OverdueResource01Out
HPV dose 3 (immunocompromised or HIV-positive) ExpirationResource01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD18SHPV2DosesLogic (IMMZ.D18.S.HPV.2-dose schedule)\n * Schedule Table: 2-dose schedule\n */\nlibrary IMMZD18SHPV2DosesLogic\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 IMMZD2DTHPVEncounterElements called Encounter\n\nparameter Today Date default Today()\n\n\ncontext Patient\n\n\n/*\n@output: HPV dose 1\n@description: Provision of the HPV dose 1\n@trigger: Child's birth when client's biological sex is female\n@pseudo: Child's birth AND "Sex" = "Female"\n@triggerDate: "Date of birth"\n*/\ndefine "HPV dose 1":\n  Encounter."No HPV primary series doses were administered"\n  and not "First HPV dose from the primary series was administered"\n\n\n/*\n@output: HPV dose 1 Create\n@create: HPV dose 1 should be provided if the client is female and older than 9 years of age.\n*/\ndefine "HPV dose 1 Create":\n  if "HPV dose 1"\n  then 'HPV dose 1 should be provided if the client is female and older than 9 years of age.' + '\nDue Date: ' + ToString("HPV dose 1 Due Date") + '\nOverdue: ' + ToString("HPV dose 1 Overdue")\n  else ''\n\n\n/*\n@dynamicValue: HPV dose 1 Due Date\n@pseudocode: "Date of birth" + 9 years\n*/\ndefine "HPV dose 1 Due Date":\n  if "HPV dose 1" then Patient.birthDate + 9 years\n  else null\n\n\n/*\n@dynamicValue: HPV dose 1 Overdue\n@pseudocode: "Date of birth" + 14 years\n*/\ndefine "HPV dose 1 Overdue":\n  if "HPV dose 1" then Patient.birthDate + 14 years\n  else null\n\n\n/*\n@dynamicValue: HPV dose 1 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date.\n*/\ndefine "HPV dose 1 Expiration":\n  null\n\n  \n/*\n@complete: First HPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 1\n*/\ndefine "First HPV dose from the primary series was administered":\n  Encounter."One HPV primary series dose was administered"\n\n\n\n/*\n@output: HPV dose 2\n@description: Provision of the HPV dose 2\n@trigger: First HPV dose from the primary series was administered\n@pseudo: Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 1\n@triggerDate: "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines")\n*/\ndefine "HPV dose 2":\n  "First HPV dose from the primary series was administered"\n  and not "Second HPV dose from the primary series was administered"\n\n\n/*\n@output: HPV dose 2 Create\n@create: HPV dose 2 should be provided if dose 1 was given 6 months ago.\n*/\ndefine "HPV dose 2 Create":\n  if "HPV dose 2"\n  then 'HPV dose 2 should be provided if dose 1 was given 6 months ago.' + '\nDue Date: ' + ToString("HPV dose 2 Due Date") + '\nOverdue: ' + ToString("HPV dose 2 Overdue")\n  else ''\n\n\n/*\n@dynamicValue: HPV dose 2 Due Date\n@pseudocode: "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines") + 6 months\n*/\ndefine "HPV dose 2 Due Date":\n  if "HPV dose 2" then Encounter."Date of Latest HPV Dose" + 6 months\n  else null\n\n\n/*\n@dynamicValue: HPV dose 2 Overdue\n@pseudocode: "Date of birth" + 14 years\n*/\ndefine "HPV dose 2 Overdue":\n  if "HPV dose 2" then Patient.birthDate + 14 years\n  else null\n\n\n/*\n@dynamicValue: HPV dose 2 Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date.\n*/\ndefine "HPV dose 2 Expiration":\n  null\n\n  \n/*\n@complete: Second HPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 2\n*/\ndefine "Second HPV dose from the primary series was administered":\n  Encounter."Two HPV primary series doses were administered"\n\n\n\n/*\n@output: HPV dose 3 (immunocompromised or HIV-positive)\n@description: Provision of the HPV dose 3 for individuals immunocompromised or infected with HIV\n@trigger: Second HPV dose from the primary series was administered and client's HIV status is positive or client is immunocompromised\n@pseudo: Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 2 AND ("HIV status" = "HIV-positive" OR "Immunocompromised" = TRUE)\n@triggerDate: Latest "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines")\n*/\ndefine "HPV dose 3 (immunocompromised or HIV-positive)":\n  "Second HPV dose from the primary series was administered"\n  and (\n    Encounter."Client's HIV status is positive"\n    or Encounter."Client is immunocompromised"\n  )\n  and not "Third HPV dose from the primary series was administered"\n\n\n/*\n@output: HPV dose 3 (immunocompromised or HIV-positive) Create\n@create: Where possible, three HPV doses should be provided to individuals known to be immunocompromised or infected with HIV.\n*/\ndefine "HPV dose 3 (immunocompromised or HIV-positive) Create":\n  if "HPV dose 3 (immunocompromised or HIV-positive)"\n  then 'Where possible, three HPV doses should be provided to individuals known to be immunocompromised or infected with HIV.' + '\nDue Date: ' + ToString("HPV dose 3 (immunocompromised or HIV-positive) Due Date")\n  else ''\n\n\n/*\n@dynamicValue: HPV dose 3 (immunocompromised or HIV-positive) Due Date\n@pseudocode: Latest "Date and time of vaccination" (where "Vaccine type" = "HPV vaccines") + 6 months\n*/\ndefine "HPV dose 3 (immunocompromised or HIV-positive) Due Date":\n  if "HPV dose 3 (immunocompromised or HIV-positive)" then Encounter."Date of Latest HPV Dose" + 6 months\n  else null\n\n\n/*\n@dynamicValue: HPV dose 3 (immunocompromised or HIV-positive) Overdue\n@pseudocode: To be determined by Member States; however, there is no recommended overdue date.\n*/\ndefine "HPV dose 3 (immunocompromised or HIV-positive) Overdue":\n  null\n\n\n/*\n@dynamicValue: HPV dose 3 (immunocompromised or HIV-positive) Expiration\n@pseudocode: To be determined by Member States; however, there is no recommended expiration date.\n*/\ndefine "HPV dose 3 (immunocompromised or HIV-positive) Expiration":\n  null\n\n  \n/*\n@complete: Third HPV dose from the primary series was administered\n@pseudocode: Count of vaccines administered (where "Vaccine type" = "HPV vaccines" and "Type of dose" = "Primary series") = 3\n*/\ndefine "Third HPV dose from the primary series was administered":\n  Encounter."Three HPV 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 = 'HPV08.1' then "HPV dose 1"\n    when Patient.id = 'HPV09.3' then "HPV dose 1"\n    when Patient.id = 'HPV10.3' then "HPV dose 1"\n    when Patient.id = 'HPV11.2' then "HPV dose 1"\n    when Patient.id = 'HPV12.2' then "HPV dose 2"\n    when Patient.id = 'HPV13.2' then "HPV dose 2"\n    when Patient.id = 'HPV14.3' then "HPV dose 3 (immunocompromised or HIV-positive)"\n    when Patient.id = 'HPV15.3' then "HPV dose 3 (immunocompromised or HIV-positive)"\n    when Patient.id = 'HPV16.3' then "HPV dose 3 (immunocompromised or HIV-positive)"\n    when Patient.id = 'HPV17.3' then "HPV dose 3 (immunocompromised or HIV-positive)"\n    when Patient.id = 'HPV18.3' then "Second HPV dose from the primary series was administered" and not "HPV dose 3 (immunocompromised or HIV-positive)"\n    when Patient.id = 'HPV19.1' then "Third HPV 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 (102124 characters)
\n
\n
\n
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode": "computable" } ], "url": "http://smart.who.int/immunizations/Library/IMMZD18SHPV2DosesLogic", "version": "0.2.0", "name": "IMMZD18SHPV2DosesLogic", "title": "IMMZD18SHPV2DosesLogic", "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.HPV.2-dose 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/IMMZD2DTHPVEncounterElements" } ], "parameter": [ { "name": "Today", "use": "in", "min": 0, "max": "1", "type": "date" }, { "name": "Patient", "use": "out", "min": 0, "max": "1", "type": "Patient" }, { "name": "First HPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 1", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 1 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "HPV dose 1 Overdue", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "HPV dose 1 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "HPV dose 1 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Second HPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 2", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 2 Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "HPV dose 2 Overdue", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "HPV dose 2 Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "HPV dose 2 Expiration", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "Third HPV dose from the primary series was administered", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 3 (immunocompromised or HIV-positive)", "use": "out", "min": 0, "max": "1", "type": "boolean" }, { "name": "HPV dose 3 (immunocompromised or HIV-positive) Due Date", "use": "out", "min": 0, "max": "1", "type": "date" }, { "name": "HPV dose 3 (immunocompromised or HIV-positive) Create", "use": "out", "min": 0, "max": "1", "type": "string" }, { "name": "HPV dose 3 (immunocompromised or HIV-positive) Overdue", "use": "out", "min": 0, "max": "1", "type": "Resource" }, { "name": "HPV dose 3 (immunocompromised or HIV-positive) 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-IMMZD18SHPV2DosesLogic.cql" }, { "contentType": "application/elm+xml", "url": "Library-IMMZD18SHPV2DosesLogic.elm.xml" } ] }