| appointmentTypes |
Array |
Type of appointment, such as Follow up. |
Required, if none of the following are provided:
- workTypeId
- serviceTypes
- serviceCategories
|
65.0 |
| channelId |
String |
Engagement channel associated with the appointment, such as In person or video. |
Required if an engagement channel is configured for a visit type. |
65.0 |
| comment |
String |
Additional text to aid in facilitating the
appointment. |
Optional |
65.0 |
| endDate |
String |
End time of the appointment. |
Required |
65.0 |
| id |
String |
ID of the appointment. |
Required |
65.0 |
| participants |
Array |
List of participants involved in the appointment.
Patient and Facility are required. For single resource
appointment, include either a Device (asset) or
Provider or
both for multi-resource appointment. |
Required |
65.0 |
| serviceCategories |
Array |
List of categories of service to include. |
Required, if none of the following are provided:
- workTypeId
- serviceTypes
- appointmentType
|
65.0 |
| serviceTypes |
Array |
List of specific services to include. |
Required, if none of the following are provided:
- workTypeId
- serviceCategories
- appointmentType
|
65.0 |
| slots |
Array |
List of references to the slots the appointment is
filling. |
Required, if the appointment is for an external
resource. |
65.0 |
| sourceSystem |
String |
External system defined in Salesforce, such as
cerner . |
Required, if workTypeId is not provided but one of appointmentType, serviceTypes, or serviceCategories is. |
65.0 |
| specialties |
Array |
List of the specialties of a practitioner required for the service. |
Optional |
65.0 |
| startDate |
String |
Start time of the appointment. |
Required |
65.0 |
| timeZone |
String |
Timezone in which the appointment is updated. |
Optional |
65.0 |
| workTypeId |
String |
Visit type associated with the appointment. |
Required, if none of the following are provided:
- appointmentType
- serviceTypes
- serviceCategories
|
65.0 |
j