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

Array of Objects

Request log identifiers.

String

ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID

String

ID of request log attempt. Useful in cases where retries are possible.
UUID

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.
(Deprecated. Use Meta.Logs[].ID instead)

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.
(Deprecated. Use Meta.Logs[].ID instead)

String

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

Array of Objects

List of IDs and ID types that identify the patient

String

Patient's first name

String

Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

String

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

String

An indicator if the patient has provided consent.

String

The date in which the consent is effective.

String

An indication if the person has consented to communication for notifications.

String

Number for the appointment or visit in which the vaccine was administered.
Although not required, VisitNumber is highly recommended so that the vaccination can be associated with a specific encounter/visit

String

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

Array of Objects

Array of vaccine administrations

Object

Vaccine that was administered

String

Code set used to identify the vaccine.
CVX or other code set used to identify the product

String

Description of the vaccine

String

Lot number of the vaccine

String

Expiration date of the vaccine.
ISO 8601 Format

Object

Organization that manufactured the vaccine

String

Code for the manufacturer

String

Code set used to identify the manufacturer.
MVX Codeset

String

Name of the manufacturer

Object

Route by which the vaccine was administered

String

Code for the route

String

Code set used to identify the route.
Medication Route FDA Value Set

String

Name of the route

Object

Site where the vaccine was administered

String

Code for the site

String

Code set used to identify the site

String

Name of the site

String

Size of the dose

String

Units of the dose.
UCUM Units of Measure

String

ID of the order in your system

String

ID of the order from the EHR, if the order originated in the EHR

String

NPI of the ordering provider

String

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

String

ID type of the ID for the ordering provider

String

First name of the ordering provider

String

Last name of the ordering provider

Array of Strings

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

String

Department

String

Room.
Example: 136

Array of Objects

List of supplementary information associated with the vaccination administration.

String

Code for the information element

String

Code set used to identify the information element.
LOINC is typically used.

String

Description of the information element

String

Value of the information element

String

Units of the value

Array of Strings

Notes related to the information element.

String

Date and time the clinical info was composed into a report and released.
ISO 8601 Format

String

ID to group separate Clinical Info components

Array of Strings

Notes on the vaccine administration, such as Vaccine Information Statement publication date

String

Reason the vaccination was refused

String

ID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who administered the vaccine

String

First name of the provider who administered the vaccine

String

Last name of the provider who administered the vaccine

Array of Strings

List of credentials for the provider who administered the vaccine.
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

String

Department

String

Room.
Example: 136

Object

Location of the visit in which the vaccine was administered

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

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

Array of Objects

Request log identifiers.

String

ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID

String

ID of request log attempt. Useful in cases where retries are possible.
UUID

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.
(Deprecated. Use Meta.Logs[].ID instead)

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.
(Deprecated. Use Meta.Logs[].ID instead)

String

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

Array of Objects

List of IDs and ID types that identify the patient

String

Patient's first name

String

Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

String

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

String

An indicator if the patient has provided consent.

String

The date in which the consent is effective.

String

An indication if the person has consented to communication for notifications.

String

Number for the appointment or visit in which the vaccine was administered.
Although not required, VisitNumber is highly recommended so that the vaccination can be associated with a specific encounter/visit

String

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

Array of Objects

Array of vaccine administrations

Object

Vaccine that was administered

String

Code set used to identify the vaccine.
CVX or other code set used to identify the product

String

Description of the vaccine

String

Lot number of the vaccine

String

Expiration date of the vaccine.
ISO 8601 Format

Object

Organization that manufactured the vaccine

String

Code for the manufacturer

String

Code set used to identify the manufacturer.
MVX Codeset

String

Name of the manufacturer

Object

Route by which the vaccine was administered

String

Code for the route

String

Code set used to identify the route.
Medication Route FDA Value Set

String

Name of the route

Object

Site where the vaccine was administered

String

Code for the site

String

Code set used to identify the site

String

Name of the site

String

Size of the dose

String

Units of the dose.
UCUM Units of Measure

String

ID of the order in your system

String

ID of the order from the EHR, if the order originated in the EHR

String

NPI of the ordering provider

String

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

String

ID type of the ID for the ordering provider

String

First name of the ordering provider

String

Last name of the ordering provider

Array of Strings

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

String

Department

String

Room.
Example: 136

Array of Objects

List of supplementary information associated with the vaccination administration.

String

Code for the information element

String

Code set used to identify the information element.
LOINC is typically used.

String

Description of the information element

String

Value of the information element

String

Units of the value

Array of Strings

Notes related to the information element.

String

Date and time the clinical info was composed into a report and released.
ISO 8601 Format

String

ID to group separate Clinical Info components

Array of Strings

Notes on the vaccine administration, such as Vaccine Information Statement publication date

String

Reason the vaccination was refused

String

ID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who administered the vaccine

String

First name of the provider who administered the vaccine

String

Last name of the provider who administered the vaccine

Array of Strings

List of credentials for the provider who administered the vaccine.
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

String

Department

String

Room.
Example: 136

Object

Location of the visit in which the vaccine was administered

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

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

Array of Objects

Request log identifiers.

String

ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID

String

ID of request log attempt. Useful in cases where retries are possible.
UUID

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.
(Deprecated. Use Meta.Logs[].ID instead)

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.
(Deprecated. Use Meta.Logs[].ID instead)

String

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

Array of Objects

List of IDs and ID types that identify the patient

String

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

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

Array of Objects

Request log identifiers.

String

ID of a request log that corresponds to this request, used for support and reference within the Redox dashboard.
UUID

String

ID of request log attempt. Useful in cases where retries are possible.
UUID

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.
(Deprecated. Use Meta.Logs[].ID instead)

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.
(Deprecated. Use Meta.Logs[].ID instead)

String

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

Object

In the event a single patient is identified, their demographic information and vaccination history will be included here. PotentialMatches will be an empty array.

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

String

Department

String

Room.
Example: 136

Array of Objects

Array of vaccine administrations

String

When the vaccine was administered, or if documenting a refusal, when the vaccination was refused.
ISO 8601 Format

Object

Vaccine that was administered

String

Code for the vaccine

String

Code set used to identify the vaccine.
CVX or other code set used to identify the product

String

Description of the vaccine

String

Lot number of the vaccine

String

Expiration date of the vaccine.
ISO 8601 Format

Object

Organization that manufactured the vaccine

String

Code for the manufacturer

String

Code set used to identify the manufacturer.
MVX Codeset

String

Name of the manufacturer

Object

Route by which the vaccine was administered

String

Code for the route

String

Code set used to identify the route.
Medication Route FDA Value Set

String

Name of the route

Object

Site where the vaccine was administered

String

Code for the site

String

Code set used to identify the site

String

Name of the site

String

Size of the dose

String

Units of the dose.
UCUM Units of Measure

String

ID of the order in your system

String

ID of the order from the EHR, if the order originated in the EHR

String

NPI of the ordering provider

String

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

String

ID type of the ID for the ordering provider

String

First name of the ordering provider

String

Last name of the ordering provider

Array of Strings

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

String

Department

String

Room.
Example: 136

Array of Objects

List of supplementary information associated with the vaccination administration.

String

Code for the information element

String

Code set used to identify the information element.
LOINC is typically used.

String

Description of the information element

String

Value of the information element

String

Units of the value

Array of Strings

Notes related to the information element.

String

Date and time the clinical info was composed into a report and released.
ISO 8601 Format

String

ID to group separate Clinical Info components

Array of Strings

Notes on the vaccine administration, such as Vaccine Information Statement publication date

String

Reason the vaccination was refused

String

ID of the provider who administered the vaccine.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the provider who administered the vaccine

String

First name of the provider who administered the vaccine

String

Last name of the provider who administered the vaccine

Array of Strings

List of credentials for the provider who administered the vaccine.
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

String

Department

String

Room.
Example: 136

Object

Location of the visit in which the vaccine was administered

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

Array of Objects

In the event a single patient is not identified, this array will contain the possible patient matches and their demographics. You can use these data to make a more specific query to obtain an exact patient match including vaccinations. Patient will be undefined.

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

String

Department

String

Room.
Example: 136