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

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

String

Patient's race.
Supported Values

Boolean

Indicates if the patient is of hispanic origin.

String

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

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

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

String

Country

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