Clinical Decisions

This data model communicates real-time, immediate clinical decision support (CDS). Providers rely on the Request event type while vendors respond with the Response event type to complete the CDS workflow.

A clinical decision is useful when a provider wants to recommend alternative medications/procedures or identify drug interactions before placing an order.

This data model has event types that allow you to:

request information from a third-party app offering CDS data; and
return clinical insights, observations, and recommendations.

EHR support

The EHR system must have a corresponding CDS API that can map to the ClinicalDecisions data model. This typically works with Epic EHR systems, but since we built ClinicalDecisions on FHIR® or CDS Hook specifications, it's possible for other EHR systems to support, too.

ClinicalDecisions v SSO data model

ClinicalDecisions returns discrete data to offer CDS within the EHR system. It's part of a typical ordering workflow.

SSO is triggered when the user clicks a specially-configured button to launch an app within the EHR system. It returns a URL for the EHR system to launch the app's system.

Response

Send clinical insights, observations, and recommendations for the provider to review during the clinical decisioning process.

This returns discrete data that the EHR system utilizes as part of an alert to advise on the provider's order.

Beta

Request Body Schema

Show Required Fields Only

Show Translation Fields

Meta
required, object
- DataModel
  required, string
  Reliable
  Clinical Decisions
- EventType
  required, string
  Reliable
  Response
- 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.
Advisories
required, Array of object
The array of returned CDS advisories.
- Session
  required, string
  This is the session ID that matches the original order to the support response.
- ShowAlert
  boolean, null
  This flag indicates whether a CDS alert is shown to the provider while they're placing an order in the EHR system. If the CDS alert shouldn't be visible in the EHR system, set this value to false. But keep in mind that if this is false, the provider won't see an alert while placing an order.
  True / False
- RemovableUnsignedOrders
  Array of object
  An array of unsigned orders suggested for removal.
  ID
  string, null
  ID of the order suggested for removal.
  IDType
  string, null
  ID type of the order suggested for removal.
  Title
  string, null
  Title of the order suggested for removal.
- AdditionalUnsignedOrders
  Array of object
  An array of additional unsigned orders suggested.
  ID
  string, null
  ID of the additional order suggested.
  IDType
  string, null
  IDType of the additional order suggested.
  Title
  string, null
  Title of the additional order suggested.
  Questions
  Array of object
  An array of questions that correspond to any custom Ask at Order Entry (AOE) questions the provider may have filled out when placing an order. If the CDS workflow is triggered when the provider places a medication or procedure order, the healthcare organization can configure AOE questions to appear for certain orders to ensure the third-party app responding to the CDS request has all of the data it needs.
  Code
  string, null
  Probable
  Code
  Codeset
  string, null
  Probable
  Code set
  Description
  string, null
  Probable
  Description
  Answers
  Array of object
  Possible answers for the question.
  Code
  string, null
  Probable
  Code
  Codeset
  string, null
  Probable
  Code set
  Description
  string, null
  Probable
  Description
  Comment
  string, null
  A comment regarding the answer.
- Description
  string, null
  Possible
  Displays the CDS text for the provider to review while placing an order. This text description only displays when the Advisories[].ShowAlert field is set to true.
- Notes
  Array of object
  Notes on processing next steps.
  Text
  string, null
  Possible
  Display
  string, null
  Possible
- AdditionalInfo
  Array of object
  DecisionSupport
  object
  Provide additional information
  Code
  string, null
  Reliable
  Code for the additional information
  Codeset
  string, null
  Reliable
  Code set used to identify the additional information
  Description
  string, null
  Reliable
  Description of the additional information
  Link
  string, null
  Possible
  May contain an external link for the provider to access and enter additional information pertaining to the clinical decision.
- Errors
  Array of object
  Provide Error codes and display the reason.
  Code
  string, null
  Reliable
  Code for the errors
  Codeset
  string, null
  Reliable
  Code set used to identify the errors
  Description
  string, null
  Reliable
  Description of the errors

Example

json

1
{
2
  "Meta": {
3
    "DataModel": "Clinical Decisions",
4
    "EventType": "Response",
5
    "EventDateTime": "2024-12-20T18:11:36.537Z",
6
    "Test": true,
7
    "Source": {
8
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
9
      "Name": "Redox Dev Tools"
10
    },
11
    "Destinations": [
12
      {
13
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
14
        "Name": "Redox EMR"
15
      }
16
    ],
17
    "Logs": [
18
      {
19
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
20
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
21
      }
22
    ],
23
    "FacilityCode": null
24
  },
25
  "Advisories": [
26
    {
27
      "ShowAlert": false,
28
      "Session": "session490284",
29
      "RemovableUnsignedOrders": [
30
        {
31
          "ID": "157968300",
32
          "IDType": "CPT",
33
          "Title": "Colonoscopy"
34
        }
35
      ],
36
      "AdditionalUnsignedOrders": [
37
        {
38
          "ID": "157968300",
39
          "IDType": "RxNorm",
40
          "Title": "Acetaminophen",
41
          "Questions": [
42
            {
43
              "Code": null,
44
              "Codeset": null,
45
              "Description": null,
46
              "Answers": [
47
                {
48
                  "Code": null,
49
                  "Codeset": null,
50
                  "Description": null,
51
                  "Comment": null
52
                }
53
              ]
54
            }
55
          ]
56
        }
57
      ],
58
      "Description": null,
59
      "Notes": [
60
        {
61
          "Text": null,
62
          "Display": null
63
        }
64
      ],
65
      "AdditionalInfo": [
66
        {
67
          "DecisionSupport": {
68
            "Code": "9",
69
            "Codeset": null,
70
            "Description": "We are very confident in this order."
71
          },
72
          "Link": "https://examplelink"
73
        }
74
      ],
75
      "Errors": [
76
        {
77
          "Code": null,
78
          "Codeset": null,
79
          "Description": null
80
        }
81
      ]
82
    }
83
  ]
84
}

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®.