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

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

Visit Number.
Unique ID of a single visit

String

Account Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

String

Patient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency

String

DateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format

String

NPI of the attending provider

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending 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

NPI of the consulting provider

String

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

String

ID type of the ID for the consulting provider

String

First name of the consulting provider

String

Last name of the consulting provider

Array of Strings

List of credentials for the consulting 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

NPI of the referring provider

String

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

String

ID type of the ID for the referring provider

String

First name of the referring provider

String

Last name of the referring provider

Array of Strings

List of credentials for the referring 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

Object

Location of the visit

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

Bed.
Example: B

Array of Objects

Education concepts

Object

Subject of the education concept

String

Code set used to identify the education subject

String

Description of the education subject

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education resource was assigned.
ISO 8601 format

String

The status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education resource.
ISO 8601 Format

Array of Objects

List of assigned patient education resources. Education assignments can be videos, handouts, etc.

String

Code for the assignment

String

Code set used to identify the assignment

String

Description of the assignment

Object

Topic of the education assignment

String

Code for the assignment topic

String

Code set used to identify the assignment topic

String

Description of the assignment topic

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education assignment was created.
ISO 8601 format

String

The status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education assignment.
ISO 8601 Format

Array of Objects

The list of assignees associated to the education assignment

String

The learner type assigned.
Example: Patient, Parent, Caregiver

String

The type of content assigned to the learner.
Example: Video, pamphlet, demonstration

String

An indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling

String

The response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding

Array of Strings

Notes about the assignee's assignment

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

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

Visit Number.
Unique ID of a single visit

String

Account Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

String

Patient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency

String

DateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format

String

NPI of the attending provider

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending 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

NPI of the consulting provider

String

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

String

ID type of the ID for the consulting provider

String

First name of the consulting provider

String

Last name of the consulting provider

Array of Strings

List of credentials for the consulting 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

NPI of the referring provider

String

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

String

ID type of the ID for the referring provider

String

First name of the referring provider

String

Last name of the referring provider

Array of Strings

List of credentials for the referring 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

Object

Location of the visit

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

Bed.
Example: B

Array of Objects

Education concepts

Object

Subject of the education concept

String

Code set used to identify the education subject

String

Description of the education subject

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education resource was assigned.
ISO 8601 format

String

The status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education resource.
ISO 8601 Format

Array of Objects

List of assigned patient education resources. Education assignments can be videos, handouts, etc.

String

Code for the assignment

String

Code set used to identify the assignment

String

Description of the assignment

Object

Topic of the education assignment

String

Code for the assignment topic

String

Code set used to identify the assignment topic

String

Description of the assignment topic

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education assignment was created.
ISO 8601 format

String

The status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education assignment.
ISO 8601 Format

Array of Objects

The list of assignees associated to the education assignment

String

The learner type assigned.
Example: Patient, Parent, Caregiver

String

The type of content assigned to the learner.
Example: Video, pamphlet, demonstration

String

An indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling

String

The response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding

Array of Strings

Notes about the assignee's assignment

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

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

Visit Number.
Unique ID of a single visit

String

Account Number.
An ID that can span several visits often related to the same issue - pregnancy, surgeries, research study, etc.

String

Patient class is used in many EHRs to determine where to put the patient.
Examples: Inpatient, Outpatient, Emergency

String

DateTime of visit or the arrival time of the visit or admission.
ISO 8601 Format

String

NPI of the attending provider

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending 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

NPI of the consulting provider

String

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

String

ID type of the ID for the consulting provider

String

First name of the consulting provider

String

Last name of the consulting provider

Array of Strings

List of credentials for the consulting 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

NPI of the referring provider

String

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

String

ID type of the ID for the referring provider

String

First name of the referring provider

String

Last name of the referring provider

Array of Strings

List of credentials for the referring 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

Object

Location of the visit

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

Bed.
Example: B

Array of Objects

Education concepts

Object

Subject of the education concept

String

Code set used to identify the education subject

String

Description of the education subject

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education resource was assigned.
ISO 8601 format

String

The status of the instance of the education resource.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education resource.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education resource.
ISO 8601 Format

Array of Objects

List of assigned patient education resources. Education assignments can be videos, handouts, etc.

String

Code for the assignment

String

Code set used to identify the assignment

String

Description of the assignment

Object

Topic of the education assignment

String

Code for the assignment topic

String

Code set used to identify the assignment topic

String

Description of the assignment topic

String

Unique ID that is assigned to the instance of the education resource

String

The date and time the instance of the education assignment was created.
ISO 8601 format

String

The status of the instance of the education assignment.
Values will be one of the following: Active, Resolved, Deleted

String

The action taken on the instance of education assignment.
Values will be one of the following: Assign, Delete, Update

String

The date and time the action was taken on the instance of education assignment.
ISO 8601 Format

Array of Objects

The list of assignees associated to the education assignment

String

The learner type assigned.
Example: Patient, Parent, Caregiver

String

The type of content assigned to the learner.
Example: Video, pamphlet, demonstration

String

An indication of how eager the learner is to engage in the education.
Example: Eager, Accepting, Unwilling

String

The response of the learner once the education is complete.
Example: Verbalized understanding, Cannot demonstrate understanding

Array of Strings

Notes about the assignee's assignment