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.

String

Contains the information for the system originating the message, including the source ID and name.
Included in messages from Redox

String

Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
UUID

String

Displays the name of the system that originates 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

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

Numeric

Identifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

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

Numeric

Identifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. 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

Identifiers for the study. Should include both internal and external identifiers (such as an NCT ID)

String

String

String

Official title of the study

Object

The sponsor of the study

String

Identifier for the sponsor of the study, if applicable

String

String representation of the sponsor name

String

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

String

ID type of the ID for the provider

String

First name of the provider

String

Last name of the provider

Array of Strings

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

String

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

String

ID type of the ID for the provider

String

First name of the undefined

String

Last name of the undefined

Array of Strings

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

Full description of the study

String

What state the study is currently in. Drawn from the clinicaltrials.gov "Overall Recruitment Statuses".
Not yet recruiting: Participants are not yet being recruited Recruiting: Participants are currently being recruited, whether or not any participants have yet been enrolled Enrolling by invitation: Participants are being (or will be) selected from a predetermined population Active, not recruiting: Study is continuing, meaning participants are receiving an intervention or being examined, but new participants are not currently being recruited or enrolled Completed: The study has concluded normally; participants are no longer receiving an intervention or being examined (that is, last participant’s last visit has occurred) Suspended: Study halted prematurely but potentially will resume Terminated: Study halted prematurely and will not resume; participants are no longer being examined or receiving intervention Withdrawn: Study halted prematurely, prior to enrollment of first participant

DateTime

The estimated date on which the clinical study will be open for recruitment of participants.

String

A code describing conditions applicable to the study

String

ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of conditions applicable to the study

Array of Objects

Alternate or translation codes for conditions applicable to the study

String

A code describing conditions applicable to the study

String

ID of the coding system to which the code belongs in OID format.
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Coding system to which the code belongs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of conditions applicable to the study

Object

Information about how the trial will run.

Object

The objective of the study.
Treatment: One or more interventions are being evaluated for treating a disease, syndrome, or condition. Prevention: One or more interventions are being assessed for preventing the development of a specific disease or health condition. Diagnostic: One or more interventions are being evaluated for identifying a disease or health condition. Supportive Care: One or more interventions are evaluated for maximizing comfort, minimizing side effects, or mitigating against a decline in the participant's health or function. Screening: One or more interventions are assessed or examined for identifying a condition, or risk factors for a condition, in people who are not yet known to have the condition or risk factor. Health Services Research: One or more interventions for evaluating the delivery, processes, management, organization, or financing of healthcare. Basic Science: One or more interventions for examining the basic mechanism of action (for example, physiology or biomechanics of an intervention). Device Feasibility: An intervention of a device product is being evaluated in a small clinical trial (generally fewer than 10 participants) to determine the feasibility of the product; or a clinical trial to test a prototype device for feasibility and not health outcomes. Such studies are conducted to confirm the design and operating specifications of a device before beginning a full clinical trial. Other: None of the other options applies.

Object

For studies of drug products, the numerical phase of the study.
N/A: Trials without phases (for example, studies of devices or behavioral interventions). Early Phase 1 (Formerly listed as "Phase 0"): Exploratory trials, involving very limited human exposure, with no therapeutic or diagnostic intent (e.g., screening studies, microdose studies). See FDA guidance on exploratory IND studies for more information. Phase 1: Includes initial studies to determine the metabolism and pharmacologic actions of drugs in humans, the side effects associated with increasing doses, and to gain early evidence of effectiveness; may include healthy participants and/or patients. Phase 1/Phase 2: Trials that are a combination of phases 1 and 2. Phase 2: Includes controlled clinical studies conducted to evaluate the effectiveness of the drug for a particular indication or indications in participants with the disease or condition under study and to determine the common short-term side effects and risks. Phase 2/Phase 3: Trials that are a combination of phases 2 and 3. Phase 3: Includes trials conducted after preliminary evidence suggesting effectiveness of the drug has been obtained, and are intended to gather additional information to evaluate the overall benefit-risk relationship of the drug. Phase 4: Studies of FDA-approved drugs to delineate additional information including the drug's risks, benefits, and optimal use.

Object

Rules about individuals eligible to participate in the study.

String

The gender of the participants eligible to participate in the clinical study.
All, Male, or Female

Numeric

Minimum age a potential participant must meet to be eligible for the clinical study.

Numeric

Maximum age a potential participant must meet to be eligible for the clinical study.

Object

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

Physical address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Objects

Each protocol represents a sequence of events that will be assigned to a group of patients participating in the study.

String

The identifier for the protocol.

String

The identifier type for the protocol.

String

The unique name for the protocol.

Array of Objects

Each cycle represents a grouping of days within the protocol.

String

The identifier for the cycle.

String

The identifier type for the cycle.

String

The unique name for the cycle.

String

The date the cycle begins.
ISO 8601 Format

String

The date the cycle ends.
ISO 8601 Format

Array of Objects

Each day represents a patient's visit related to the study protocol.

String

The identifier for this day.

String

The identifier type for the day.

String

The unique name for the day.

String

The activity date.
ISO 8601 Format

String

The earliest date in which the activity can be scheduled.
ISO 8601 Format

String

The latest date in which the activity can be scheduled.
ISO 8601 Format

Array of Objects

A list of procedures that are related to the study day.

String

The identifier for the procedure.

String

Identifiers for the protocol this patient should be enrolled in.

String

The description of the procedure.

Array of Strings

List of modifiers for this procedure

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.

String

Contains the information for the system originating the message, including the source ID and name.
Included in messages from Redox

String

Identifies the system that originates the message. If you're using OAuth keys, this value is required; if you're using legacy API keys, this value is optional since legacy keys are specific to a given originating system.
UUID

String

Displays the name of the system that originates 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

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

Numeric

Identifies the numeric value of the message created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. Use Meta.Logs[].ID instead).

String

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

Numeric

Identifies the numeric value of the transmission created in Redox.
(Deprecated. Slated for removal on or after Apr. 30, 2023. 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.

DateTime

Start of participation in the study, or consent date.

DateTime

End of participation in the study.

String

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

String

ID type of the ID for the provider

String

First name of the undefined

String

Last name of the undefined

Array of Strings

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

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

Array of Objects

Identifiers for the study this patient should be enrolled in.

String

String

String