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

String

Type of ID.
E.g. MRN, EPI

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

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.

Boolean

Indicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.

Array of Objects

List of IDs and ID types that identify the patient

String

ID for the patient

String

Type of ID.
E.g. MRN, EPI

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

First name of the contact

String

Middle name of the contact

String

Last name of the contact

Object

Address of the contact

String

Street address

String

City

String

State

String

ZIP

String

County

String

Home phone number.
In E. 164 Format. (e.g. +16085551234)

String

Office phone number.
In E. 164 Format. (e.g. +16085551234)

String

Mobile phone number.
In E. 164 Format. (e.g. +16085551234)

Array of string

Email address(es) of the contact person

Array of strings

Role of this contact for the patient.
e.x. Employer, Emergency Contact

Object

Primary Care Provider for the Patient

String

NPI of the PCP

String

ID of the PCP.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the PCP

String

First name of the PCP

String

Last name of the PCP

Array of Strings

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

Person ultimately responsible for the patient's bills

String

Number of the guarantor

String

First name

String

Middle name

String

Last name

String

Guarantor's social security number

String

Guarantor's date of birth.
In ISO 8601 format

String

Spouse's first name

String

Spouse's last name

Object

Address of the guarantor

String

Street address

String

City

String

State

String

ZIP

String

County

String

Home phone number.
In E. 164 Format (i.e. +16085551234)

String

Business phone number.
In E. 164 Format (i.e. +16085551234)

String

Mobile phone number.
In E. 164 Format (i.e. +16085551234)

Array of Strings

Guarantor's email address(es)

String

Type of guarantor.
E.g. institution, individual

String

Employer's name

Object

Employer's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Employer phone number.
In E. 164 Format (i.e. +16085551234)

Array of Objects

List of insurance coverages for the patient

String

Identifier of insurance plan

String

ID type of insurance plan

String

Name of insurance plan

String

Type of insurance plan

String

Patient member number

String

ID of insurance company (payor)

String

ID type of insurance company (payor)

String

Name of insurance company (payor)

Object

Insurance company's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)

String

Insurance policy group number

String

Insurance policy group name

String

Effect date of this insurance policy.
In YYYY-MM-DD format

String

Expiration date of this insurance policy.
In YYYY-MM-DD format

String

Insurance policy number

Object

Individual who has the agreement with the insurance company for the related policy

Array of Objects

List of IDs and ID types that identify the insured

String

ID for the insured

String

Type of ID.
E.g. MRN, EPI

String

Last name of the insured

String

Middle name of the insured

String

First name of the insured

String

Insured's social security number

String

Date of birth of the insured.
In YYYY-MM-DD format

Object

Address of the insured

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Objects

List of IDs and ID types that identify the patient

String

ID for the patient

String

Type of ID.
E.g. MRN, EPI

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

First name of the contact

String

Middle name of the contact

String

Last name of the contact

Object

Address of the contact

String

Street address

String

City

String

State

String

ZIP

String

County

String

Home phone number.
In E. 164 Format. (e.g. +16085551234)

String

Office phone number.
In E. 164 Format. (e.g. +16085551234)

String

Mobile phone number.
In E. 164 Format. (e.g. +16085551234)

Array of string

Email address(es) of the contact person

Array of strings

Role of this contact for the patient.
e.x. Employer, Emergency Contact

Object

Primary Care Provider for the potentially matching patient

String

NPI of the PCP

String

ID of the PCP.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the PCP

String

First name of the PCP

String

Last name of the PCP

Array of Strings

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

Person ultimately responsible for each potentially matching patient's bills

String

Number of the guarantor

String

First name

String

Middle name

String

Last name

String

Guarantor's social security number

String

Guarantor's date of birth.
In ISO 8601 format

String

Spouse's first name

String

Spouse's last name

Object

Address of the guarantor

String

Street address

String

City

String

State

String

ZIP

String

County

String

Home phone number.
In E. 164 Format (i.e. +16085551234)

String

Business phone number.
In E. 164 Format (i.e. +16085551234)

String

Mobile phone number.
In E. 164 Format (i.e. +16085551234)

Array of Strings

Guarantor's email address(es)

String

Type of guarantor.
E.g. institution, individual

String

Employer's name

Object

Employer's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Employer phone number.
In E. 164 Format (i.e. +16085551234)

Array of Objects

List of insurance coverages for each potentially matching patient

String

Identifier of insurance plan

String

ID type of insurance plan

String

Name of insurance plan

String

Type of insurance plan

String

Patient member number

String

ID of insurance company (payor)

String

ID type of insurance company (payor)

String

Name of insurance company (payor)

Object

Insurance company's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)

String

Insurance policy group number

String

Insurance policy group name

String

Effect date of this insurance policy.
In YYYY-MM-DD format

String

Expiration date of this insurance policy.
In YYYY-MM-DD format

String

Insurance policy number

Object

Individual who has the agreement with the insurance company for the related policy

Array of Objects

List of IDs and ID types that identify the insured

String

ID for the insured

String

Type of ID.
E.g. MRN, EPI

String

Last name of the insured

String

Middle name of the insured

String

First name of the insured

String

Insured's social security number

String

Date of birth of the insured.
In YYYY-MM-DD format

Object

Address of the insured

String

Street address

String

City

String

State

String

ZIP

String

County

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

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

The name of the organization

Array of Strings

Name aliases for this organization

Array of objects

An array of IDs and IDTypes to identify this organization

String

The ID for the organization

String

The IDType associated with the ID

Array of objects

Any specified contact information for the organization

String

The contact's role at this organization

String

The contact's full name

Array of strings

The contact's emails

Object

The contact's phone numbers

String

The contact's home number

String

The contact's work number

String

The contact's mobile number

Object

The address information for the organization

String

Street address

String

City

String

State

String

ZIP

String

County