Clinical Practice Guidelines Example Implmentation Guide - Hepatitis B Vaccination
1.0.0 - ci-build International flag

Clinical Practice Guidelines Example Implmentation Guide - Hepatitis B Vaccination, published by HL7 International - Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/cqframework/cpg-example-hepb/ and changes regularly. See the Directory of published versions

: Immunization Forecasting of Hepatitis B Vaccine for Adults >= 18 Years of Age - JSON Representation

Draft as of 2024-03-01

Raw json | Download


{
  "resourceType" : "PlanDefinition",
  "id" : "HepBAdultForecastingPD",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: PlanDefinition</b><a name=\"HepBAdultForecastingPD\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource PlanDefinition &quot;HepBAdultForecastingPD&quot; </p></div><p><b>url</b>: <code>http://hl7.org/fhir/uv/cpg/hepb/PlanDefinition/HepBAdultForecastingPD</code></p><p><b>identifier</b>: HepBAdultForecastingPD\u00a0(use:\u00a0OFFICIAL)</p><p><b>version</b>: 1.0.0</p><p><b>name</b>: HepBAdultForecastingPD</p><p><b>title</b>: Immunization Forecasting of Hepatitis B Vaccine for Adults &gt;= 18 Years of Age</p><p><b>type</b>: ECA Rule <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.3.0/CodeSystem-plan-definition-type.html\">PlanDefinitionType</a>#eca-rule)</span></p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2024-03-01 20:05:33+0000</p><p><b>publisher</b>: HL7 International - Clinical Decision Support WG</p><p><b>contact</b>: HL7 International - Clinical Decision Support WG: <a href=\"http://www.hl7.org/Special/committees/dss/index.cfm\">http://www.hl7.org/Special/committees/dss/index.cfm</a></p><p><b>description</b>: If an adult patient has not been immunized for Hep B and is indicated for a Hep B vaccine, providers should administer according to this forecast.</p><h3>UseContexts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'Clinical Focus')</td><td>Immunization/vaccination management (procedure) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#384810002)</span></td></tr></table><p><b>jurisdiction</b>: World <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (m49.htm#001)</span></p><p><b>purpose</b>: Example artifact implementation of CDC ACIP Hep B vaccination guidelines for adults, 18 years and older, who have not yet been immunized.</p><p><b>topic</b>: Immunization Forecasting <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>author</b>: Daryl Chertcoff: , Bryn Rhodes: </p><blockquote><p><b>relatedArtifact</b></p><p><b>type</b>: documentation</p><p><b>display</b>: Immunization Calculation Engine - Hep B Vaccine Group - Hep B 2-dose Adult Series</p><p><b>url</b>: <a href=\"https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries\">https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries</a></p><blockquote><p><b>document</b></p></blockquote></blockquote><blockquote><p><b>relatedArtifact</b></p><p><b>type</b>: documentation</p><p><b>display</b>: CDC MMWR Vol.67 / No.1 : Prevention of Hepatitis B Virus Infection in the United States: Recommendations of the Advisory Committee on Immunization Practices</p><p><b>url</b>: <a href=\"http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF\">http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF</a></p><blockquote><p><b>document</b></p></blockquote></blockquote><blockquote><p><b>relatedArtifact</b></p><p><b>type</b>: documentation</p><p><b>display</b>: April 2018 Recommendations for the use of adjuvanted hepatitis B vaccine (Heplisav-B, Dynavax)</p><p><b>url</b>: <a href=\"https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf\">https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf</a></p><blockquote><p><b>document</b></p></blockquote></blockquote><p><b>library</b>: <a href=\"Library-HepBAdultForecasting.html\">Logic for Immunization Forecasting of Hepatitis B Vaccine for Adults &gt;= 18 Years of Age</a></p><blockquote><p><b>action</b></p><p><b>title</b>: Hep B Immunization Forecast</p><p><b>description</b>: Vaccinate Adult with specified Hep B forecast, if noted</p><blockquote><p><b>documentation</b></p><p><b>type</b>: documentation</p><p><b>display</b>: Immunization Calculation Engine - Hep B 2-dose Adult Series</p><p><b>url</b>: <a href=\"https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries\">https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries</a></p><blockquote><p><b>document</b></p></blockquote></blockquote><h3>Triggers</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Name</b></td></tr><tr><td style=\"display: none\">*</td><td>named-event</td><td>patient-view</td></tr></table><blockquote><p><b>condition</b></p><p><b>kind</b>: applicability</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Description</b></td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>Is a Hep B Adult Recommendation Available?</td><td>text/cql</td><td>Patient Hep B Immunization History should be Evaluated in Adult Series</td></tr></table></blockquote><p><b>groupingBehavior</b>: visual-group</p><p><b>selectionBehavior</b>: exactly-one</p><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.title</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>text/cql</td><td>Get Recommendation Overview</td></tr></table></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: action.description</p><h3>Expressions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Language</b></td><td><b>Expression</b></td></tr><tr><td style=\"display: none\">*</td><td>text/cql</td><td>Get Recommendation Detail</td></tr></table></blockquote><h3>Actions</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Description</b></td></tr><tr><td style=\"display: none\">*</td><td>Will Follow Recommendations Provided by This Forecast</td></tr><tr><td style=\"display: none\">*</td><td>Will not immunize due to contraindication(s) or other medical risk factors</td></tr><tr><td style=\"display: none\">*</td><td>Will not immunize due to patient preferences</td></tr><tr><td style=\"display: none\">*</td><td>N/A - see comment (will be reviewed by medical director)</td></tr></table></blockquote></div>"
  },
  "url" : "http://hl7.org/fhir/uv/cpg/hepb/PlanDefinition/HepBAdultForecastingPD",
  "identifier" : [
    {
      "use" : "official",
      "value" : "HepBAdultForecastingPD"
    }
  ],
  "version" : "1.0.0",
  "name" : "HepBAdultForecastingPD",
  "title" : "Immunization Forecasting of Hepatitis B Vaccine for Adults >= 18 Years of Age",
  "type" : {
    "coding" : [
      {
        "system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
        "code" : "eca-rule",
        "display" : "ECA Rule"
      }
    ]
  },
  "status" : "draft",
  "experimental" : true,
  "date" : "2024-03-01T20:05:33+00:00",
  "publisher" : "HL7 International - Clinical Decision Support WG",
  "contact" : [
    {
      "name" : "HL7 International - Clinical Decision Support WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
        }
      ]
    }
  ],
  "description" : "If an adult patient has not been immunized for Hep B and is indicated for a Hep B vaccine, providers should administer according to this forecast.",
  "useContext" : [
    {
      "code" : {
        "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code" : "focus",
        "display" : "Clinical Focus"
      },
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://snomed.info/sct",
            "code" : "384810002",
            "display" : "Immunization/vaccination management (procedure)"
          }
        ]
      }
    }
  ],
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "purpose" : "Example artifact implementation of CDC ACIP Hep B vaccination guidelines for adults, 18 years and older, who have not yet been immunized.",
  "topic" : [
    {
      "text" : "Immunization Forecasting"
    }
  ],
  "author" : [
    {
      "name" : "Daryl Chertcoff"
    },
    {
      "name" : "Bryn Rhodes"
    }
  ],
  "relatedArtifact" : [
    {
      "type" : "documentation",
      "display" : "Immunization Calculation Engine - Hep B Vaccine Group - Hep B 2-dose Adult Series",
      "url" : "https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries",
      "document" : {
        "url" : "https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"
      }
    },
    {
      "type" : "documentation",
      "display" : "CDC MMWR Vol.67 / No.1 : Prevention of Hepatitis B Virus Infection in the United States: Recommendations of the Advisory Committee on Immunization Practices",
      "url" : "http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF",
      "document" : {
        "url" : "http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF"
      }
    },
    {
      "type" : "documentation",
      "display" : "April 2018 Recommendations for the use of adjuvanted hepatitis B vaccine (Heplisav-B, Dynavax)",
      "url" : "https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf",
      "document" : {
        "url" : "https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf"
      }
    }
  ],
  "library" : [
    🔗 "http://hl7.org/fhir/uv/cpg/hepb/Library/HepBAdultForecasting"
  ],
  "action" : [
    {
      "title" : "Hep B Immunization Forecast",
      "description" : "Vaccinate Adult with specified Hep B forecast, if noted",
      "documentation" : [
        {
          "type" : "documentation",
          "display" : "Immunization Calculation Engine - Hep B 2-dose Adult Series",
          "url" : "https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries",
          "document" : {
            "url" : "https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"
          }
        }
      ],
      "trigger" : [
        {
          "type" : "named-event",
          "name" : "patient-view"
        }
      ],
      "condition" : [
        {
          "kind" : "applicability",
          "expression" : {
            "description" : "Is a Hep B Adult Recommendation Available?",
            "language" : "text/cql",
            "expression" : "Patient Hep B Immunization History should be Evaluated in Adult Series"
          }
        }
      ],
      "groupingBehavior" : "visual-group",
      "selectionBehavior" : "exactly-one",
      "dynamicValue" : [
        {
          "path" : "action.title",
          "expression" : {
            "language" : "text/cql",
            "expression" : "Get Recommendation Overview"
          }
        },
        {
          "path" : "action.description",
          "expression" : {
            "language" : "text/cql",
            "expression" : "Get Recommendation Detail"
          }
        }
      ],
      "action" : [
        {
          "description" : "Will Follow Recommendations Provided by This Forecast"
        },
        {
          "description" : "Will not immunize due to contraindication(s) or other medical risk factors"
        },
        {
          "description" : "Will not immunize due to patient preferences"
        },
        {
          "description" : "N/A - see comment (will be reviewed by medical director)"
        }
      ]
    }
  ]
}