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 - XML Representation

Draft as of 2024-08-23

Raw xml | Download



<PlanDefinition xmlns="http://hl7.org/fhir">
  <id value="HepBAdultForecastingPD"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: PlanDefinition HepBAdultForecastingPD</b></p><a name="HepBAdultForecastingPD"> </a><a name="hcHepBAdultForecastingPD"> </a><a name="HepBAdultForecastingPD-en-US"> </a><p><b>url</b>: <a href="PlanDefinition-HepBAdultForecastingPD.html">PlanDefinition Immunization Forecasting of Hepatitis B Vaccine for Adults &gt;= 18 Years of Age</a></p><p><b>identifier</b>: HepBAdultForecastingPD (use: official, )</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>: <span title="Codes:{http://terminology.hl7.org/CodeSystem/plan-definition-type eca-rule}">ECA Rule</span></p><p><b>status</b>: Draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2024-08-23 15:49:23+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>: </p><div><p>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>
</div><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><a href="http://terminology.hl7.org/5.5.0/CodeSystem-usage-context-type.html#usage-context-type-focus">UsageContextType</a> focus: Clinical Focus</td><td><span title="Codes:{http://snomed.info/sct 384810002}">Immunization/vaccination management (procedure)</span></td></tr></table><p><b>jurisdiction</b>: <span title="Codes:{http://unstats.un.org/unsd/methods/m49/m49.htm 001}">World</span></p><p><b>purpose</b>: </p><div><p>Example artifact implementation of CDC ACIP Hep B vaccination guidelines for adults, 18 years and older, who have not yet been immunized.</p>
</div><p><b>topic</b>: <span title="Codes:">Immunization Forecasting</span></p><p><b>author</b>: Daryl Chertcoff: , Bryn Rhodes: </p><blockquote><p><b>relatedArtifact</b></p></blockquote><blockquote><p><b>relatedArtifact</b></p></blockquote><blockquote><p><b>relatedArtifact</b></p></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></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>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>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>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>
  </text>
  <url
       value="http://hl7.org/fhir/uv/cpg/hepb/PlanDefinition/HepBAdultForecastingPD"/>
  <identifier>
    <use value="official"/>
    <value value="HepBAdultForecastingPD"/>
  </identifier>
  <version value="1.0.0"/>
  <name value="HepBAdultForecastingPD"/>
  <title
         value="Immunization Forecasting of Hepatitis B Vaccine for Adults &gt;= 18 Years of Age"/>
  <type>
    <coding>
      <system
              value="http://terminology.hl7.org/CodeSystem/plan-definition-type"/>
      <code value="eca-rule"/>
      <display value="ECA Rule"/>
    </coding>
  </type>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2024-08-23T15:49:23+00:00"/>
  <publisher value="HL7 International - Clinical Decision Support WG"/>
  <contact>
    <name value="HL7 International - Clinical Decision Support WG"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss/index.cfm"/>
    </telecom>
  </contact>
  <description
               value="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
              value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
      <code value="focus"/>
      <display value="Clinical Focus"/>
    </code>
    <valueCodeableConcept>
      <coding>
        <system value="http://snomed.info/sct"/>
        <code value="384810002"/>
        <display value="Immunization/vaccination management (procedure)"/>
      </coding>
    </valueCodeableConcept>
  </useContext>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <purpose
           value="Example artifact implementation of CDC ACIP Hep B vaccination guidelines for adults, 18 years and older, who have not yet been immunized."/>
  <topic>
    <text value="Immunization Forecasting"/>
  </topic>
  <author>
    <name value="Daryl Chertcoff"/>
  </author>
  <author>
    <name value="Bryn Rhodes"/>
  </author>
  <relatedArtifact>
    <type value="documentation"/>
    <display
             value="Immunization Calculation Engine - Hep B Vaccine Group - Hep B 2-dose Adult Series"/>
    <url
         value="https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"/>
    <document>
      <url
           value="https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"/>
    </document>
  </relatedArtifact>
  <relatedArtifact>
    <type value="documentation"/>
    <display
             value="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 value="http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF"/>
    <document>
      <url value="http://www.cdc.gov/mmwr/volumes/67/rr/pdfs/rr6701-H.PDF"/>
    </document>
  </relatedArtifact>
  <relatedArtifact>
    <type value="documentation"/>
    <display
             value="April 2018 Recommendations for the use of adjuvanted hepatitis B vaccine (Heplisav-B, Dynavax)"/>
    <url value="https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf"/>
    <document>
      <url
           value="https://www.cdc.gov/mmwr/volumes/67/wr/pdfs/mm6715a5-H.pdf"/>
    </document>
  </relatedArtifact>
  <library
           value="http://hl7.org/fhir/uv/cpg/hepb/Library/HepBAdultForecasting"/>
  <action>
    <title value="Hep B Immunization Forecast"/>
    <description
                 value="Vaccinate Adult with specified Hep B forecast, if noted"/>
    <documentation>
      <type value="documentation"/>
      <display
               value="Immunization Calculation Engine - Hep B 2-dose Adult Series"/>
      <url
           value="https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"/>
      <document>
        <url
             value="https://cdsframework.atlassian.net/wiki/spaces/ICE/pages/14352491/Hep+B+Vaccine+Group#HepBVaccineGroup-ImmunizationSeries:HepB2-doseAdultSeries"/>
      </document>
    </documentation>
    <trigger>
      <type value="named-event"/>
      <name value="patient-view"/>
    </trigger>
    <condition>
      <kind value="applicability"/>
      <expression>
        <description value="Is a Hep B Adult Recommendation Available?"/>
        <language value="text/cql"/>
        <expression
                    value="Patient Hep B Immunization History should be Evaluated in Adult Series"/>
      </expression>
    </condition>
    <groupingBehavior value="visual-group"/>
    <selectionBehavior value="exactly-one"/>
    <dynamicValue>
      <path value="action.title"/>
      <expression>
        <language value="text/cql"/>
        <expression value="Get Recommendation Overview"/>
      </expression>
    </dynamicValue>
    <dynamicValue>
      <path value="action.description"/>
      <expression>
        <language value="text/cql"/>
        <expression value="Get Recommendation Detail"/>
      </expression>
    </dynamicValue>
    <action>
      <description
                   value="Will Follow Recommendations Provided by This Forecast"/>
    </action>
    <action>
      <description
                   value="Will not immunize due to contraindication(s) or other medical risk factors"/>
    </action>
    <action>
      <description value="Will not immunize due to patient preferences"/>
    </action>
    <action>
      <description
                   value="N/A - see comment (will be reviewed by medical director)"/>
    </action>
  </action>
</PlanDefinition>