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

CodeSystem: CDS Hook Codes

Official URL: http://cds-hooks.hl7.org/hooks/CodeSystem/HookCodes Version: 2.0.0-ballot
Standards status: Normative Maturity Level: 6 Computable Name: HookCodes
Other Identifiers: OID:2.16.840.1.113883.4.642.40.94.16.1

A code system defining codes for all 'standard' hooks

This Code system is referenced in the definition of the following value sets:

  • This CodeSystem is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
status status http://hl7.org/fhir/concept-properties#status code
maturity-level maturity-level integer Hook maturity level per the CDS Hooks Maturity Model

Concepts

This case-sensitive code system http://cds-hooks.hl7.org/hooks/CodeSystem/HookCodes defines the following codes:

CodeDisplayDefinitionstatusmaturity-level
allergyintolerance-create AllergyIntolerance create Invoked when when a clinician adds a new allergy or intolerance to a patient's list of allergies 1
appointment-book Appointment book Invoked when the user is scheduling one or more future encounters/visits for the patient 1
encounter-discharge Encounter discharge Invoked when the user is performing the discharge process for an encounter where the notion of 'discharge' is relevant - typically an inpatient encounter 1
encounter-start Encounter start Invoked when the user is initiating a new encounter 1
medication-prescribe Medication prescribe Deprecated in favor of the order-select and order-sign hooks deprecated 2
medication-refill Medication refill Invoked when a medication refill request for an existing prescription of a specific medication is received 1
medication-verify Medication verify Invoked when a pharmacist is ready to verify a medication order for a patient 1
order-dispatch Order dispatch Invoked when a practitioner is selecting a candidate performer for a pre-existing order or (set of orders) that was not assigned to a specific performer 0
order-review Order review Deprecated in favor of the order-sign hook deprecated 3
order-select Order select Invoked when a clinician initially selects one or more new orders from a list of potential orders for a specific patient 4
order-sign Order sign Invoked when a clinician is ready to sign one or more orders for a patient 6
patient-view Patient view Invoked when the user has just opened a patient's record 6
problem-list-item-create Problem list item create Invoked when a clinician has added one or more new problems to a patient's problem list 1

Description of the above table(s).