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 or not.

String

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

String

Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID

String

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

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

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 or not.

String

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

String

Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID

String

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

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

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

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

An ID for the document that is common across all document revisions.
When SetID is provided, VersionNumber is required.

Number

An integer version number for this revision of the document.
When SetID is provided, VersionNumber is required. Used when superseding or modifying a prior version of the same document. For example, this document might be VersionNumber 2, and it has a RelatesTo[].VersionNumber 1, the prior version with the same RelatesTo[].SetID.

Array of Objects

The identifiers for other documents related to this document, such as prior versions that this document replaces.

String

An ID for the document that is common across all document revisions.
When SetID is provided, VersionNumber is required.

Number

An integer version number for the related revision of the document.
When SetID is provided, VersionNumber is required.

String

The type of document.
This field is slated to be deprecated in favor of Header.Document.TypeCode.Name

String

A code describing the type of document.
LOINC Document Type

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 (LOINC preferred).
Either CodeSystem or CodeSystemName (preferred) is required when a Code is present.

String

Name of the type of document.
Summarization of Episode Note, Progress Note, etc.

String

A code describing intended disclosure of information contained within the document.
N (Normal), R (Restricted), V (Very Restricted)

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 intended disclosure of information contained within the document

Object

The organization or group responsible for the ongoing maintenance and access to the document

Array of Objects

List of IDs specific to this custodian organization

String

An ID specific to this custodian organization

String

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

The name of the custodian organization

String

A code describing the kind of custodian organization

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 the kind of custodian organization

Array of Objects

Alternate or translation codes for the kind of custodian organization

String

A code describing the kind of custodian organization

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 the kind of custodian organization

Object

The address information for the custodian organization

String

Street address

String

City

String

State

String

ZIP

String

County

String

Use

Phone, fax, email, or other communication numbers for the custodian organization

The phone number or telecommunications address

The purpose of this telecommunications address (e.g. home, work, direct)

The form of this address (e.g. phone, email, fax).
Supported Values

Array of Objects

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's middle name

String

Patient SSN

String

String

String

String

String

String

String

String

String

String

String

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

String

A code describing the patient's race

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 the patient's race

String

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

String

A code describing the patient's ethnicity

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 the patient's ethnicity

Boolean

Indicates if the patient is deceased

DateTime

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

Object

Organization that is the custodian of the patient record

Array of Objects

List of IDs specific to this organization

String

An ID specific to this organization

String

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

The name of the organization

String

A code describing the kind of organization

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 the kind of organization

Array of Objects

Alternate or translation codes for the kind of organization

String

A code describing the kind of organization

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 the kind of organization

Object

The address information for the organization

String

Street address

String

City

String

State

String

ZIP

String

County

String

Use

Phone, fax, email, or other communication numbers for the organization

The phone number or telecommunications address

The purpose of this telecommunications address (e.g. home, work, direct)

The form of this address (e.g. phone, email, fax).
Supported Values

String

ID of the Primary Care Provider for the Patient.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Primary Care Provider for the Patient

String

First name of the Primary Care Provider for the Patient

String

Last name of the Primary Care Provider for the Patient

Array of Strings

List of credentials for the Primary Care Provider for the Patient.
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

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 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 the type of advance directive (such as resuscitation)

Array of Objects

Alternate or translation codes for the type of advance directive (such as resuscitation)

String

A code describing 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 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 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 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 the value of the advance directive (such as 'do not resuscitate')

Array of Objects

Alternate or translation codes for the value of the advance directive (such as 'do not resuscitate')

String

A code describing the value of the advance directive (such as 'do not resuscitate')

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 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 responsible 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 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 the type of allergy intolerance this is (food, drug, etc.)

Array of Objects

Alternate or translation codes for the type of allergy intolerance this is (food, drug, etc.)

String

A code describing 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 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 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 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 the substance that the causes the allergy/intolerance

Array of Objects

Alternate or translation codes for the substance that the causes the allergy/intolerance

String

A code describing the substance that the causes the allergy/intolerance

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 the substance that the causes the allergy/intolerance

Array of Objects

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 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 the reaction caused by the allergy (dizziness, hives ,etc.)

Array of Objects

Alternate or translation codes for the reaction caused by the allergy (dizziness, hives ,etc.)

String

A code describing the reaction caused by the allergy (dizziness, hives ,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 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 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 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 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 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 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 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 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 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 the current status of the allergy (active, historic, etc.)

Boolean

Absent or false for a normal allergy/intolerance; indicates that the allergy/intolerance is explicitly unlikely when true

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.
This field is slated to be deprecated in favor of Comments[].Text

Array of Objects

Free text comments about the allergy.

String

The plain text comment.

String

Free text summary of the patient's current and/or historical care teams.
When sent via Redox API, this can ONLY be pushed as plain text without any markup.

String

Name of the care team

String

Status of the care team

String

A code describing type of care team.
Care Team Category

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 type of care team

Array of Objects

Alternate or translation codes for type of care team

String

A code describing type of care team

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 type of care team

Object

undefined

Array of Objects

List of IDs specific to this organization

String

An ID specific to this organization

String

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

The name of the organization

String

A code describing the kind of organization

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 the kind of organization

Array of Objects

Alternate or translation codes for the kind of organization

String

A code describing the kind of organization

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 the kind of organization

Object

The address information for the organization

String

Street address

String

City

String

State

String

ZIP

String

County

String

Use

Phone, fax, email, or other communication numbers for the organization

The phone number or telecommunications address

The purpose of this telecommunications address (e.g. home, work, direct)

The form of this address (e.g. phone, email, fax).
Supported Values

Object

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

The status of the encounter

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 the type of encounter (office visit, hospital, etc)

Array of Objects

Alternate or translation codes for the type of encounter (office visit, hospital, etc)

String

A code describing the type of encounter (office visit, hospital, 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 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 the type of encounter (office visit, hospital, etc)

DateTime

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

Array of Objects

Members of the care team

String

First name of the care team member

String

Middle name of the care team member

String

Last name of the care team member

String

Credentials of the care team member

Object

Physical address

String

Street address

String

City

String

State

String

ZIP

String

County

String

Use

Array of Objects

Phone, fax, email, or other communication numbers for the care team member

The phone number or telecommunications address

The purpose of this telecommunications address (e.g. home, work, direct)

The form of this address (e.g. phone, email, fax).
Supported Values

String

When the care team member joined the care team.
ISO 8601 Format

String

When the care team member left the care team.
ISO 8601 Format

String

A code describing the roles of the care team member

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 the roles of the care team member

Array of Objects

Alternate or translation codes for the roles of the care team member

String

A code describing the roles of the care team member

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 the roles of the care team member

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

The status of the encounter

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 the type of encounter (office visit, hospital, etc)

Array of Objects

Alternate or translation codes for the type of encounter (office visit, hospital, etc)

String

A code describing the type of encounter (office visit, hospital, 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 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 the type of encounter (office visit, hospital, etc)

DateTime

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

String

NPI of the Encounter Providers

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

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

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 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 the role of the provider (pcp, general physician, etc.)

Array of Objects

Alternate or translation codes for the role of the provider (pcp, general physician, etc.)

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 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 the role of the provider (pcp, general physician, etc.)

Array of Objects

Array of Objects

List of IDs specific to this location

String

An ID specific to this location

String

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

Phone, fax, email, or other communication numbers for the location

The phone number or telecommunications address

The purpose of this telecommunications address (e.g. home, work, direct)

The form of this address (e.g. phone, email, fax).
Supported Values

String

String

String

String

String

String

A code describing the type of location where the patient was seen (clinic, urgent care, hospital).
Healthcare 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 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 the type of location where the patient was seen (clinic, urgent care, hospital)

Array of Objects

Alternate or translation codes for the type of location where the patient was seen (clinic, urgent care, hospital)

String

A code describing the type of location where the patient was seen (clinic, urgent care, hospital)

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 the type of location where the patient was seen (clinic, urgent care, hospital)

String

The name of the location

Array of Objects

An array of diagnoses

ISO Format

The onset date of the diagnosis.
ISO 8601 Format

ISO Format

The resolution date of the diagnosis.
ISO 8601 Format

String

A code describing the current state of the diagnosis (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 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 the current state of the diagnosis (active, inactive, resolved)

Boolean

Absent or false for a normal diagnosis, indicates that the diagnosis is explicitly unlikely when true

String

A code describing the diagnosis.
ICD9, ICD10, HCPC, CPT, 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 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 the diagnosis

Array of Objects

Alternate or translation codes for the diagnosis

String

A code describing the 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 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 the diagnosis

Array of Objects

Free text comments about the diagnosis.

String

The plain text comment.

String

A code describing the reason for the encounter (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 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 the reason for the encounter (usually this is what the patient reports)

Array of Objects

Alternate or translation codes for the reason for the encounter (usually this is what the patient reports)

String

A code describing the reason for the encounter (usually this is what the patient reports)

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 the reason for the encounter (usually this is what the patient reports)

String

A code describing the discharge disposition of the visit.

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 the discharge disposition of the visit.

Array of Objects

Alternate or translation codes for the discharge disposition of the visit.

String

A code describing the discharge disposition of the visit.

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 the discharge disposition of the visit.

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 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 the family member's relationship (father, mother, maternal grandfather, etc.)

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 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 a particular problem experienced by the relative

Array of Objects

Alternate or translation codes for a particular problem experienced by the relative

String

A code describing 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 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 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 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 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 functional status summary

String

Various types of observations about the patient's functional status.

String

A code describing a type of observation (functional status, activities of daily living, sensory status, etc.). .
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 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 a type of observation (functional status, activities of daily living, sensory status, etc.).

Array of Objects

Alternate or translation codes for a type of observation (functional status, activities of daily living, sensory status, etc.).

String

A code describing a type of observation (functional status, activities of daily living, sensory status, 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 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 a type of observation (functional status, activities of daily living, sensory status, etc.).

String

A specific date/time when the value was recorded.
ISO 8601 Format

String

A code describing the individual observation value, if a coded value.
Only populated if the functional status 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 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 the individual observation value, if a coded value.

Array of Objects

Alternate or translation codes for the individual observation value, if a coded value.

String

A code describing the individual observation value, if a coded 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 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 the individual observation value, if a coded value.

String

The measurement recorded for the functional status observation.

String

The units of the measurement.
UCUM Units of Measure

Object

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

Numeric

Lower bound for a normal observation

Numeric

Upper bound for a normal observation

String

The normal value for non-numeric observations

Array of Objects

Free text comments about the observation.

String

The plain text comment.

Array of Objects

Non-medicinal supplies provided to the patient in the context of assessing the patient's physical abilities.

String

A code describing the supplied 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 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 the supplied product

Array of Objects

Alternate or translation codes for the supplied product

String

A code describing the supplied product

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 the supplied product

String

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

ISO Format

The date/time of the activity. .
ISO 8601 Format

String

Free text form of the goals summary

Array of Objects

List of goals or targets for patient care.

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 the patient health goal.

Array of Objects

Alternate or translation codes for the patient health goal.

String

A code describing the patient health goal.

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 the patient health goal.

String

A specific date/time when the goal was recorded.
ISO 8601 Format

String

A code describing the individual goal or target value, if a coded value.
Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in 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 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 the individual goal or target value, if a coded value.

Array of Objects

Alternate or translation codes for the individual goal or target value, if a coded value.

String

A code describing the individual goal or target value, if a coded 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 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 the individual goal or target value, if a coded value.

String

The individual goal or target value.

String

The units of the measurement.
UCUM Units of Measure

String

Start date of goal.

String

Target completion date for goal.

String

A code describing the level of importance associated with the goal.

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 the level of importance associated with the goal.

String

A code describing progression, or lack thereof, towards the goal.

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 progression, or lack thereof, towards the goal.

Array of Objects

List of goals or targets for patient care.

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 the patient health goal.

Array of Objects

Alternate or translation codes for the patient health goal.

String

A code describing the patient health goal.

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 the patient health goal.

String

A specific date/time when the goal was recorded.
ISO 8601 Format

String

A code describing the individual goal or target value, if a coded value.
Only populated if the goal is sent as a coded value. CodedValue.Name will be duplicated in 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 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 the individual goal or target value, if a coded value.

Array of Objects

Alternate or translation codes for the individual goal or target value, if a coded value.

String

A code describing the individual goal or target value, if a coded 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 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 the individual goal or target value, if a coded value.

String

The individual goal or target value.

String

The units of the measurement.
UCUM Units of Measure

String

Start date of goal.

String

Target completion date for goal.

String

A code describing the level of importance associated with the goal.

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 the level of importance associated with the goal.

String

A code describing progression, or lack thereof, towards the goal.

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 progression, or lack thereof, towards the goal.

Array of Objects

Free text comments about the goal.

String

The plain text comment.

String

Free text form of the health concerns 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 health concerns, current and historical.

String

A code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.
Example codes: Condition Category Codes and Observation Category Codes

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 a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

Array of Objects

Alternate or translation codes for a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

String

A code describing a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

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 a code further categorizing the concern; for example, encounter-diagnosis, problem-list-item, or vital-signs.

String

When the health concern was noticed.
ISO 8601 Format

String

When the health concern 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 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 the actual health concern

Array of Objects

Alternate or translation codes for the actual health concern

String

A code describing the actual health concern

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 the actual health concern

Observed value, required if the concern is an observation.

The units of measurement if the concern is an observation.
UCUM Units of Measure

String

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

String

A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

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 the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

Array of Objects

Alternate or translation codes for the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

String

A code describing the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

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 the location on the body; for example, where a vital sign reading was taken or from where a specimen was collected.

String

The current state of the health concern (active, inactive)

Array of Objects

Free text comments about the health concern.

String

The plain text comment.

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 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 the way in which the immunization was delivered (intramuscular, oral, etc.)

Array of Objects

Alternate or translation codes for the way in which the immunization was delivered (intramuscular, oral, etc.)

String

A code describing the way in which the immunization was delivered (intramuscular, oral, 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 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 the way in which the immunization was delivered (intramuscular, oral, etc.)

String

The status of the immunization.

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 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 the vaccination that was given

Array of Objects

Alternate or translation codes for the vaccination that was given

String

A code describing the vaccination that was given

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 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

If this immunization was not administered, this will contain the reason not given. If null, then the immunization was administered normally.
FHIR Immunization Status Reason Codes

Array of Objects

A list of recent administrations of this immunization

String

When the immunization administration was started.
ISO 8601 Format

String

When the immunization administration ended.
ISO 8601 Format

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