Book Appointment (POST)

Create or book a health appointment.

Resource

1/connect/health/appointment-management/appointment

Resource Example

1https://yourInstance.salesforce.com/services/data/v66.0/connect/health/appointment-management/appointment

HTTP methods

POST

Request body for POST LS

1{
2  "startDate": "2013-12-10T09:00:00Z",
3  "endDate": "2013-12-10T11:00:00Z",
4  "workTypeId": "<workTypeId>",
5  "channelId": "<channelId>",
6  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
7    "participants": [
8    {
9      "reference": "Patient/<patientId>"
10    },
11    {
12      "reference": "Facility/<facilityId>"
13    },
14    {
15      "reference": "Practitioner/<healthcarePractitionerId>",
16      "isReferenceRequired": true
17    }
18  ]
19}

Request body for POST (EHR - External system, like Cerner, Epic and others)

1{
2  "startDate": "2013-12-10T09:00:00Z",
3  "endDate": "2013-12-10T11:00:00Z",
4  "workTypeId": "<workTypeId>",
5  "channelId": "<channelId>",
6  "sourceSystem": "cerner",
7  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
8  "appointmentTypes": [
9	"FOLLOWUP"
10  ],
11  "serviceCategories": [
12    "serviceCategoryCode1",
13    "serviceCategoryCode2"
14  ],
15  "serviceTypes": [
16    "serviceTypeCode1",
17    "serviceTypeCode2"
18  ],
19  "specialties": [
20    "specialityCode"
21  ],
22  "slots": [
23    {
24      "id": "24477854-21304876-62852027-2",
25      "reference": "<healthcarePractitionerId>" - matches with the reference of practitioner within participants
26    }
27  ],
28  "participants": [
29    {
30      "reference": "Patient/<patientId>"
31    },
32    {
33      "reference": "Facility/<facilityId>"
34    },
35    {
36      "reference": "Practitioner/<healthcarePractitionerId>",
37      "isReferenceRequired": true
38    }
39  ]
40}

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`appointmentTypes`	Array	Type of the appointment.	Required, if none of the following are provided: `workTypeId` `serviceTypes` `serviceCategories`	65.0
`channelId`	String	Engagement channel associated with the work type.	Required	65.0
`comment`	String	Additional text to aid in facilitating the appointment.	Optional	65.0
`endDate`	String	End date and time for the slots range.	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 broad categorizations of the service. An array of strings.	Required, if none of the following are provided: `workTypeId` `serviceTypes` `appointmentType`	65.0
`serviceTypes`	Array	List of specific services to be performed. An array of strings.	Required, if none of the following are provided: `workTypeId` `appointmentType` `serviceCategories`	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	Source system associated with the appointment type, service type or service category.	Required, if `workTypeId` is not provided but either `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 date and time for the slots range.	Required	65.0
`timeZone`	String	Timezone in which the appointment is updated.	Optional	65.0
`workTypeId`	String	Work type associated with the resource.	Required	65.0

Response body for POST

Book Appointment Output

Salesforce Health Cloud Developer Guide

Book Appointment (POST)