Home
API reference
CDS hooks
CDSHooks
discovery

CDSHooks discovery

get/cds-hooks/v1/sources/{sourceId}/cds-services/

These API events help facilitate real-time, immediate clinical decision support (CDS). CDS hooks are events that are triggered during the provider's workflow, typically appearing as a popup modal or separate iFrame. The most common hooks are triggered upon:

  • opening a patient chart
  • signing an order
  • creating an order
  • scheduling

We support these type of hooks that allow you to:

  • request a list of supported CDS hooks within the EHR system;
  • return a list of supported CDS hooks within the EHR system;
  • view context for a patient upon opening or interacting with their chart;
  • view context when creating and selecting an order from a list of order types; and
  • view order context and insights when signing an order.

discovery

Request a list of supported CDS hooks within the EHR system.

The list is returned in the Discovery Response event type.

Beta

Request Parameters

  • sourceId
    required, string

    Displays the unique identifier of a source within a given environment.

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      CDSHooks

    • EventType
      required, string
      Reliable

      discovery

    • EventDateTime
      string, null
      Reliable

      Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
      ISO 8601 Format

    • Test
      boolean, null
      Reliable

      Indicates whether the request is a test or not.

    • Source
      object

      Contains the information for the system initiating the message, including the source ID and name.
      Included in messages from Redox

      • ID
        string, null
        Reliable

        Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the system initiating the message.

    • Destinations
      Array of object

      Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
      Required when sending data to Redox.

      • ID
        string, null
        Reliable

        Identifies the endpoint that the request is directed to.
        UUID

      • Name
        string, null
        Reliable

        Displays the name of the endpoint that the request is directed to.

    • Logs
      Array of object

      Contains the log identifier(s) for the request.

      • ID
        string, null
        Reliable

        Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
        UUID

      • AttemptID
        string, null
        Reliable

        Identifies the request log attempt value, which is useful when retries are possible.
        UUID

    • FacilityCode
      string, null
      Possible

      Code for the facility related to the message.
      Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Example
json
1
{
2
  "Meta": {
3
    "Logs": [
4
      {
5
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
6
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
7
      }
8
    ],
9
    "Test": true,
10
    "EventDateTime": "2026-05-28T22:44:52.399Z",
11
    "Source": {
12
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
13
      "Name": "Redox Dev Tools"
14
    },
15
    "Destinations": [
16
      {
17
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
18
        "Name": "Redox EMR"
19
      }
20
    ],
21
    "DataModel": "CDSHooks",
22
    "EventType": "discovery",
23
    "FacilityCode": null
24
  }
25
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.