DateTime

DateTime of the event.
ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated.
Included in messages from Redox

String

ID of the source.
UUID

String

Name of the source

Array of Objects

List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox

String

ID of the destination.
UUID

String

Name of the destination

String

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

Numeric

ID of the message created in Redox

String

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

Numeric

ID of the transmission created in Redox

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

String

String

Patient's race.
Supported Values

Boolean

Indicates if the patient is of hispanic origin.

String

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)

String

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

Array of strings

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

Note: The valid set of citizenships is a smaller list than the list of IS0 3166 country codes, and should be limited to the 193 United Nations countries plus 6 states: ROC Taiwan, Macao (SAR China), Hong Kong (SAR China), Kosovo, Palestinian Territory and the Vatican.*

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

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

String

Country

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

String

Department

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

String

Country

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

String

Department

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

DateTime of the event.
ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated.
Included in messages from Redox

String

ID of the source.
UUID

String

Name of the source

Array of Objects

List of destinations to send your message to. All messages must have at least one destination. Queries accept only one destination.
Required when sending data to Redox

String

ID of the destination.
UUID

String

Name of the destination

String

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

Numeric

ID of the message created in Redox

String

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

Numeric

ID of the transmission created in Redox

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

A flag indicating whether there is an alert to show to the user. If set to false, the ordering will finish uninterrupted.
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 about the additional unsigned orders suggested

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

Text to display explaining the decision provided

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

Hyperlink to visit for requested additional information

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