Home
API reference
Redox Data Models
Clinical Decisions
Request

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.

Request

Initiate the CDS workflow by providing the required information to the third-party vendor offering clinical insights.

This event type contains the general format to provide CDS data, but it varies depending on use case and the EHR system's alert setup.

For example, an alternative medications alert might be configured to fire when a provider attempts to sign an order, or an alert regarding a possible chronic condition might fire based on a patient's vitals history when a new set is documented.

Beta

Request Body Schema

  • Meta
    required, object
    • DataModel
      required, string
      Reliable

      Clinical Decisions

    • EventType
      required, string
      Reliable

      Request

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

  • Patient
    required, object
    • Identifiers
      required, Array of object

      List of IDs and ID types that identify the patient

      • ID
        required, string
        Reliable

        ID for the patient

      • IDType
        required, string
        Reliable

        Type of ID.
        E.g. MRN, EPI

    • Demographics
      object
      • FirstName
        string, null
        Reliable

        Patient's first name

      • MiddleName
        string, null
        Possible

        Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

      • LastName
        string, null
        Reliable

        Patient's last name

      • DOB
        string, null
        Reliable

        Patient's date of birth.
        In ISO 8601 format

      • SSN
        string, null
        Probable

        Patient's social security number

      • Sex
        string, null
        Reliable
        Value Set

        Patient's sex

      • Race
        string, null
        Possible
        Value Set

        Patient's race

      • IsHispanic
        boolean, null
        Possible
        Value Set

        Indicates if the patient is of hispanic origin.

      • Religion
        string, null
        Possible
        Value Set

        Patient's religious affiliation

      • MaritalStatus
        string, null
        Possible
        Value Set

        Patient's marital status

      • IsDeceased
        boolean, null
        Possible

        Indicates if the patient is deceased

      • DeathDateTime
        string, null
        Possible

        Date and Time the patient was proclaimed deceased.
        ISO 8601 Format

      • PhoneNumber
        object
        • Home
          string, null
          Probable

          Patient's home phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Office
          string, null
          Probable

          Patient's office phone number.
          In E. 164 Format. (e.g. +16085551234)

        • Mobile
          string, null
          Probable

          Patient's mobile phone number.
          In E. 164 Format. (e.g. +16085551234)

      • EmailAddresses
        Array of string

        Patient's email address(es)

      • Language
        string, null
        Possible
        Value Set

        Patient's primary spoken language.
        In ISO 639-1 alpha values (e.g. 'en'). Supported Values

      • Citizenship
        Array of string

        Patient's nation(s) of citizenship.
        In ISO 3166 alpha 2 format (e.g. 'US').

      • Address
        object

        Patient's home address

        • StreetAddress
          string, null
          Probable

          Street address

        • City
          string, null
          Probable

          City

        • State
          string, null
          Probable

          State

        • ZIP
          string, null
          Probable

          ZIP

        • County
          string, null
          Possible

          County

        • Country
          string, null
          Possible
          Value Set

          Country

    • Notes
      Array of string

      Patient-level notes

  • UnsignedMedicationOrders
    required, Array of object

    Array of unsigned medication orders

    • Identifiers
      required, Array of object

      Array of identifiers for the medication order

      • ID
        required, string
        Reliable

        ID of the medication order

      • IDType
        required, string
        Reliable

        IDType of the medication order

    • Frequency
      object
      • Period
        string, null
        Probable

        How often the patient should be taking the medication.
        UCUM Units of Measure

      • Unit
        string, null
        Probable

        Units for how often the patient should be taking the medication

    • Product
      object

      The actual medication given

      • Code
        string, null
        Reliable

        Code

      • Codeset
        string, null
        Reliable

        Code set

      • Name
        string, null
        Reliable

        Name

    • Priority
      string, null
      Possible

      Priority for taking this medication

    • Dose
      object
      • Quantity
        number, null
        Possible

        The size of the dose for pills, capsules, etc.

      • Units
        string, null
        Possible

        The units of the dose.
        UCUM Units of Measure

    • Mode
      string, null
      Reliable

      Mode in which the medication order was created.
      IP/OP

    • Route
      null, null
      Probable

      The method by which the medication is delivered.
      Medication Route FDA Value Set

    • StartDate
      string, null
      Reliable

      When the medication was started.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the medication was ended.
      ISO 8601 Format

    • MixtureType
      string, null
      Possible

      Type of mixture of the medication.
      SimpleMed / IMSMixture / GenericMixture

    • MixtureComponents
      Array of object

      The individual components of a mixed medication

      • Code
        string, null
        Possible

        The code that identifies the component.
        RxNorm code

      • CodeType
        string, null
        Possible

        Type of code sent in the code field.
        RxNorm

      • Dose
        object
        • Quantity
          string, null
          Possible

          Amount of this component added to the mixture

        • Units
          string, null
          Possible

          Units of the component added to the mixture.
          UCUM Units of Measure

    • Questions
      Array of object

      Order-level questions

      • Question
        object

        Information about the question

        • Code
          string, null
          Probable

          Code for the question

        • Codeset
          string, null
          Probable

          Code set used to identify the question

        • Description
          string, null
          Probable

          Description of the question

      • Answer
        object

        Information about the answer

        • Code
          string, null
          Probable

          Code for the answer

        • Codeset
          string, null
          Probable

          Code set used to identify the answer

        • Description
          string, null
          Probable

          Description of the answer

    • Notes
      Array of string

      Order-level notes

  • UnsignedProcedureOrders
    required, Array of object

    Array of unsigned procedure orders

    • Identifiers
      required, Array of object

      Array of identifiers for the procedure order

      • ID
        required, string
        Reliable

        ID of the procedure order

      • IDType
        required, number
        Reliable

        IDType of the procedure order

    • Code
      string, null
      Reliable

      Code for the procedure

    • Codeset
      string, null
      Reliable

      Code set used to identify the procedure

    • Description
      string, null
      Reliable

      Description of the procedure

    • ScheduledDate
      string, null
      Possible

      Scheduled date of the procedure

    • Mode
      string, null
      Reliable

      Mode in which the procedure order was created.
      IP/OP

    • BodySite
      object

      The location on the body where the procedure was performed

      • Code
        string, null
        Probable

        Code

      • Codeset
        string, null
        Probable

        Code set

      • Description
        string, null
        Probable

        Description

    • StartDate
      string, null
      Reliable

      When the procedure was started.
      ISO 8601 Format

    • EndDate
      string, null
      Probable

      When the procedure ended.
      ISO 8601 Format

    • Questions
      Array of object

      Order-level questions

      • Question
        object

        Information about the question

        • Code
          string, null
          Probable

          Code for the question

        • Codeset
          string, null
          Probable

          Code set used to identify the question

        • Description
          string, null
          Probable

          Description of the question

      • Answer
        object

        Information about the answer

        • Code
          string, null
          Probable

          Code for the answer

        • Codeset
          string, null
          Probable

          Code set used to identify the answer

        • Description
          string, null
          Probable

          Description of the answer

    • Notes
      Array of string

      Order-level notes

  • Session
    object
    • Questions
      Array of object

      Questions answered by the ordering provider that apply to all of the orders in the CDS request.

      • Question
        object

        Information about the question

        • Code
          string, null
          Probable

          Code for the question

        • Codeset
          string, null
          Probable

          Code set used to identify the question

        • Description
          string, null
          Probable

          Description of the question

      • Answer
        object

        Information about the answer

        • Code
          string, null
          Probable

          Code for the answer

        • Codeset
          string, null
          Probable

          Code set used to identify the answer

        • Description
          string, null
          Probable

          Description of the answer

  • OrderingProvider
    object
    • ID
      string, null
      Probable

      ID of the ordering provider.
      This ID is often required for Inpatient Visits.

    • IDType
      string, null
      Probable

      ID type of the ID for the ordering provider

    • FirstName
      string, null
      Possible

      First name of the ordering provider

    • LastName
      string, null
      Possible

      Last name of the ordering provider

    • Credentials
      Array of string

      List of credentials for the ordering provider.
      e.g. MD, PhD

    • Address
      object

      Provider's address

      • StreetAddress
        string, null
        Possible

        Street address

      • City
        string, null
        Possible

        City

      • State
        string, null
        Possible

        State

      • ZIP
        string, null
        Possible

        ZIP

      • County
        string, null
        Possible

        County

      • Country
        string, null
        Possible
        Value Set

        Country

    • EmailAddresses
      Array of string

      Provider's email address(es)

    • PhoneNumber
      object
      • Office
        string, null
        Possible

        Provider's office phone number.
        In E. 164 Format. (e.g. +16085551234)

    • Location
      object

      Provider's location

      • Type
        string, null
        Possible

        Type of location.
        Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

      • Facility
        string, null
        Possible

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Possible

          An ID specific to this facility

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Possible

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Possible

          An ID specific to this department

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Possible

        Room.
        Example: 136

  • AuthorizingProvider
    object
    • ID
      string, null
      Possible

      ID of the authorizing provider.
      This ID is often required for Inpatient Visits.

    • IDType
      string, null
      Possible

      ID type of the ID for the authorizing provider

    • FirstName
      string, null
      Possible

      First name of the authorizing provider

    • LastName
      string, null
      Possible

      Last name of the authorizing provider

    • Credentials
      Array of string

      List of credentials for the authorizing provider.
      e.g. MD, PhD

    • Address
      object

      Provider's address

      • StreetAddress
        string, null
        Possible

        Street address

      • City
        string, null
        Possible

        City

      • State
        string, null
        Possible

        State

      • ZIP
        string, null
        Possible

        ZIP

      • County
        string, null
        Possible

        County

      • Country
        string, null
        Possible
        Value Set

        Country

    • EmailAddresses
      Array of string

      Provider's email address(es)

    • PhoneNumber
      object
      • Office
        string, null
        Possible

        Provider's office phone number.
        In E. 164 Format. (e.g. +16085551234)

    • Location
      object

      Provider's location

      • Type
        string, null
        Possible

        Type of location.
        Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

      • Facility
        string, null
        Possible

        Facility.
        Example: Community Hospital

      • FacilityIdentifiers
        Array of object

        List of IDs specific to this facility

        • ID
          string, null
          Possible

          An ID specific to this facility

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Department
        string, null
        Possible

        Department

      • DepartmentIdentifiers
        Array of object

        List of IDs specific to this department

        • ID
          string, null
          Possible

          An ID specific to this department

        • IDType
          string, null
          Possible

          The source or system to which this ID pertains.
          Could be an OID or a human-readable name

      • Room
        string, null
        Possible

        Room.
        Example: 136

Example
json
1
{
2
  "Meta": {
3
    "DataModel": "Clinical Decisions",
4
    "EventType": "Request",
5
    "EventDateTime": "2024-11-20T14:08:29.777Z",
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
  "Session": {
26
    "Questions": [
27
      {
28
        "Question": {
29
          "Code": null,
30
          "Codeset": null,
31
          "Description": null
32
        },
33
        "Answer": {
34
          "Code": null,
35
          "Codeset": null,
36
          "Description": null
37
        }
38
      }
39
    ]
40
  },
41
  "Patient": {
42
    "Identifiers": [
43
      {
44
        "ID": "0000000001",
45
        "IDType": "MR"
46
      },
47
      {
48
        "ID": "e167267c-16c9-4fe3-96ae-9cff5703e90a",
49
        "IDType": "EHRID"
50
      },
51
      {
52
        "ID": "a1d4ee8aba494ca",
53
        "IDType": "NIST"
54
      }
55
    ],
56
    "Demographics": {
57
      "FirstName": "Timothy",
58
      "MiddleName": "Paul",
59
      "LastName": "Bixby",
60
      "DOB": "2008-01-06",
61
      "SSN": "101-01-0001",
62
      "Sex": "Male",
63
      "Race": "White",
64
      "IsHispanic": null,
65
      "Religion": null,
66
      "MaritalStatus": "Single",
67
      "IsDeceased": null,
68
      "DeathDateTime": null,
69
      "PhoneNumber": {
70
        "Home": "+18088675301",
71
        "Office": null,
72
        "Mobile": null
73
      },
74
      "EmailAddresses": [],
75
      "Language": "en",
76
      "Citizenship": [],
77
      "Address": {
78
        "StreetAddress": "4762 Hickory Street",
79
        "City": "Monroe",
80
        "State": "WI",
81
        "ZIP": "53566",
82
        "County": "Green",
83
        "Country": "US"
84
      }
85
    },
86
    "Notes": []
87
  },
88
  "OrderingProvider": {
89
    "ID": "4236464757",
90
    "IDType": "NPI",
91
    "FirstName": "John",
92
    "LastName": "Slate",
93
    "Credentials": [
94
      "DO"
95
    ],
96
    "Address": {
97
      "StreetAddress": "500 First St.",
98
      "City": "Clayton",
99
      "State": "MO",
100
      "ZIP": "63105",
101
      "County": "Saint Louis",
102
      "Country": "USA"
103
    },
104
    "EmailAddresses": [],
105
    "PhoneNumber": {
106
      "Office": "+13145554321"
107
    },
108
    "Location": {
109
      "Type": null,
110
      "Facility": null,
111
      "FacilityIdentifiers": [],
112
      "Department": null,
113
      "DepartmentIdentifiers": [],
114
      "Room": null
115
    }
116
  },
117
  "AuthorizingProvider": {
118
    "ID": "4356789876",
119
    "IDType": "NPI",
120
    "FirstName": "Pat",
121
    "LastName": "Granite",
122
    "Credentials": [
123
      "MD"
124
    ],
125
    "Address": {
126
      "StreetAddress": "123 Main St.",
127
      "City": "Madison",
128
      "State": "WI",
129
      "ZIP": "53703",
130
      "County": "Dane",
131
      "Country": "USA"
132
    },
133
    "EmailAddresses": [],
134
    "PhoneNumber": {
135
      "Office": "+16085551234"
136
    },
137
    "Location": {
138
      "Type": null,
139
      "Facility": null,
140
      "FacilityIdentifiers": [],
141
      "Department": null,
142
      "DepartmentIdentifiers": [],
143
      "Room": null
144
    }
145
  },
146
  "UnsignedMedicationOrders": [
147
    {
148
      "Identifiers": [
149
        {
150
          "ID": "384209384094849",
151
          "IDType": "EHR"
152
        }
153
      ],
154
      "Frequency": {
155
        "Period": "8",
156
        "Unit": "h"
157
      },
158
      "Product": {
159
        "Code": "104894",
160
        "Codeset": null,
161
        "Name": "Ondansetron 4 Mg Po Tbdp"
162
      },
163
      "Priority": "Stat",
164
      "Dose": {
165
        "Quantity": "4",
166
        "Units": "mg"
167
      },
168
      "Mode": "IP",
169
      "Route": "Oral",
170
      "StartDate": "2005-05-01T04:00:00.000Z",
171
      "EndDate": "2011-02-27T05:00:00.000Z",
172
      "MixtureType": null,
173
      "MixtureComponents": [
174
        {
175
          "Code": null,
176
          "CodeType": null,
177
          "Dose": {
178
            "Quantity": null,
179
            "Units": null
180
          }
181
        }
182
      ],
183
      "Questions": [
184
        {
185
          "Question": {
186
            "Code": null,
187
            "Codeset": null,
188
            "Description": "Why is this medication being ordered?"
189
          },
190
          "Answer": {
191
            "Code": null,
192
            "Codeset": null,
193
            "Description": "To prevent nausea after chemotherapy."
194
          }
195
        }
196
      ],
197
      "Notes": []
198
    }
199
  ],
200
  "UnsignedProcedureOrders": [
201
    {
202
      "Code": "76700",
203
      "Codeset": "CPT",
204
      "Description": null,
205
      "Identifiers": [
206
        {
207
          "ID": "329308430984409",
208
          "IDType": "EHR"
209
        }
210
      ],
211
      "ScheduledDate": "2005-07-02T04:00:00:000Z",
212
      "Mode": "IP",
213
      "BodySite": {
214
        "Code": null,
215
        "Codeset": null,
216
        "Description": null
217
      },
218
      "StartDate": "2005-05-01T04:00:00.000Z",
219
      "EndDate": "2011-02-27T05:00:00.000Z",
220
      "Questions": [
221
        {
222
          "Question": {
223
            "Code": null,
224
            "Codeset": null,
225
            "Description": "Why is this ultrasound being ordered?"
226
          },
227
          "Answer": {
228
            "Code": null,
229
            "Codeset": null,
230
            "Description": "The patient swallowed a foreign body."
231
          }
232
        }
233
      ],
234
      "Notes": []
235
    }
236
  ]
237
}