DateTime

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

Boolean

Indicates whether the request is a test.

String

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

String

Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
UUID

String

Displays the name of the system that originates the message.

Array of Objects

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.

String

Identifies the endpoint that the request is directed to.
UUID

String

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

Array of Objects

Contains the log identifier(s) for the request.

String

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

String

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

String

Record in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.

Numeric

Identifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.

Numeric

Identifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

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.

Array of Objects

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

Object

Information about the question

String

Code for the question

String

Code set used to identify the question

String

Description of the question

Object

Information about the answer

String

Code for the answer

String

Code set used to identify the answer

String

Description of the answer

Array of Objects

List of IDs and ID types that identify the patient

String

Patient's first name

String

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

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

String

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

String

ID type of the ID for the ordering provider

String

First name of the ordering provider

String

Last name of the ordering provider

Array of Strings

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

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

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

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

String

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

String

ID type of the ID for the authorizing provider

String

First name of the authorizing provider

String

Last name of the authorizing provider

Array of Strings

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

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

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

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

Array of objects

Array of unsigned medication orders

Array of Objects

Array of identifiers for the medication order

String

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

String

Units for how often the patient should be taking the medication

Object

The actual medication given

String

Code

String

Code set

String

Name

String

Priority for taking this medication

Numeric

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

String

The units of the dose.
UCUM Units of Measure

String

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

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

String

When the medication was started.
ISO 8601 Format

String

When the medication was ended.
ISO 8601 Format

String

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

String

The individual components of a mixed medication

String

The code that identifies the component.
RxNorm code

String

Type of code sent in the code field.
RxNorm

String

Amount of this component added to the mixture

String

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

Array of Objects

Order-level questions

Object

Information about the question

String

Code for the question

String

Code set used to identify the question

String

Description of the question

Object

Information about the answer

String

Code for the answer

String

Code set used to identify the answer

String

Description of the answer

Array of Strings

Order-level notes

Array of Objects

Array of unsigned procedure orders

String

Code for the procedure

String

Code set used to identify the procedure

String

Description of the procedure

Array of Objects

Array of identifiers for the procedure order

String

Scheduled date of the procedure

String

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

Object

The location on the body where the procedure was performed

String

Code

String

Code set

String

Description

String

When the procedure was started.
ISO 8601 Format

String

When the procedure ended.
ISO 8601 Format

Array of Objects

Order-level questions

Object

Information about the question

String

Code for the question

String

Code set used to identify the question

String

Description of the question

Object

Information about the answer

String

Code for the answer

String

Code set used to identify the answer

String

Description of the answer

Array of Strings

Order-level notes

DateTime

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

Boolean

Indicates whether the request is a test.

String

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

String

Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
UUID

String

Displays the name of the system that originates the message.

Array of Objects

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.

String

Identifies the endpoint that the request is directed to.
UUID

String

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

Array of Objects

Contains the log identifier(s) for the request.

String

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

String

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

String

Record in Redox that corresponds to the communication sent from the source system to Redox.
Included in requests from Redox.

Numeric

Identifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

Record in Redox that corresponds to the communication sent from Redox to the destination endpoint.
Included in messages from Redox.

Numeric

Identifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

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.

Array of Objects

The array of returned CDS advisories.

Boolean

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

Array of Objects

An array of unsigned orders suggested for removal.

String

ID of the order suggested for removal.

String

ID type of the order suggested for removal.

String

Title of the order suggested for removal.

Array of Objects

An array of additional unsigned orders suggested.

String

ID of the additional order suggested.

String

IDType of the additional order suggested.

String

Title of the additional order suggested.

Array of Objects

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.

String

Code

String

Code set

String

Description

Array of Objects

Possible answers for the question.

String

Code

String

Code set

String

Description

String

A comment regarding the answer.

String

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.

Array of Strings

Notes on processing next steps.

String

String

Object

Provide additional information

String

Code for the additional information

String

Code set used to identify the additional information

String

Description of the additional information

String

May contain an external link for the provider to access and enter additional information pertaining to the clinical decision.

Array of Objects

Provide Error codes and display the reason.

String

Code for the errors

String

Code set used to identify the errors

String

Description of the errors