Clinical Practice Guidelines Example Implmentation Guide - Hepatitis B Vaccination
1.0.0 - ci-build
Clinical Practice Guidelines Example Implmentation Guide - Hepatitis B Vaccination
1.0.0 - ci-build
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
| Draft as of 2024-11-18 |
{
"resourceType" : "PlanDefinition",
"id" : "HepBAdultForecastingPD",
"text" : {
"status" : "generated",
"div" : "<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 >= 18 Years of Age</a></p><p><b>identifier</b>: HepBAdultForecastingPD\u00a0(use:\u00a0official,\u00a0)</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 >= 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-11-18 18:29:30+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>\n</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/6.0.2/CodeSystem-usage-context-type.html#usage-context-type-focus\">UsageContextType focus</a>: 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>\n</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><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><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><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></td></tr></table></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><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><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></td></tr></table></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><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><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></td></tr></table></blockquote><p><b>library</b>: <a href=\"Library-HepBAdultForecasting.html\">Logic for Immunization Forecasting of Hepatitis B Vaccine for Adults >= 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><h3>Documents</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Url</b></td></tr><tr><td style=\"display: none\">*</td><td><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></td></tr></table></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>"
},
"url" : "http://cqframework.org/cpg-example-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-11-18T18:29:30+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://cqframework.org/cpg-example-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)"
}
]
}
]
}