CDS Hooks Library, published by Clinical Decision Support WG. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cds-hooks-library/ and changes regularly. See the Directory of published versions
| Page standards status: Informative |
This page describes the changes made in each version of the CDS Hooks Library, organized by the impact of the change. Each change identifies the tracker (an HL7 JIRA issue, or the GitHub pull request where no JIRA issue exists), a short summary of the change, and links to where the change was applied in the specification.
In this ballot, new and modified content is highlighted throughout the specification relative to the STU 1 publication. Highlighting is on by default and can be turned off or on with the Highlight text changes? checkbox at the top of each page. Content that was removed cannot be highlighted; removals are described below.
There are no non-compatible changes in this release.
patient-view and order-sign hooks to maturity level 6 (Normative) per the CDS Hooks Maturity Model, and declared their standards status as Normative for this ballot (applied here, here, here and here)medication-verify hook (maturity level 1 - Submitted), invoked when a pharmacist is ready to verify a signed, active medication order (applied here and here)order-sign hook to version 1.1.0 and revised the draftOrders context description to allow orders that are being re-signed after revision (i.e. not in draft status), consistent with the order-revision workflow (applied here and here)order-select on limiting interruption of the ordering workflow: the hook fires on initial selection only, CDS Services should only return actionable cards with an accurate indicator, and detail-dependent guidance may be better suited to order-sign (applied here)appointment-book, encounter-discharge, encounter-start, order-dispatch, order-select, order-sign and patient-view, so hook contexts can be validated with the FHIR Validator, including the ord-1 invariant requiring user, performer and selection references to be in the form [ResourceType]/[id], and added a Schemas menu entry (applied here, here, here, here, here, here, here and here)appointment-book, encounter-start and encounter-discharge and a medication refill workflow diagram to medication-refill, and consolidated per-page requests for workflow feedback into a single Workflow Feedback section on the overview page (applied here, here, here, here and here)type to the draftOrders Bundles in the order-select and order-sign examples (applied here and here)appointment-book examples so that appointments is a FHIR Bundle of Appointment resources, as required by the context definition (applied here)appointment-book to describe CDS Services as aiding, rather than intervening in, scheduling decisions (applied here)episodeOfCareId would be useful context for encounter-start (applied here)order-dispatch example and the fulfillmentTasks description to use the context field name dispatchedOrders rather than dispatched-orders (applied here and here)draft for medication-refill and problem-list-item-create, trial-use otherwise) and removed the hard-coded status statements from the appointment-book, encounter-discharge, encounter-start, medication-refill, medication-verify, order-select, order-sign, patient-view and template pagesorder-review deprecation notice from a GitHub issue to FHIR-59798 (applied here)hookVersion and change log to record the documentation changes above as patch versions, as required by the CDS Hooks hook versioning rules, and aligned the order-select, medication-verify and template change logs with their declared versions (applied here, here, here, here, here, here, here, here, here, here, here, here, here and here)patient-view, order-sign, order-select, order-dispatch, encounter-start, encounter-discharge and appointment-book hooks as individual Standards for Trial Use