CDS Hooks Library
2.0.0-ballot - R2 Normative Ballot International flag

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

Plain Language Summary goes here

Overview

Official URL: http://cds-hooks.hl7.org/hooks/ImplementationGuide/hl7.fhir.uv.cds-hooks-library Version: 2.0.0-ballot
IG Standards status: Normative Maturity Level: 6 Computable Name: CDSHooksLibrary
Other Identifiers: OID:2.16.840.1.113883.4.642.40.94

This is the 2.0.0 ballot of the CDS Hooks Library (Release 2), balloted as a mixed Normative/Trial-Use specification. The patient-view and order-sign hooks are balloted as Normative, and the other active hooks remain Standard for Trial Use. This ballot also applies implementer feedback received since the STU 1 publication.

Summary of changes

  • patient-view and order-sign advance to maturity level 6 (Normative) and are balloted as normative content
  • New medication-verify hook (maturity level 1, Submitted) for pharmacist verification of signed medication orders
  • New CDS Hook Codes code system defining a code, status and maturity level for each hook
  • New logical models for hook contexts, so hook context can be validated with the FHIR Validator
  • order-sign (version 1.1.0) allows orders being re-signed after revision, and order-select adds guidance on limiting interruption of the ordering workflow
  • Workflow diagrams for the encounter, ordering and medication refill workflows, FHIR-version-neutral context tables, corrected examples, and editorial fixes, each recorded as a patch version in the hook's change log

For the complete list of changes, with tracker references and links to where each change was applied, see the Changes page. New and modified content is highlighted throughout the specification; use the Highlight text changes? checkbox at the top of each page to turn the highlighting on or off.

Questions for balloters

  • Normative readiness: Are patient-view and order-sign stable and sufficiently implemented to be published as Normative?
  • Hook maturity: Is the maturity level assigned to each hook (shown in the Hooks list and on each hook page) accurate, based on known implementations? Please also record implementations on the CDS Hooks Availability page.
  • Workflows: Do the workflow diagrams accurately describe the encounter, ordering and medication refill workflows? See Workflow Feedback.
  • Hook-specific questions: Please respond to the "Looking for Feedback" questions on the appointment-book and encounter-start pages, including whether episodeOfCareId would be useful context for encounter-start.

CDS Hooks Library

Introduction

The CDS Hooks Library contains specifications of industry standardized clinical workflow steps upon which remote clinical decision support can be requested. The Library is an HL7 publication with mixed standards status: the patient-view and order-sign hooks are Normative, and the remaining hooks are each published at the status shown on their page (Standard for Trial Use, Draft, or Deprecated). The names of the below hooks hyperlink to their individual specification and the number following their name indicates their specific maturity, according to the CDS Hooks Maturity Model. Because hook maturity is based on the extent of implementation, client and CDS Service implementations of each hook are tracked on the CDS Hooks Availability page, and implementers are encouraged to add their own implementations there. All hooks are intended to be used by systems conforming to the HL7 CDS Hooks Implementation Guide.

New hooks are proposed in a prescribed format using the documentation template by submitting a pull request for community feedback. Hooks are versioned, and mature according to the Hook Maturity Model. Anyone may propose a new CDS Hooks hook. New hooks will continue to be specified and matured in the Library while changes to the base CDS Hooks Implementation Guide become infrequent and tightly constrained.

See https://cds-hooks.org/ for additional information, resources and ways to get involved.

Hooks

Workflow Feedback

Looking for Feedback: Several hooks are used together across a larger clinical workflow. We are seeking implementer feedback on these overall workflows, including the workflow diagrams on the linked hook pages: Have you encountered any useful documentation, references or diagrams that help illustrate these workflows? Please share!

Code system

Implementers who need to refer to CDS Hook Definitions using HL7's binding machinery (e.g. in CapabilityStatements) may make use of the codes defined in the Hook Codes CodeSystem.

Intellectual Property Statements

CDS Hooks is the copyright of HL7 International and Boston Children's Hospital. The CDS Hooks specification is licensed under a Creative Commons Attribution 4.0 International License. All source code for CDS Hooks is available at https://github.com/cds-hooks.

No use of external IP

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (hl7.fhir.uv.cds-hooks-library.r4) and R4B (hl7.fhir.uv.cds-hooks-library.r4b) are available.

IGPackageFHIRComment
CDS Hooks Libraryhl7.fhir.uv.cds-hooks-library#2.0.0-ballotR4
CDS Hooks Library / HL7 Terminology (THO)hl7.terminology.r4#7.5.0R4Automatically added as a dependency - all IGs depend on HL7 Terminology
CDS Hooks Library / FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.4.0R4Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
CDS Hooks Library / CDS Hookshl7.fhir.uv.cds-hooks#2.0.1R4
CDS Hooks Library / CDS Hooks / HL7 Terminology (THO)hl7.terminology.r4#6.2.0R4
CDS Hooks Library / CDS Hooks / FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.2.0R4
CDS Hooks Library / FHIR Tooling Extensions IGhl7.fhir.uv.tools.r4#1.3.0R4
CDS Hooks Library / FHIR Tooling Extensions IG / HL7 Terminology (THO)hl7.terminology.r4#7.4.0R4
CDS Hooks Library / FHIR Tooling Extensions IG / FHIR Extensions Packhl7.fhir.uv.extensions.r4#5.3.0R4
CDS Hooks Library / FHIR Tooling Extensions IG / FHIR Extensions Pack / HL7 Terminology (THO)hl7.terminology.r4#7.1.0R4

Package hl7.fhir.uv.extensions.r4#5.4.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Wed, Oct 28, 2026 08:43+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.2.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Package hl7.fhir.uv.cds-hooks#2.0.1

CDS Hooks describes a "hook"-based pattern for invoking decision support from within a clinician's workflow. (built Wed, Mar 12, 2025 16:49+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.3.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, May 16, 2026 18:32+1000+10:00)

Package hl7.fhir.uv.tools.r4#1.3.0

This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Oct 6, 2026 15:55+1100+11:00)

There are no Global profiles defined