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 IDTypes for the patient

String

ID corresponding to the department from which to retrieved the patient chart.
This field is required for some EHRs.

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.

Object

An object containing metadata about the document being pushed to the destination.

String

ID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Provider responsible for the document

String

The type of provider for this referral.
One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"

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

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

String

An array of identifiers for the patient.

String

If present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.

String

Patient SSN

String

String

String

String

String

String

String

String

String

String

One of the following: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, Other Race'

String

One of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown

String

Supported Values (Display column)

String

String

Free text form of the advance directives summary

Array of Objects

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of advance directive (such as resuscitation)

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the value of the advance directive (such as 'do not resuscitate')

DateTime

Effective end date of the advance directive.
ISO 8601 Format

String

A link to a location where the document can be accessed.

Array of Objects

A collection of people who verified the advance directive with the patient

String

String

String

String

ISO 8601 Format

Array of Objects

People legally resposible for the advance directive document.

String

String

String

String

String

String

String

String

String

Free text form of the allergies summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of Objects

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of allergy intolerance this is (food, drug, etc.)

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the substance that the causes the alergy/intolerance

String

All the reactions caused by this particular substance.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the reaction caused by the allergy (dizziness, hives ,etc.)

String

A code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of a code for the severity of the reaction (moderate, severe, etc.)

String

Free text form of reactions to this substance, includes information that cannot be captured by coded value.

String

A code describing a code for the severity of the reaction (moderate, severe, etc.).
SNOMED CT. Note that when multiple reactions have different severities, the severity at the allergy[] level is generally the highest of all reaction severities. This field is no longer recommended for use, but is preserved for backwards compatibility.

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of a code for the severity of the reaction (moderate, severe, etc.).

String

A code describing a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).
SNOMED CT. Note this is a different concept than reaction severity.

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of a code for representing the gravity of potential risk for future life-threatening reactions (high, low, etc.).

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the current status of the allergy (active, historic, etc.)

String

When the allergy was first noted.
ISO 8601 Format

String

When the allergy was no longer a problem (if applicable).
ISO 8601 Format

String

Free text comment about the allergy.

String

Free text form of the encounters summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of Objects

Array of Objects

List of IDs specific to this encounter

String

An ID specific to this encounter

String

The source or system to which this ID pertains.
Could be an OID or a human-readable name

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of encounter (office visit, hospital, etc)

DateTime

When the encounter was completed, if available.
ISO 8601 Format

String

ID of the Encounter Providers.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Encounter Providers

String

First name of the Encounter Providers

String

Last name of the Encounter Providers

Array of Strings

List of credentials for the Encounter Providers.
e.g. MD, PhD

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

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

String

A code describing the role of the provider (pcp, general physician, etc.)

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the role of the provider (pcp, general physician, etc.)

String

String

String

String

String

String

String

A code describing the type of location where the patient was seen (clinic, urgent care, hostpital).
Heathcare Service Location

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of location where the patient was seen (clinic, urgent care, hostpital)

String

The name of the location

String

List of Diagnoses associated with the visit.
SNOMED CT

String

A code describing the associated diagnosis

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the associated diagnosis

String

A code describing the reason for the visit (usually this is what the patient reports).
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the reason for the visit (usually this is what the patient reports)

String

Free text form of the family history summary

Array of Objects

Each element of the FamilyHistory is one person in the patient's family.

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the family member's relationship (father, mother, maternal grandfather, etc.)

String

String

Date of Birth of the relative.
In YYYY-MM-DD format

Boolean

Whether or not the relative is deceased

String

A list of the relative's relevant health problems

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of a particular problem experienced by the relative

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the general class of the problem. (disease, problem, etc.)

String

The time when the problem started.
ISO 8601 Format

String

The relative's age when the problem started

Boolean

Flag indicating whether or not this problem was the cause of death for the relative.

String

Free text form of the immunization summary

Array of Objects

Array of immunizations for patient.

String

A code describing the way in which the immunization was delivered (intramuscular, oral, etc.).
Medication Route FDA Value Set

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the way in which the immunization was delivered (intramuscular, oral, etc.)

String

Name of organization that manufacture the immunization.
Free text

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the vaccination that was given

String

The lot number of the vaccine

String

The size of the dose

String

The units of the dose.
UCUM Units of Measure

String

Free text form of the patient's insurances.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

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).
Typically not available in ClinicalSummary.

String

ID type of insurance company (payor).
Typically not available in ClinicalSummary.

String

Name of insurance company (payor)

Object

Insurance company's address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

String

Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)

String

Insurance policy group number

String

Insurance policy group name.
Typically not available in ClinicalSummary.

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

String

Type of insurance agreement.
Typically not available in ClinicalSummary.

String

Type of insurance agreement.
One of the following: "Patient", "Clinic", "Insurance", "Other". Indicates who will be receiving the bill for the service.

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

First name of the insured

String

Insured's social security number

String

Relationship of the insured to the patient.
One of the following: "Self", "Spouse", "Other".

String

Date of birth of the insured.
In YYYY-MM-DD format

String

Object

Address of the insured

String

Street address

String

City

String

State

String

ZIP

String

County

String

Country

String

Free text form of the medical equipment summary

String

A list of medical equipment that the patient uses (cane, pacemakers, etc.)

String

When the equipment was first put into use.
ISO 8601 Format

String

The number of products used

String

A code describing the actual product.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the actual product.

String

Free text form of the medications summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of Objects

String

Free text instructions for the medication. Typically instructing patient on the proper means and timing for the use of the medication

String

The size of the dose for pills, capsules, etc.

String

The units of the dose.
UCUM Units of Measure

String

If the medication is in liquid form, the rate at which it is administered

String

Units for the rate.
UCUM Units of Measure

String

A code describing the method by which the medication is delivered.
Medication Route FDA Value Set

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the method by which the medication is delivered

String

When the medication ended.
ISO 8601 Format

String

How often the patient should be taking the medication.
UCUM Units of Measure

String

Units for how often the patient should be taking the medication

Boolean

Whether the medication is to be taken on an as-needed basis

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the actual medication given

String

Free text form of the plan of care summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of Objects

Future lab tests or other diagnostic procedures.

String

A code describing the test to be performed .
LOINC

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the test to be performed

String

The state of the plan (intent, confirmed, etc).
Plan of care status

ISO Format

ISO 8601 Format

Array of Objects

Future procedures.

String

A code describing the planned procedure, such as an appendectomy or hip replacement .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the planned procedure, such as an appendectomy or hip replacement

String

The state of the plan (intent, confirmed, etc).
Plan of care status

ISO Format

ISO 8601 Format

Array of Objects

Appointments and other upcoming encounters

String

A code describing the planned encounter type .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the planned encounter type

String

The state of the plan (intent, confirmed, etc).
Plan of care status

String

ISO 8601 Format

Array of Objects

Planned medication

String

The state of the plan (intent, confirmed, etc).
Plan of care status

String

The size of the dose for pills, capsules, etc.

String

The units of the dose.
UCUM Units of Measure

String

If the medication is not in does form, this is the rate at which is administered

String

Units for the rate.
UCUM Units of Measure

String

A code describing the method by which the medication is to be delivered.
Medication Route FDA Value Set

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the method by which the medication is to be delivered

ISO Format

When the medication was started

ISO Format

When the medication ended

String

How often the patient should be taking the medication.
UCUM Units of measure

String

Units for how often the patient should be taking the medication

String

A code describing the planned medication .
RxNorm

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the planned medication

Array of Objects

Future supplies that a patient may be given, including implants.

String

A code describing the planned product.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the planned product

String

The state of the plan (intent, confirmed, etc).
Plan of care status

ISO Format

The scheduled time of the activity. .
ISO 8601 Format

Array of Objects

Planned activities that are service-oriented in nature, such as a dressing change, or feeding a patient.

String

A code describing the planned activity.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the planned activity.

String

The state of the plan (intent, confirmed, etc).
Plan of care status

ISO Format

The scheduled time of the activity. .
ISO 8601 Format

String

Free text form of the problems summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of Objects

An array of all of patient relevant problems, current and historical.

String

When the problem was noticed.
ISO 8601 Format

String

When the problem stopped (if it is not current).
ISO 8601 Format

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the actual problem

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of problem this is (complaint, diagnosis, symptom, etc.)

String

A code describing the effect of the problem on the patient (chronically ill, in remission, etc.).
SNOMED-CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the effect of the problem on the patient (chronically ill, in remission, etc.)

String

A code describing the current state of the problem (active, inactive, resolved).
HITSPProblemStatus

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the current state of the problem (active, inactive, resolved)

String

Free text form of the procedures summary

A general grouper for all things that CDA considers procedures, grouped into three kinds.

-Observations - procedures which result in new information about a patient.

-Procedures - procedures whose immediate and primary outcome is the alteration of the physical condition of the patient.

-Services (Sometimes called Acts) - procedures which cannot be classified as an observation or a procedure, such as a dressing change, feeding, or teaching.

These are procedures that are more observational in nature, such as an EEG or EKG.

String

A code describing the procedure that was performed. .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the procedure that was performed.

When the procedure was performed.

The status of the procedure.

String

A code describing the location on the body where the procedure was performed.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the location on the body where the procedure was performed

These are procedures that alter the state of the body, such as an appendectomy or hip replacement.

String

A code describing the procedure that was performed. .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the procedure that was performed.

When the procedure was performed.

The status of the procedure.

String

A code describing the location on the body where the procedure was performed.
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the location on the body where the procedure was performed

These are procedures that are service-oriented in nature, such as a dressing change, or feeding a patient.

String

A code describing the procedure that was performed. .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the procedure that was performed.

When the procedure was performed.

The status of the procedure.

String

Free text form of the results summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

Array of test results for the patient. This can include laboratory results, imaging results, and procedure results.

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the test performed and resulted.

Array of Object

A list of corresponding observations for the test (result components)

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the individual result component.

String

A flag indicating whether or not the observed value is normal, high, or low.
Supported Values

String

A code describing the individual result value.
Only populated if the result is sent as a coded value. Observations[].CodedValue.Name will be duplicated in Observations[].Value

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the individual result value.

String

The type and format of the value.
One of the following: PhysicalQuantity, String, Number, Interval, Ratio, Code. Intervals will be represented in Value as low-high, <low, <=low, >high, or >=high. Ratios will be represented in Value as numerator:denominator.

Object

Reference range for the result.
Numeric result values will use the low and high properties. Non-numeric result values will put the normal value in the text property.

Numeric

Lower bound for a normal result

Numeric

Upper bound for a normal result

String

The normal value for non-numeric results

String

Free text form of the social history summary

String

Generic observations about the patient's social hisotry that don't fall into the smoking or pregnancy categories.

String

A code describing a type of social history observation (exercise, alcohol intake, etc.) .
SNOMED CT

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of a type of social history observation (exercise, alcohol intake, etc.)

Object

The observed value

String

A code describing the observed value, if coded

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the observed value, if coded

String

The observed value, if uncoded

String

Start date of status

String

Date status ended. If this is null, the status is current.

String

Information about past and current pregnancies.

String

When the pregnancy started.
ISO 8601 Format

String

When the pregnancy ended.
ISO 8601 Format

String

Estimate delivery date if pregnancy is still active.

String

Contains tobacco use and smoking status observations

String

A code describing the use of tobacco (current smoker, never smoker, snuff user, etc.).
Contains all values descending from the SNOMED CT® 365980008 tobacco use and exposure - finding hierarchy

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the use of tobacco (current smoker, never smoker, snuff user, etc.)

Boolean

Identifies this tobacco use entry as a smoking status.
If true, StartDate is the date the smoking status was observed.

String

Start date of status.
If IsSmokingStatus is true, this is the date the observation was made.

String

Date status ended. If this is null, the status is current.

String

Free text form of the vital signs summary.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

String

An array of groups of vital signs.

String

The date and time of the group of readings.
This field is deprecated since vital readings are not necessarily always grouped by time. Instead, the Observations[].DateTime tells when an individual reading took place.

String

An array of individual vital sign Observations[].

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of vital sign being read (height, weight, blood pressure, etc.)

String

A flag indicating whether or not the observed value is normal, high, or low.
Supported Values

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.

The sender's Direct address, if one or both sides are using Direct messaging.

The recipient's Direct address, if one or both sides are using Direct messaging.

Object

An object containing metadata about the document being pushed to the destination.

String

ID of the Provider responsible for the document.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Provider responsible for the document

String

The type of provider for this referral.
One of the following: "Referring Provider", "Referred To Provider", "Other", "Patient PCP"

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

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

String

An array of identifiers for the patient.

String

If present, contains the same value as IDType. Provided for backwards compatibility with earlier versions of the API.

String

Patient SSN

String

String

String

String

String

String

String

String

String

String

One of the following: American Indian or Alaska Native, Asian, Black or African American, Native Hawaiian or Other Pacific Islander, White, Other Race'

String

One of the following: Hispanic or latino, Not hispanic or latino, Refused to report, Unknown

String

Supported Values (Display column)

String

Note - visit fields are unlikely in PatientPush. The VisitPush event type should be used instead.

Object

If the document is tied to a visit, this is the location of the visit.

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

If the document is tied to a visit, this is the start date/time of the visit.
ISO 8601 Format

String

If the document is tied to a visit, this is the end date/time of the visit.
ISO 8601 Format

String

If the document is tied to a visit, this is the the reason for visit.

Array of Objects

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of advance directive (such as resuscitation)

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 belogs (e.g. SNOMED CT, LOINC, RxNorm, CVX, ICD9, ICD10).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the value of the advance directive (such as 'do not resuscitate')

DateTime

Effective end date of the advance directive.
ISO 8601 Format

String

A link to a location where the document can be accessed.

Array of Objects

A collection of people who verified the advance directive with the patient

String

String