# Clinical Decisions Response

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 <u>clinical decision</u> 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 vs. 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.

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. 

Status: Beta

## Request body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `Meta` | object | Yes |  |
| `Meta.DataModel` | string | Yes | Clinical Decisions |
| `Meta.EventType` | string | Yes | Response |
| `Meta.EventDateTime` | string or null | No | Displays the UTC date and time that an outgoing request is delivered or an incoming request is received. *[ISO 8601 Format](http://en.wikipedia.org/wiki/ISO_8601)* |
| `Meta.Test` | boolean or null | No | Indicates whether the request is a test or not. |
| `Meta.Source` | object | No | Contains the information for the system initiating the message, including the source ID and name. *Included in messages from Redox* |
| `Meta.Source.ID` | string or null | No | 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* |
| `Meta.Source.Name` | string or null | No | Displays the name of the system initiating the message. |
| `Meta.Destinations` | Array of object | No | 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.* |
| `Meta.Destinations[].ID` | string or null | No | Identifies the endpoint that the request is directed to. *UUID* |
| `Meta.Destinations[].Name` | string or null | No | Displays the name of the endpoint that the request is directed to. |
| `Meta.Logs` | Array of object | No | Contains the log identifier(s) for the request. |
| `Meta.Logs[].ID` | string or null | No | 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* |
| `Meta.Logs[].AttemptID` | string or null | No | Identifies the request log attempt value, which is useful when retries are possible. *UUID* |
| `Meta.FacilityCode` | string or null | No | 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` | Array of object | Yes | The array of returned CDS advisories. |
| `Advisories[].Session` | string | Yes | This is the session ID that matches the original order to the support response. |
| `Advisories[].ShowAlert` | boolean or null | No | 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* |
| `Advisories[].RemovableUnsignedOrders` | Array of object | No | An array of unsigned orders suggested for removal. |
| `Advisories[].RemovableUnsignedOrders[].ID` | string or null | No | ID of the order suggested for removal. |
| `Advisories[].RemovableUnsignedOrders[].IDType` | string or null | No | ID type of the order suggested for removal. |
| `Advisories[].RemovableUnsignedOrders[].Title` | string or null | No | Title of the order suggested for removal. |
| `Advisories[].AdditionalUnsignedOrders` | Array of object | No | An array of additional unsigned orders suggested. |
| `Advisories[].AdditionalUnsignedOrders[].ID` | string or null | No | ID of the additional order suggested. |
| `Advisories[].AdditionalUnsignedOrders[].IDType` | string or null | No | IDType of the additional order suggested. |
| `Advisories[].AdditionalUnsignedOrders[].Title` | string or null | No | Title of the additional order suggested. |
| `Advisories[].AdditionalUnsignedOrders[].Questions` | Array of object | No | 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. |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Code` | string or null | No | Code |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Codeset` | string or null | No | Code set |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Description` | string or null | No | Description |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Answers` | Array of object | No | Possible answers for the question. |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Code` | string or null | No | Code |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Codeset` | string or null | No | Code set |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Description` | string or null | No | Description |
| `Advisories[].AdditionalUnsignedOrders[].Questions[].Answers[].Comment` | string or null | No | A comment regarding the answer. |
| `Advisories[].Description` | string or null | No | 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`. |
| `Advisories[].Notes` | Array of object | No | Notes on processing next steps. |
| `Advisories[].Notes[].Text` | string or null | No |  |
| `Advisories[].Notes[].Display` | string or null | No |  |
| `Advisories[].AdditionalInfo` | Array of object | No |  |
| `Advisories[].AdditionalInfo[].DecisionSupport` | object | No | Provide additional information |
| `Advisories[].AdditionalInfo[].DecisionSupport.Code` | string or null | No | Code for the additional information |
| `Advisories[].AdditionalInfo[].DecisionSupport.Codeset` | string or null | No | Code set used to identify the additional information |
| `Advisories[].AdditionalInfo[].DecisionSupport.Description` | string or null | No | Description of the additional information |
| `Advisories[].AdditionalInfo[].Link` | string or null | No | May contain an external link for the provider to access and enter additional information pertaining to the clinical decision. |
| `Advisories[].Errors` | Array of object | No | Provide Error codes and display the reason. |
| `Advisories[].Errors[].Code` | string or null | No | Code for the errors |
| `Advisories[].Errors[].Codeset` | string or null | No | Code set used to identify the errors |
| `Advisories[].Errors[].Description` | string or null | No | Description of the errors |

## Example

```json
{
  "Meta": {
    "DataModel": "Clinical Decisions",
    "EventType": "Response",
    "EventDateTime": "2026-11-18T19:05:05.809Z",
    "Test": true,
    "Source": {
      "ID": "7ce6f387-c33c-417d-8682-81e83628cbd9",
      "Name": "Redox Dev Tools"
    },
    "Destinations": [
      {
        "ID": "af394f14-b34a-464f-8d24-895f370af4c9",
        "Name": "Redox EMR"
      }
    ],
    "Logs": [
      {
        "ID": "d9f5d293-7110-461e-a875-3beb089e79f3",
        "AttemptID": "925d1617-2fe0-468c-a14c-f8c04b572c54"
      }
    ],
    "FacilityCode": null
  },
  "Advisories": [
    {
      "ShowAlert": false,
      "Session": "session490284",
      "RemovableUnsignedOrders": [
        {
          "ID": "157968300",
          "IDType": "CPT",
          "Title": "Colonoscopy"
        }
      ],
      "AdditionalUnsignedOrders": [
        {
          "ID": "157968300",
          "IDType": "RxNorm",
          "Title": "Acetaminophen",
          "Questions": [
            {
              "Code": null,
              "Codeset": null,
              "Description": null,
              "Answers": [
                {
                  "Code": null,
                  "Codeset": null,
                  "Description": null,
                  "Comment": null
                }
              ]
            }
          ]
        }
      ],
      "Description": null,
      "Notes": [
        {
          "Text": null,
          "Display": null
        }
      ],
      "AdditionalInfo": [
        {
          "DecisionSupport": {
            "Code": "9",
            "Codeset": null,
            "Description": "We are very confident in this order."
          },
          "Link": "https://examplelink"
        }
      ],
      "Errors": [
        {
          "Code": null,
          "Codeset": null,
          "Description": null
        }
      ]
    }
  ]
}
```
