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 ID types that identify the patient

String

Patient's first name

String

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

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

Array of Objects

Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service

Additional information about the procedure being scheduled, such as body site.

String

ProcedureInfo description, such as 'Laterality'.

String

ProcedureInfo value, such as 'unilateral left'.

All of the staff assigned to this appointment. Each may be scheduled individually.

String

ID of the Surgery staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Surgery staff member

String

First name of the Surgery staff member

String

Last name of the Surgery staff member

Array of Strings

List of credentials for the Surgery staff member.
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

Object

The role of this person in the surgery.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Surgeon, Anesthesiologist, etc.

DateTime

If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the staff member is scheduled for.
In minutes

Array of Objects

List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

String

Code for the information element

String

Code set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

String

Description of the information element.
For AOEs, this is typically the text of the AOE question

String

The value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.

String

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

String

DateTime of appointment.
ISO 8601 Format

String

Status of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show

Numeric

Length of appointment.
In minutes

String

Patient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency

Array of Strings

Notes about the visit

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending provider.
e.g. MD, PhD

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

Object

Location of the procedure

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

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

Bed.
Example: B

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

Equipment or resources assigned to this appointment. Each may be scheduled individually.

String

Code for the equipment

String

Code set used to identify the equipment.
Codeset will be blank for system-defined codes.

String

Description of the equipment.
Example: X-Ray, Therapy Ball, etc.

DateTime

If the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the equipment is scheduled for.
In minutes

String

Surgery specific identifier

String

Status of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.

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 ID types that identify the patient

String

Patient's first name

String

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

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

Array of Objects

Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service

Additional information about the procedure being scheduled, such as body site.

String

ProcedureInfo description, such as 'Laterality'.

String

ProcedureInfo value, such as 'unilateral left'.

All of the staff assigned to this appointment. Each may be scheduled individually.

String

ID of the Surgery staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Surgery staff member

String

First name of the Surgery staff member

String

Last name of the Surgery staff member

Array of Strings

List of credentials for the Surgery staff member.
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

Object

The role of this person in the surgery.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Surgeon, Anesthesiologist, etc.

DateTime

If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the staff member is scheduled for.
In minutes

Array of Objects

List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

String

Code for the information element

String

Code set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

String

Description of the information element.
For AOEs, this is typically the text of the AOE question

String

The value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.

String

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

String

DateTime of appointment.
ISO 8601 Format

String

Status of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show

Numeric

Length of appointment.
In minutes

String

Patient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency

Array of Strings

Notes about the visit

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending provider.
e.g. MD, PhD

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

Object

Location of the procedure

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

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

Bed.
Example: B

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

Equipment or resources assigned to this appointment. Each may be scheduled individually.

String

Code for the equipment

String

Code set used to identify the equipment.
Codeset will be blank for system-defined codes.

String

Description of the equipment.
Example: X-Ray, Therapy Ball, etc.

DateTime

If the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the equipment is scheduled for.
In minutes

String

Surgery specific identifier

String

Status of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.

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 ID types that identify the patient

String

Patient's first name

String

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

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

Array of Objects

Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service

Additional information about the procedure being scheduled, such as body site.

String

ProcedureInfo description, such as 'Laterality'.

String

ProcedureInfo value, such as 'unilateral left'.

All of the staff assigned to this appointment. Each may be scheduled individually.

String

ID of the Surgery staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Surgery staff member

String

First name of the Surgery staff member

String

Last name of the Surgery staff member

Array of Strings

List of credentials for the Surgery staff member.
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

Object

The role of this person in the surgery.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Surgeon, Anesthesiologist, etc.

DateTime

If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the staff member is scheduled for.
In minutes

Array of Objects

List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

String

Code for the information element

String

Code set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

String

Description of the information element.
For AOEs, this is typically the text of the AOE question

String

The value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.

String

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

String

DateTime of appointment.
ISO 8601 Format

String

Status of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show

Numeric

Length of appointment.
In minutes

String

Patient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency

Array of Strings

Notes about the visit

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending provider.
e.g. MD, PhD

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

Object

Location of the procedure

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

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

Bed.
Example: B

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

Equipment or resources assigned to this appointment. Each may be scheduled individually.

String

Code for the equipment

String

Code set used to identify the equipment.
Codeset will be blank for system-defined codes.

String

Description of the equipment.
Example: X-Ray, Therapy Ball, etc.

DateTime

If the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the equipment is scheduled for.
In minutes

String

Surgery specific identifier

String

Status of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.

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 ID types that identify the patient

String

Patient's first name

String

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

String

Patient's last name

String

Patient's date of birth.
In ISO 8601 format

String

Patient's social security number

Boolean

Indicates if the patient is deceased

DateTime

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

String

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

String

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

String

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

Array of Strings

Patient's email address(es)

Object

Patient's home address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of strings

Patient-level notes

Array of Objects

Array of procedures to be performed. This will typically contain one entry - but there may be more complex procedures involving multiple separate steps.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service

String

DateTime of appointment.
ISO 8601 Format

Additional information about the procedure being scheduled, such as body site.

String

ProcedureInfo description, such as 'Laterality'.

String

ProcedureInfo value, such as 'unilateral left'.

All of the staff assigned to this appointment. Each may be scheduled individually.

String

ID of the Surgery staff member.
This ID is often required for Inpatient Visits.

String

ID type of the ID for the Surgery staff member

String

First name of the Surgery staff member

String

Last name of the Surgery staff member

Array of Strings

List of credentials for the Surgery staff member.
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

Object

The role of this person in the surgery.

String

Code for the service

String

Code set used to identify the service.
Codeset will be blank for system-defined codes.

String

Description of the service.
Example: Primary Surgeon, Anesthesiologist, etc.

DateTime

If this staff member's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the staff member is scheduled for.
In minutes

Array of Objects

List of supplementary clinical information associated with the appointment. These may include answers to Ask at Order Entry (AOE) questions, preference card information, or discrete data points about the patient.

String

Code for the information element

String

Code set used to identify the information element.
Codeset will be blank for system-defined codes. LOINC is used for a subset of AOE questions.

String

Description of the information element.
For AOEs, this is typically the text of the AOE question

String

The value of the corresponding Surgical Info code.
For example, the code will identify the question being answered, and this property will contain the answer.

String

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

String

DateTime of appointment.
ISO 8601 Format

String

Status of the visit.
One of the following: Scheduled, Arrived, Completed, Pending, Canceled, Left without being seen, No show

String

Reason the visit was canceled

Numeric

Length of appointment.
In minutes

String

Patient class will indicate the state of the patient at the time of scheduling.
Examples: Inpatient, Outpatient, Emergency

Array of Strings

Notes about the visit

String

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

String

ID type of the ID for the attending provider

String

First name of the attending provider

String

Last name of the attending provider

Array of Strings

List of credentials for the attending provider.
e.g. MD, PhD

Object

Provider's address

String

Street address

String

City

String

State

String

ZIP

String

County

Array of Strings

Provider's email address(es)

String

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

Object

Provider's location

String

Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone

String

Facility.
Example: Community Hospital

Array of Objects

List of IDs specific to this facility

String

An ID specific to this facility

String

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

String

Department

Array of Objects

List of IDs specific to this department

String

An ID specific to this department

String

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

String

Room.
Example: 136

Object

Location of the procedure

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

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

Bed.
Example: B

Array of Objects

List of diagnoses associated with this visit

String

Code for the diagnosis

String

Name of the diagnosis

String

DateTime the diagnosis was documented.
ISO 8601 Format

Array of Objects

Equipment or resources assigned to this appointment. Each may be scheduled individually.

String

Code for the equipment

String

Code set used to identify the equipment.
Codeset will be blank for system-defined codes.

String

Description of the equipment.
Example: X-Ray, Therapy Ball, etc.

DateTime

If the equipment's schedule is different from the appointment schedule, this is the time that this staff member is scheduled to start work.

Numeric

Length of time that the equipment is scheduled for.
In minutes

String

Surgery specific identifier

String

Status of the surgical case.
This is most often an EHR-specific value, such as 'Procedure started' or 'In Room'.