String

Data model. E.g. Scheduling, Results

String

Type of event. E.g. New, Update

DateTime

DateTime of the event. ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated. Included in messages from Redox

String

ID of the source. UUID

String

Name of the source

Array of Objects

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

String

ID of the destination. UUID

String

Name of the destination

String

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

Numeric

ID of the message created in Redox

String

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

Numeric

ID of the transmission created in Redox

String

Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Array of Objects

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

String

Patient's sex. One of the following: Female, Male, Unknown, Other

String

Patient's race. Supported Values

Boolean

Indicates if the patient is of hispanic origin.

String

Patient's marital status. Supported Values

Boolean

Indicates if the patient is deceased

DateTime

Date and Time the patient was proclaimed deceased. ISO 8601 Format

String

Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

Array of Strings

Patient's email address(es)

String

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

Array of strings

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

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

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

Array of strings

Patient-level notes

String

Visit Number. A VisitNumber is highly recommended so that the document can be associated with a specific visit

String

File type of the document. E.g. PDF, JPG

String

Name of the file

String (Base64)

Redox BLOB URI

String

Type of Document. This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)

String

Unique identifier for this document. This ID is required in order to update the document

DateTime

This time represents when this media was created. ISO 8601 Format

DateTime

This time represents a clinical service timestamp with which this media is related. ISO 8601 Format

String

ID of the Provider responsible for the document

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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

String

ID of the provider who authenticated the document. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Whether the document is available. Either: Available or Unavailable

Array of Objects

List of providers that should be notified when this document posts to the patient's chart

String

ID of the provider who should be notified. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Data model. E.g. Scheduling, Results

String

Type of event. Replace

DateTime

DateTime of the event. ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated. Included in messages from Redox

String

ID of the source. UUID

String

Name of the source

Array of Objects

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

String

ID of the destination. UUID

String

Name of the destination

String

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

Numeric

ID of the message created in Redox

String

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

Numeric

ID of the transmission created in Redox

String

Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Array of Objects

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

String

Patient's sex. One of the following: Female, Male, Unknown, Other

String

Patient's race. Supported Values

Boolean

Indicates if the patient is of hispanic origin.

String

Patient's marital status. Supported Values

Boolean

Indicates if the patient is deceased

DateTime

Date and Time the patient was proclaimed deceased. ISO 8601 Format

String

Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

Array of Strings

Patient's email address(es)

String

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

Array of strings

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

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

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

Array of strings

Patient-level notes

String

Visit Number. A VisitNumber is highly recommended so that the document can be associated with a specific visit

String

File type of the document. E.g. PDF, JPG

String

Name of the file

String (Base64)

Redox BLOB URI

String

Type of Document. This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)

String

ID of the document being replaced

String

Unique identifier for this document. This ID is required in order to update the document

DateTime

This time represents when this media was created. ISO 8601 Format

DateTime

This time represents a clinical service timestamp with which this media is related. ISO 8601 Format

String

ID of the Provider responsible for the document

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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

String

ID of the provider who authenticated the document. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Whether the document is available. Either: Available or Unavailable

Array of Objects

List of providers that should be notified when this document posts to the patient's chart

String

ID of the provider who should be notified. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Data model. E.g. Scheduling, Results

String

Type of event. Delete

DateTime

DateTime of the event. ISO 8601 Format

Boolean

Flag as a test message

String

Where the message originated. Included in messages from Redox

String

ID of the source. UUID

String

Name of the source

Array of Objects

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

String

ID of the destination. UUID

String

Name of the destination

String

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

Numeric

ID of the message created in Redox

String

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

Numeric

ID of the transmission created in Redox

String

Code for the facility related to the message. Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative.

Array of Objects

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

String

Patient's sex. One of the following: Female, Male, Unknown, Other

String

Patient's race. Supported Values

Boolean

Indicates if the patient is of hispanic origin.

String

Patient's marital status. Supported Values

Boolean

Indicates if the patient is deceased

DateTime

Date and Time the patient was proclaimed deceased. ISO 8601 Format

String

Patient's home phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Patient's mobile phone number. In E. 164 Format. (e.g. +16085551234)

Array of Strings

Patient's email address(es)

String

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

Array of strings

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

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

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

Array of strings

Patient-level notes

String

Visit Number. A VisitNumber is highly recommended so that the document can be associated with a specific visit

String

File type of the document. E.g. PDF, JPG

String

Name of the file

String

Type of Document. This is the document type the file will be associated with (E.g. Consent Form, Treatment Plan)

String

Unique identifier for this document. This ID is required in order to update the document

DateTime

This time represents when this media was created. ISO 8601 Format

DateTime

This time represents a clinical service timestamp with which this media is related. ISO 8601 Format

String

ID of the Provider responsible for the document

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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

The authenticated status of the document. True or False. If True, Media.Authenticator must be filled out.

String

ID of the provider who authenticated the document. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)

String

Whether the document is available. Either: Available or Unavailable

Array of Objects

List of providers that should be notified when this document posts to the patient's chart

String

ID of the provider who should be notified. This ID is 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

String

Country

Object

Provider's location

String

Type of location. Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility. Example: Community Hospital

String

Department

String

Room. Example: 136

String

Provider's office phone number. In E. 164 Format. (e.g. +16085551234)