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 or not.

String

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

String

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

String

Displays the name of the system initiating 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

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

Displays a unique identifier for the patient visit. We highly recommend including a visit number so the document can be associated with a specific visit.

String

Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.

String

Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).

String

Displays the timestamp for the patient visit or the time that the patient arrived for admission.
ISO 8601 Format

Object

Displays the location of the patient visit. This may be used to validate or to identify your application/device.

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

Contains information about all other staff assigned to the assist with the patient visit. Each may be scheduled individually.

String

ID of the Additional staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Additional staff member

String

First name of the Additional staff member

String

Last name of the Additional staff member

Array of Strings

List of credentials for the Additional staff member.
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

Identifies an additional staff member.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Physician, Technologist, etc.

String

Contains the content of the file. This should be a Blob URL if the file is referenced. Otherwise, this contains plain or rich text.
If using data on demand, the plain or rich text is stored as base64 encoded data. It gets decoded when responding to a Notes.Query.

String

Displays the name of the document.

String

Identifies the format of the file (e.g., PDF, JPG). Use this if referencing a file with a Redox Blob URL.
Not supported with data on demand.

String

Contains a descriptive label for the document.
Not supported with data on demand.

DateTime

Displays the time of the clinical service that the document is related to. For example, for a surgical note, this would be the date/time of the surgery.

DateTime

Displays the timestamp for when the document was finalized or created. For example, a surgeon may enter the surgical note contents after the surgery. This timestamp represents the time the note was saved.
For example, a surgeon may enter the surgical note contents following the surgery. This is the field representing the time the note was saved.

String

ID type of the ID for the Provider responsible for the document

String

First name of the Provider responsible for the document

String

Last name of the Provider responsible for the document

Array of Strings

List of credentials for the Provider responsible for the document.
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 provider who authenticated the document.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who authenticated the document

String

First name of the provider who authenticated the document

String

Last name of the provider who authenticated the document

Array of Strings

List of credentials for the provider who authenticated the document.
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 provider who should be notified.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who should be notified

String

First name of the provider who should be notified

String

Last name of the provider who should be notified

Array of Strings

List of credentials for the provider who should be notified.
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

Contains the identifier of the discrete note component. This could be either a report ID or document field ID.
Not supported with data on demand.

String

Displays the name of the discrete note component (e.g., severity).
Not supported with data on demand.

String

Contains the text of the note component, either in plain text or rich text.
Not supported with data on demand.

String

Contains any additional comments for the discrete note field.
Not supported with data on demand.

String

Contains the unique identifier of the order request, which is assigned by the system that placed the order.
Not supported with data on demand.

String

Displays the name of the order, which is assigned by the system that placed the order.
Not supported with data on demand.

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 or not.

String

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

String

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

String

Displays the name of the system initiating 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

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

Displays a unique identifier for the patient visit. We highly recommend including a visit number so the document can be associated with a specific visit.

String

Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.

String

Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).

String

Displays the timestamp for the patient visit or the time that the patient arrived for admission.
ISO 8601 Format

Object

Displays the location of the patient visit. This may be used to validate or to identify your application/device.

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

Contains information about all other staff assigned to the assist with the patient visit. Each may be scheduled individually.

String

ID of the Additional staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Additional staff member

String

First name of the Additional staff member

String

Last name of the Additional staff member

Array of Strings

List of credentials for the Additional staff member.
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

Identifies an additional staff member.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Physician, Technologist, etc.

String

Contains the content of the file. This should be a Blob URL if the file is referenced. Otherwise, this contains plain or rich text.
If using data on demand, the plain or rich text is stored as base64 encoded data. It gets decoded when responding to a Notes.Query.

String

Displays the name of the document.

String

Identifies the format of the file (e.g., PDF, JPG). Use this if referencing a file with a Redox Blob URL.
Not supported with data on demand.

String

Contains a descriptive label for the document.
Not supported with data on demand.

DateTime

Displays the time of the clinical service that the document is related to. For example, for a surgical note, this would be the date/time of the surgery.

DateTime

Displays the timestamp for when the document was finalized or created. For example, a surgeon may enter the surgical note contents after the surgery. This timestamp represents the time the note was saved.
For example, a surgeon may enter the surgical note contents following the surgery. This is the field representing the time the note was saved.

String

ID type of the ID for the Provider responsible for the document

String

First name of the Provider responsible for the document

String

Last name of the Provider responsible for the document

Array of Strings

List of credentials for the Provider responsible for the document.
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 provider who authenticated the document.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who authenticated the document

String

First name of the provider who authenticated the document

String

Last name of the provider who authenticated the document

Array of Strings

List of credentials for the provider who authenticated the document.
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 provider who should be notified.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who should be notified

String

First name of the provider who should be notified

String

Last name of the provider who should be notified

Array of Strings

List of credentials for the provider who should be notified.
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

Contains the identifier of the discrete note component. This could be either a report ID or document field ID.
Not supported with data on demand.

String

Displays the name of the discrete note component (e.g., severity).
Not supported with data on demand.

String

Contains the text of the note component, either in plain text or rich text.
Not supported with data on demand.

String

Contains any additional comments for the discrete note field.
Not supported with data on demand.

String

Contains the unique identifier of the order request, which is assigned by the system that placed the order.
Not supported with data on demand.

String

Displays the name of the order, which is assigned by the system that placed the order.
Not supported with data on demand.

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 or not.

String

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

String

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

String

Displays the name of the system initiating 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

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

Displays a unique identifier for the patient visit. We highly recommend including a visit number so the document can be associated with a specific visit.

String

Contains an identifier that can span several visits often related to the same patient condition (e.g., surgeries, research study, pregnancy). In other words, the account number can be used to link related visits.

String

Classifies the department or type of patient care. Patient class is used in many EHR systems to determine where to put the patient (e.g., inpatient, outpatient, emergency).

String

Displays the timestamp for the patient visit or the time that the patient arrived for admission.
ISO 8601 Format

Object

Displays the location of the patient visit. This may be used to validate or to identify your application/device.

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

Contains information about all other staff assigned to the assist with the patient visit. Each may be scheduled individually.

String

ID of the Additional staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Additional staff member

String

First name of the Additional staff member

String

Last name of the Additional staff member

Array of Strings

List of credentials for the Additional staff member.
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

Identifies an additional staff member.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Physician, Technologist, etc.

String

Displays the name of the document.

String

Identifies the format of the file (e.g., PDF, JPG). Use this if referencing a file with a Redox Blob URL.
Not supported with data on demand.

String

Contains a descriptive label for the document.
Not supported with data on demand.

DateTime

Displays the time of the clinical service that the document is related to. For example, for a surgical note, this would be the date/time of the surgery.

DateTime

Displays the timestamp for when the document was finalized or created. For example, a surgeon may enter the surgical note contents after the surgery. This timestamp represents the time the note was saved.
For example, a surgeon may enter the surgical note contents following the surgery. This is the field representing the time the note was saved.

String

ID type of the ID for the Provider responsible for the document

String

First name of the Provider responsible for the document

String

Last name of the Provider responsible for the document

Array of Strings

List of credentials for the Provider responsible for the document.
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 provider who authenticated the document.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who authenticated the document

String

First name of the provider who authenticated the document

String

Last name of the provider who authenticated the document

Array of Strings

List of credentials for the provider who authenticated the document.
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 provider who should be notified.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who should be notified

String

First name of the provider who should be notified

String

Last name of the provider who should be notified

Array of Strings

List of credentials for the provider who should be notified.
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

Contains the identifier of the discrete note component. This could be either a report ID or document field ID.
Not supported with data on demand.

String

Displays the name of the discrete note component (e.g., severity).
Not supported with data on demand.

String

Contains the text of the note component, either in plain text or rich text.
Not supported with data on demand.

String

Contains any additional comments for the discrete note field.
Not supported with data on demand.

String

Contains the unique identifier of the order request, which is assigned by the system that placed the order.
Not supported with data on demand.

String

Displays the name of the order, which is assigned by the system that placed the order.
Not supported with data on demand.

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 or not.

String

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

String

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

String

Displays the name of the system initiating 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

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

Array of patients to filter results on.
If multiple patients are provided, notes associated with any of the patients will be returned.

Array of Objects

List of IDs and ID types that identify the patient.
If multiple identifiers are provided, only patients with all identifiers will be considered.

String

ID of the Patient

String

ID Type for the corresponding ID of this patient (ie. MRN, EHRID)

Array of Objects

Array of patient visits to query on.
If multiple visits are provided, notes associated with any of the patient visits will be returned.

Array of Objects

Array of document types to query on.
The type of note to retrieve (E.g. Consent Form, Treatment Plan)

Array of Objects

Array of a document identifier to query.

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 or not.

String

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

String

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

String

Displays the name of the system initiating 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

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

ID for the patient