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

: CDS Hook Codes

Page standards status: Normative Maturity Level: 6

Raw json | Download

{
  "resourceType" : "CodeSystem",
  "id" : "HookCodes",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem HookCodes</b></p><a name=\"HookCodes\"> </a><a name=\"hcHookCodes\"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class=\"grid\"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>status</td><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>code</td><td/></tr><tr><td>maturity-level</td><td>maturity-level</td><td/><td>integer</td><td>Hook maturity level per the CDS Hooks Maturity Model</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://cds-hooks.hl7.org/hooks/CodeSystem/HookCodes</code> defines the following codes:</p><table class=\"codes\"><tr><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>status</b></td><td><b>maturity-level</b></td></tr><tr><td style=\"white-space:nowrap\">allergyintolerance-create<a name=\"HookCodes-allergyintolerance-create\"> </a></td><td>AllergyIntolerance create</td><td>Invoked when when a clinician adds a new allergy or intolerance to a patient's list of allergies</td><td/><td>1</td></tr><tr><td style=\"white-space:nowrap\">appointment-book<a name=\"HookCodes-appointment-book\"> </a></td><td>Appointment book</td><td>Invoked when the user is scheduling one or more future encounters/visits for the patient</td><td/><td>1</td></tr><tr><td style=\"white-space:nowrap\">encounter-discharge<a name=\"HookCodes-encounter-discharge\"> </a></td><td>Encounter discharge</td><td>Invoked when the user is performing the discharge process for an encounter where the notion of 'discharge' is relevant - typically an inpatient encounter</td><td/><td>1</td></tr><tr><td style=\"white-space:nowrap\">encounter-start<a name=\"HookCodes-encounter-start\"> </a></td><td>Encounter start</td><td>Invoked when the user is initiating a new encounter</td><td/><td>1</td></tr><tr style=\"background-color: #ffeeee\"><td style=\"white-space:nowrap\">medication-prescribe<a name=\"HookCodes-medication-prescribe\"> </a></td><td>Medication prescribe</td><td>Deprecated in favor of the order-select and order-sign hooks</td><td>deprecated</td><td>2</td></tr><tr><td style=\"white-space:nowrap\">medication-refill<a name=\"HookCodes-medication-refill\"> </a></td><td>Medication refill</td><td>Invoked when a medication refill request for an existing prescription of a specific medication is received</td><td/><td>1</td></tr><tr><td style=\"white-space:nowrap\">medication-verify<a name=\"HookCodes-medication-verify\"> </a></td><td>Medication verify</td><td>Invoked when a pharmacist is ready to verify a medication order for a patient</td><td/><td>1</td></tr><tr><td style=\"white-space:nowrap\">order-dispatch<a name=\"HookCodes-order-dispatch\"> </a></td><td>Order dispatch</td><td>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</td><td/><td>0</td></tr><tr style=\"background-color: #ffeeee\"><td style=\"white-space:nowrap\">order-review<a name=\"HookCodes-order-review\"> </a></td><td>Order review</td><td>Deprecated in favor of the order-sign hook</td><td>deprecated</td><td>3</td></tr><tr><td style=\"white-space:nowrap\">order-select<a name=\"HookCodes-order-select\"> </a></td><td>Order select</td><td>Invoked when a clinician initially selects one or more new orders from a list of potential orders for a specific patient</td><td/><td>4</td></tr><tr><td style=\"white-space:nowrap\">order-sign<a name=\"HookCodes-order-sign\"> </a></td><td>Order sign</td><td>Invoked when a clinician is ready to sign one or more orders for a patient</td><td/><td>6</td></tr><tr><td style=\"white-space:nowrap\">patient-view<a name=\"HookCodes-patient-view\"> </a></td><td>Patient view</td><td>Invoked when the user has just opened a patient's record</td><td/><td>6</td></tr><tr><td style=\"white-space:nowrap\">problem-list-item-create<a name=\"HookCodes-problem-list-item-create\"> </a></td><td>Problem list item create</td><td>Invoked when a clinician has added one or more new problems to a patient's problem list</td><td/><td>1</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 6,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://cds-hooks.hl7.org/hooks/ImplementationGuide/hl7.fhir.uv.cds-hooks-library"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "normative",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://cds-hooks.hl7.org/hooks/ImplementationGuide/hl7.fhir.uv.cds-hooks-library"
          }
        ]
      }
    }
  ],
  "url" : "http://cds-hooks.hl7.org/hooks/CodeSystem/HookCodes",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.4.642.40.94.16.1"
    }
  ],
  "version" : "2.0.0-ballot",
  "name" : "HookCodes",
  "title" : "CDS Hook Codes",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-11-19T14:23:07+00:00",
  "publisher" : "Clinical Decision Support WG",
  "contact" : [
    {
      "name" : "Clinical Decision Support WG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss/index.cfm"
        },
        {
          "system" : "email",
          "value" : "cds@lists.HL7.org"
        }
      ]
    }
  ],
  "description" : "A code system defining codes for all 'standard' hooks",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "content" : "complete",
  "count" : 13,
  "property" : [
    {
      "code" : "status",
      "uri" : "http://hl7.org/fhir/concept-properties#status",
      "type" : "code"
    },
    {
      "code" : "maturity-level",
      "description" : "Hook maturity level per the CDS Hooks Maturity Model",
      "type" : "integer"
    }
  ],
  "concept" : [
    {
      "code" : "allergyintolerance-create",
      "display" : "AllergyIntolerance create",
      "definition" : "Invoked when when a clinician adds a new allergy or intolerance to a patient's list of allergies",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "appointment-book",
      "display" : "Appointment book",
      "definition" : "Invoked when the user is scheduling one or more future encounters/visits for the patient",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "encounter-discharge",
      "display" : "Encounter discharge",
      "definition" : "Invoked when the user is performing the discharge process for an encounter where the notion of 'discharge' is relevant - typically an inpatient encounter",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "encounter-start",
      "display" : "Encounter start",
      "definition" : "Invoked when the user is initiating a new encounter",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "medication-prescribe",
      "display" : "Medication prescribe",
      "definition" : "Deprecated in favor of the order-select and order-sign hooks",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "deprecated"
        },
        {
          "code" : "maturity-level",
          "valueInteger" : 2
        }
      ]
    },
    {
      "code" : "medication-refill",
      "display" : "Medication refill",
      "definition" : "Invoked when a medication refill request for an existing prescription of a specific medication is received",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "medication-verify",
      "display" : "Medication verify",
      "definition" : "Invoked when a pharmacist is ready to verify a medication order for a patient",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    },
    {
      "code" : "order-dispatch",
      "display" : "Order dispatch",
      "definition" : "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",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 0
        }
      ]
    },
    {
      "code" : "order-review",
      "display" : "Order review",
      "definition" : "Deprecated in favor of the order-sign hook",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "deprecated"
        },
        {
          "code" : "maturity-level",
          "valueInteger" : 3
        }
      ]
    },
    {
      "code" : "order-select",
      "display" : "Order select",
      "definition" : "Invoked when a clinician initially selects one or more new orders from a list of potential orders for a specific patient",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 4
        }
      ]
    },
    {
      "code" : "order-sign",
      "display" : "Order sign",
      "definition" : "Invoked when a clinician is ready to sign one or more orders for a patient",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 6
        }
      ]
    },
    {
      "code" : "patient-view",
      "display" : "Patient view",
      "definition" : "Invoked when the user has just opened a patient's record",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 6
        }
      ]
    },
    {
      "code" : "problem-list-item-create",
      "display" : "Problem list item create",
      "definition" : "Invoked when a clinician has added one or more new problems to a patient's problem list",
      "property" : [
        {
          "code" : "maturity-level",
          "valueInteger" : 1
        }
      ]
    }
  ]
}