{ "resourceType" : "Library", "id" : "IMMZD2DTHepatitisAInactivatedHAV1DoseLogic", "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
Title: IMMZD2DTHepatitisAInactivatedHAV1DoseLogic
Id: IMMZD2DTHepatitisAInactivatedHAV1DoseLogic
Version: 1.0.0
Url: IMMZD2DTHepatitisAInactivatedHAV1DoseLogic
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-31 13:54:17+0000
Publisher: WHO
Description:

This library defines decision support logic for the IMMZ.D2.DT.Hepatitis A.Inactivated HAV 1 dose 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
NameTypeMinMaxIn/Out
Todaydate01In
PatientPatient01Out
Client is not due for Hepatitis A vaccinationboolean01Out
Client is not due for Hepatitis A vaccination Guidancestring01Out
Client is due for Hepatitis A vaccinationboolean01Out
Client is due for Hepatitis A vaccination Guidancestring01Out
Hepatitis A immunization schedule is completeboolean01Out
Hepatitis A immunization schedule is complete Guidancestring01Out
Guidancestring01Out
Has Guidanceboolean01Out
Test ValidationResource01Out
\n
\n \n \n \n
Content: text/cql
/*\n * Library: IMMZD2DTHepatitisAInactivatedHAV1DoseLogic (IMMZ.D2.DT.Hepatitis A.Inactivated HAV 1 dose)\n * Rule: Determine if the client is due for a hepatitis A vaccination according to the national immunization schedule\n * Decision Table: Inactivated hepatitis A virus (HAV), 1-dose schedule\n * Trigger: IMMZ.D2 Determine required vaccination(s) if any\n */\nlibrary IMMZD2DTHepatitisAInactivatedHAV1DoseLogic\n\nusing FHIR version '4.0.1'\ninclude FHIRHelpers version '4.0.1'\n\ninclude IMMZD2DTHepatitisAEncounterElements 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 Hepatitis A vaccination" then "Client is not due for Hepatitis A vaccination Guidance"\n    when "Client is due for Hepatitis A vaccination" then "Client is due for Hepatitis A vaccination Guidance"\n    when "Hepatitis A immunization schedule is complete" then "Hepatitis A immunization schedule 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 Hepatitis A vaccination\n@pseudocode: "Immunization recommendation status" = "Not due"\n*/\ndefine "Client is not due for Hepatitis A vaccination":\n  Encounter."Client's age is less than 12 months"\n\n/*\n@output: Client is not due for Hepatitis A vaccination Guidance\n@guidance: Should not vaccinate client with Hepatitis A dose as client's age is less than 12 months.\nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.\n*/\ndefine "Client is not due for Hepatitis A vaccination Guidance":\n  'Should not vaccinate client with Hepatitis A dose as client\\'s age is less than 12 months.\nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.'\n\n/*\n@output: Client is due for Hepatitis A vaccination\n@pseudocode: "Immunization recommendation status" = "Due"\n*/\ndefine "Client is due for Hepatitis A vaccination":\n  Encounter."No hepatitis A primary series dose was administered"\n    and Encounter."Client's age is more than or equal to 12 months"\n\n/*\n@output: Client is due for Hepatitis A vaccination Guidance\n@guidance: Should vaccinate client with hepatitis A dose as no hepatitis A dose was administered and client's age is within appropriate age range.\nCheck for contraindications.\n*/\ndefine "Client is due for Hepatitis A vaccination Guidance":\n  'Should vaccinate client with hepatitis A dose as no hepatitis A dose was administered and client\\'s age is within appropriate age range.\nCheck for contraindications.'\n\n/*\n@output: Hepatitis A immunization schedule is complete\n@pseudocode: "Immunization recommendation status" = "Complete"\n"Completed the primary vaccination series" = TRUE (where "Vaccine type" = "Hepatitis A-containing vaccines")\n*/\ndefine "Hepatitis A immunization schedule is complete":\n  Encounter."One hepatitis A primary series dose was administered"\n\n/*\n@output: Hepatitis A immunization schedule is complete Guidance\n@guidance: Hepatitis A immunization schedule is complete. One hepatitis A primary series dose was administered.\nCheck for any other vaccines due.\n*/\ndefine "Hepatitis A immunization schedule is complete Guidance":\n  'Hepatitis A immunization schedule is complete. One hepatitis A primary series dose was administered.\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 = 'HepatitisA20.1' then "Client is not due for Hepatitis A vaccination" and "Guidance" = 'Should not vaccinate client with Hepatitis A dose as client\\'s age is less than 12 months.\nCheck for any other vaccines due and inform the caregiver of when to come back for the first dose.'\n    when Patient.id = 'HepatitisA21.2' then "Client is due for Hepatitis A vaccination" and "Guidance" = 'Should vaccinate client with hepatitis A dose as no hepatitis A dose was administered and client\\'s age is within appropriate age range.\nCheck for contraindications.'\n    when Patient.id = 'HepatitisA22.1' then "Hepatitis A immunization schedule is complete" and "Guidance" = 'Hepatitis A immunization schedule is complete. One hepatitis A primary series dose was administered.\nCheck for any other vaccines due.'\n    else 'No test case set'\n  end\n
\n
\n
\n
" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability", "valueCode" : "computable" }], "url" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisAInactivatedHAV1DoseLogic", "version" : "1.0.0", "name" : "IMMZD2DTHepatitisAInactivatedHAV1DoseLogic", "title" : "IMMZD2DTHepatitisAInactivatedHAV1DoseLogic", "status" : "draft", "experimental" : false, "type" : { "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/library-type", "code" : "logic-library" }] }, "date" : "2026-03-31T13:54:17+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.Hepatitis A.Inactivated HAV 1 dose decision table in the Immunization CPG", "relatedArtifact" : [{ "type" : "depends-on", "display" : "Library Encounter", "resource" : "http://smart.who.int/immunizations/Library/IMMZD2DTHepatitisAEncounterElements" }], "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 Hepatitis A vaccination", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Client is not due for Hepatitis A vaccination Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Client is due for Hepatitis A vaccination", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Client is due for Hepatitis A vaccination Guidance", "use" : "out", "min" : 0, "max" : "1", "type" : "string" }, { "name" : "Hepatitis A immunization schedule is complete", "use" : "out", "min" : 0, "max" : "1", "type" : "boolean" }, { "name" : "Hepatitis A immunization schedule 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", "data" : "LyoKICogTGlicmFyeTogSU1NWkQyRFRIZXBhdGl0aXNBSW5hY3RpdmF0ZWRIQVYxRG9zZUxvZ2ljIChJTU1aLkQyLkRULkhlcGF0aXRpcyBBLkluYWN0aXZhdGVkIEhBViAxIGRvc2UpCiAqIFJ1bGU6IERldGVybWluZSBpZiB0aGUgY2xpZW50IGlzIGR1ZSBmb3IgYSBoZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiBhY2NvcmRpbmcgdG8gdGhlIG5hdGlvbmFsIGltbXVuaXphdGlvbiBzY2hlZHVsZQogKiBEZWNpc2lvbiBUYWJsZTogSW5hY3RpdmF0ZWQgaGVwYXRpdGlzIEEgdmlydXMgKEhBViksIDEtZG9zZSBzY2hlZHVsZQogKiBUcmlnZ2VyOiBJTU1aLkQyIERldGVybWluZSByZXF1aXJlZCB2YWNjaW5hdGlvbihzKSBpZiBhbnkKICovCmxpYnJhcnkgSU1NWkQyRFRIZXBhdGl0aXNBSW5hY3RpdmF0ZWRIQVYxRG9zZUxvZ2ljCgp1c2luZyBGSElSIHZlcnNpb24gJzQuMC4xJwppbmNsdWRlIEZISVJIZWxwZXJzIHZlcnNpb24gJzQuMC4xJwoKaW5jbHVkZSBJTU1aRDJEVEhlcGF0aXRpc0FFbmNvdW50ZXJFbGVtZW50cyBjYWxsZWQgRW5jb3VudGVyCgpwYXJhbWV0ZXIgVG9kYXkgRGF0ZSBkZWZhdWx0IFRvZGF5KCkKCmNvbnRleHQgUGF0aWVudAoKCi8qCkBkeW5hbWljVmFsdWU6IEd1aWRhbmNlCiovCmRlZmluZSAiR3VpZGFuY2UiOgogIGNhc2UgCiAgICB3aGVuICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgSGVwYXRpdGlzIEEgdmFjY2luYXRpb24iIHRoZW4gIkNsaWVudCBpcyBub3QgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiBHdWlkYW5jZSIKICAgIHdoZW4gIkNsaWVudCBpcyBkdWUgZm9yIEhlcGF0aXRpcyBBIHZhY2NpbmF0aW9uIiB0aGVuICJDbGllbnQgaXMgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiBHdWlkYW5jZSIKICAgIHdoZW4gIkhlcGF0aXRpcyBBIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZSIgdGhlbiAiSGVwYXRpdGlzIEEgaW1tdW5pemF0aW9uIHNjaGVkdWxlIGlzIGNvbXBsZXRlIEd1aWRhbmNlIiAKICAgIGVsc2UgJycKICBlbmQKICAKZGVmaW5lICJIYXMgR3VpZGFuY2UiOgogICJHdWlkYW5jZSIgaXMgbm90IG51bGwgYW5kICJHdWlkYW5jZSIgIT0gJycKCi8qCkBvdXRwdXQ6IENsaWVudCBpcyBub3QgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbgpAcHNldWRvY29kZTogIkltbXVuaXphdGlvbiByZWNvbW1lbmRhdGlvbiBzdGF0dXMiID0gIk5vdCBkdWUiCiovCmRlZmluZSAiQ2xpZW50IGlzIG5vdCBkdWUgZm9yIEhlcGF0aXRpcyBBIHZhY2NpbmF0aW9uIjoKICBFbmNvdW50ZXIuIkNsaWVudCdzIGFnZSBpcyBsZXNzIHRoYW4gMTIgbW9udGhzIgoKLyoKQG91dHB1dDogQ2xpZW50IGlzIG5vdCBkdWUgZm9yIEhlcGF0aXRpcyBBIHZhY2NpbmF0aW9uIEd1aWRhbmNlCkBndWlkYW5jZTogU2hvdWxkIG5vdCB2YWNjaW5hdGUgY2xpZW50IHdpdGggSGVwYXRpdGlzIEEgZG9zZSBhcyBjbGllbnQncyBhZ2UgaXMgbGVzcyB0aGFuIDEyIG1vbnRocy4KQ2hlY2sgZm9yIGFueSBvdGhlciB2YWNjaW5lcyBkdWUgYW5kIGluZm9ybSB0aGUgY2FyZWdpdmVyIG9mIHdoZW4gdG8gY29tZSBiYWNrIGZvciB0aGUgZmlyc3QgZG9zZS4KKi8KZGVmaW5lICJDbGllbnQgaXMgbm90IGR1ZSBmb3IgSGVwYXRpdGlzIEEgdmFjY2luYXRpb24gR3VpZGFuY2UiOgogICdTaG91bGQgbm90IHZhY2NpbmF0ZSBjbGllbnQgd2l0aCBIZXBhdGl0aXMgQSBkb3NlIGFzIGNsaWVudFwncyBhZ2UgaXMgbGVzcyB0aGFuIDEyIG1vbnRocy4KQ2hlY2sgZm9yIGFueSBvdGhlciB2YWNjaW5lcyBkdWUgYW5kIGluZm9ybSB0aGUgY2FyZWdpdmVyIG9mIHdoZW4gdG8gY29tZSBiYWNrIGZvciB0aGUgZmlyc3QgZG9zZS4nCgovKgpAb3V0cHV0OiBDbGllbnQgaXMgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbgpAcHNldWRvY29kZTogIkltbXVuaXphdGlvbiByZWNvbW1lbmRhdGlvbiBzdGF0dXMiID0gIkR1ZSIKKi8KZGVmaW5lICJDbGllbnQgaXMgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiI6CiAgRW5jb3VudGVyLiJObyBoZXBhdGl0aXMgQSBwcmltYXJ5IHNlcmllcyBkb3NlIHdhcyBhZG1pbmlzdGVyZWQiCiAgICBhbmQgRW5jb3VudGVyLiJDbGllbnQncyBhZ2UgaXMgbW9yZSB0aGFuIG9yIGVxdWFsIHRvIDEyIG1vbnRocyIKCi8qCkBvdXRwdXQ6IENsaWVudCBpcyBkdWUgZm9yIEhlcGF0aXRpcyBBIHZhY2NpbmF0aW9uIEd1aWRhbmNlCkBndWlkYW5jZTogU2hvdWxkIHZhY2NpbmF0ZSBjbGllbnQgd2l0aCBoZXBhdGl0aXMgQSBkb3NlIGFzIG5vIGhlcGF0aXRpcyBBIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCBhbmQgY2xpZW50J3MgYWdlIGlzIHdpdGhpbiBhcHByb3ByaWF0ZSBhZ2UgcmFuZ2UuCkNoZWNrIGZvciBjb250cmFpbmRpY2F0aW9ucy4KKi8KZGVmaW5lICJDbGllbnQgaXMgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiBHdWlkYW5jZSI6CiAgJ1Nob3VsZCB2YWNjaW5hdGUgY2xpZW50IHdpdGggaGVwYXRpdGlzIEEgZG9zZSBhcyBubyBoZXBhdGl0aXMgQSBkb3NlIHdhcyBhZG1pbmlzdGVyZWQgYW5kIGNsaWVudFwncyBhZ2UgaXMgd2l0aGluIGFwcHJvcHJpYXRlIGFnZSByYW5nZS4KQ2hlY2sgZm9yIGNvbnRyYWluZGljYXRpb25zLicKCi8qCkBvdXRwdXQ6IEhlcGF0aXRpcyBBIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZQpAcHNldWRvY29kZTogIkltbXVuaXphdGlvbiByZWNvbW1lbmRhdGlvbiBzdGF0dXMiID0gIkNvbXBsZXRlIgoiQ29tcGxldGVkIHRoZSBwcmltYXJ5IHZhY2NpbmF0aW9uIHNlcmllcyIgPSBUUlVFICh3aGVyZSAiVmFjY2luZSB0eXBlIiA9ICJIZXBhdGl0aXMgQS1jb250YWluaW5nIHZhY2NpbmVzIikKKi8KZGVmaW5lICJIZXBhdGl0aXMgQSBpbW11bml6YXRpb24gc2NoZWR1bGUgaXMgY29tcGxldGUiOgogIEVuY291bnRlci4iT25lIGhlcGF0aXRpcyBBIHByaW1hcnkgc2VyaWVzIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCIKCi8qCkBvdXRwdXQ6IEhlcGF0aXRpcyBBIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZSBHdWlkYW5jZQpAZ3VpZGFuY2U6IEhlcGF0aXRpcyBBIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZS4gT25lIGhlcGF0aXRpcyBBIHByaW1hcnkgc2VyaWVzIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZC4KQ2hlY2sgZm9yIGFueSBvdGhlciB2YWNjaW5lcyBkdWUuCiovCmRlZmluZSAiSGVwYXRpdGlzIEEgaW1tdW5pemF0aW9uIHNjaGVkdWxlIGlzIGNvbXBsZXRlIEd1aWRhbmNlIjoKICAnSGVwYXRpdGlzIEEgaW1tdW5pemF0aW9uIHNjaGVkdWxlIGlzIGNvbXBsZXRlLiBPbmUgaGVwYXRpdGlzIEEgcHJpbWFyeSBzZXJpZXMgZG9zZSB3YXMgYWRtaW5pc3RlcmVkLgpDaGVjayBmb3IgYW55IG90aGVyIHZhY2NpbmVzIGR1ZS4nCgoKLyoKQHRlc3Q6IFRlc3QgZXhwZWN0ZWQgcmVzdWx0cyBiYXNlZCBvbiBleGFtcGxlIHBhdGllbnRzCiovCmRlZmluZSAiVGVzdCBWYWxpZGF0aW9uIjoKICBjYXNlCiAgICB3aGVuIFBhdGllbnQuaWQgPSAnSGVwYXRpdGlzQTIwLjEnIHRoZW4gIkNsaWVudCBpcyBub3QgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiIgYW5kICJHdWlkYW5jZSIgPSAnU2hvdWxkIG5vdCB2YWNjaW5hdGUgY2xpZW50IHdpdGggSGVwYXRpdGlzIEEgZG9zZSBhcyBjbGllbnRcJ3MgYWdlIGlzIGxlc3MgdGhhbiAxMiBtb250aHMuCkNoZWNrIGZvciBhbnkgb3RoZXIgdmFjY2luZXMgZHVlIGFuZCBpbmZvcm0gdGhlIGNhcmVnaXZlciBvZiB3aGVuIHRvIGNvbWUgYmFjayBmb3IgdGhlIGZpcnN0IGRvc2UuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0EyMS4yJyB0aGVuICJDbGllbnQgaXMgZHVlIGZvciBIZXBhdGl0aXMgQSB2YWNjaW5hdGlvbiIgYW5kICJHdWlkYW5jZSIgPSAnU2hvdWxkIHZhY2NpbmF0ZSBjbGllbnQgd2l0aCBoZXBhdGl0aXMgQSBkb3NlIGFzIG5vIGhlcGF0aXRpcyBBIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZCBhbmQgY2xpZW50XCdzIGFnZSBpcyB3aXRoaW4gYXBwcm9wcmlhdGUgYWdlIHJhbmdlLgpDaGVjayBmb3IgY29udHJhaW5kaWNhdGlvbnMuJwogICAgd2hlbiBQYXRpZW50LmlkID0gJ0hlcGF0aXRpc0EyMi4xJyB0aGVuICJIZXBhdGl0aXMgQSBpbW11bml6YXRpb24gc2NoZWR1bGUgaXMgY29tcGxldGUiIGFuZCAiR3VpZGFuY2UiID0gJ0hlcGF0aXRpcyBBIGltbXVuaXphdGlvbiBzY2hlZHVsZSBpcyBjb21wbGV0ZS4gT25lIGhlcGF0aXRpcyBBIHByaW1hcnkgc2VyaWVzIGRvc2Ugd2FzIGFkbWluaXN0ZXJlZC4KQ2hlY2sgZm9yIGFueSBvdGhlciB2YWNjaW5lcyBkdWUuJwogICAgZWxzZSAnTm8gdGVzdCBjYXNlIHNldCcKICBlbmQK" }] }