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

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

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

List of a patient's allergies

String

Code for the allergy

String

Code set used to identify the allergy.
Typically RxNorm or SNOMED

String

Name of the allergy

Object

The type of allergy intolerance (food, drug, etc.)

String

Code for the allergy intolerance type

String

Code set used to identify the allergy intolerance type

String

Name of the allergy intolerance type

String

DateTime the allergy was identified

Array of Objects

The list of reactions caused by this particular allergy.

String

Code for the reaction

String

Code set used to identify the reaction

String

Name of the reaction

Object

The severity of the reaction (moderate, severe, etc.).

String

Code for the reaction severity

String

Code set used to identify the reaction severity

String

Name of the reaction severity

string

The current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".

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

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 admission.
ISO 8601 Format

Numeric

Length of visit.
In minutes

String

Reason for visit

Array of Strings

Appointment instructions

Numeric

Patient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.

Numeric

Diagnosis Related Group for this visit

Numeric

Type or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc

Object

The provider primarily responsible for a patient's care during a visit

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

Object

A provider, usually a specialist, that evaluates or treats a patient to address a specific problem

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

Object

The provider that requested a patient to see a consulting 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

The MD/DO that made the decision to admit the patient. Not always the same as attending provider

String

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

String

ID type of the ID for the admitting provider

String

First name of the admitting provider

String

Last name of the admitting provider

Array of Strings

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

All of the staff assigned to this appointment. 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

The role of this person in the appointment.

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.

Object

Location of the appointment

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

Object

Address of the appointment location

String

Street address

String

City

String

State

String

ZIP

String

County

Object

Person ultimately responsible for the bill of the appointment

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

DateTime

Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
DateTime of the cancellation

String

Type of event being canceled.
E.g. Arrival, Discharge, PreAdmit

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

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

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

List of a patient's allergies

String

Code for the allergy

String

Code set used to identify the allergy.
Typically RxNorm or SNOMED

String

Name of the allergy

Object

The type of allergy intolerance (food, drug, etc.)

String

Code for the allergy intolerance type

String

Code set used to identify the allergy intolerance type

String

Name of the allergy intolerance type

String

DateTime the allergy was identified

Array of Objects

The list of reactions caused by this particular allergy.

String

Code for the reaction

String

Code set used to identify the reaction

String

Name of the reaction

Object

The severity of the reaction (moderate, severe, etc.).

String

Code for the reaction severity

String

Code set used to identify the reaction severity

String

Name of the reaction severity

string

The current status of the allergy.
One of the following: "Active", "Inactive", "Resolved".

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

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 admission.
ISO 8601 Format

Numeric

Length of visit.
In minutes

String

Reason for visit

Array of Strings

Appointment instructions

Numeric

Patient balance due for this visit.
This field depends on whether or not the sending system has billing functionality, and whether they calculate this field.

Numeric

Diagnosis Related Group for this visit

Numeric

Type or System of Diagnosis Related Group for this visit.
Examples include Medicare (CMS-DRG), Refined (R-D DRG), All Patient (AP-DRG), etc

Object

The provider primarily responsible for a patient's care during a visit

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

Object

A provider, usually a specialist, that evaluates or treats a patient to address a specific problem

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

Object

The provider that requested a patient to see a consulting 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

The MD/DO that made the decision to admit the patient. Not always the same as attending provider

String

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

String

ID type of the ID for the admitting provider

String

First name of the admitting provider

String

Last name of the admitting provider

Array of Strings

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

All of the staff assigned to this appointment. 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

The role of this person in the appointment.

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.

Object

Location of the appointment

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

Object

Address of the appointment location

String

Street address

String

City

String

State

String

ZIP

String

County

Object

Person ultimately responsible for the bill of the appointment

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