---
schema_version: "1"
id: 5aeb984e0282888c5e07464cc3c47a75409f3e29194d527ebedf2643cf4254ff
title: Book Appointment (POST)
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/connect_resources_appointment_management_book_appointment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_resources_appointment_management_book_appointment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: d81847d17387947f5c78cea7d66e2887c4076e57e5c956be172cdc7c83889b40
description: Create or book a health appointment.
---
# Book Appointment (POST)

Create or book a health appointment.

## Resource

/connect/health/appointment-management/appointment

## Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/health/appointment-management/appointment

## HTTP Methods

POST

## Request Body for POST LS

{
  "startDate": "2013-12-10T09:00:00Z",
  "endDate": "2013-12-10T11:00:00Z",
  "workTypeId": "<workTypeId>",
  "channelId": "<channelId>",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
    "participants": \[
    {
      "reference": "Patient/<patientId>"
    },
    {
      "reference": "Facility/<facilityId>"
    },
    {
      "reference": "Practitioner/<healthcarePractitionerId>",
      "isReferenceRequired": true
    }
  \]
}                        

## Request Body for POST (EHR - External System, Like Cerner, Epic and Others)

{
  "startDate": "2013-12-10T09:00:00Z",
  "endDate": "2013-12-10T11:00:00Z",
  "workTypeId": "<workTypeId>",
  "channelId": "<channelId>",
  "sourceSystem": "cerner",
  "comment": "Further expand on the results of the MRI and determine the next actions that may be appropriate.",
  "appointmentTypes": \[
	"FOLLOWUP"
  \],
  "serviceCategories": \[
    "serviceCategoryCode1",
    "serviceCategoryCode2"
  \],
  "serviceTypes": \[
    "serviceTypeCode1",
    "serviceTypeCode2"
  \],
  "specialties": \[
    "specialityCode"
  \],
  "slots": \[
    {
      "id": "24477854-21304876-62852027-2",
      "reference": "<healthcarePractitionerId>" - matches with the reference of practitioner within participants
    }
  \],
  "participants": \[
    {
      "reference": "Patient/<patientId>"
    },
    {
      "reference": "Facility/<facilityId>"
    },
    {
      "reference": "Practitioner/<healthcarePractitionerId>",
      "isReferenceRequired": true
    }
  \]
}                         

## Request Parameters for POST

<table class="featureTable sort_table" summary="">





          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d609604e112">Parameter Name</th>

              <th class="featureTableHeader vertical-align-top " id="d609604e115">Type</th>

              <th class="featureTableHeader vertical-align-top " id="d609604e118">Description</th>

              <th class="featureTableHeader vertical-align-top " id="d609604e121">Required or Optional</th>

              <th class="featureTableHeader  " id="d609604e124">Available Version</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">appointment​Types</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">Type of the appointment. </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required, if none of the following are provided: <a name="ul_kvh_npw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_kvh_npw_kgc">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceTypes</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceCategories</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">channel​Id</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Engagement channel associated with the work
                type.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">comment​</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Additional text to aid in facilitating the
                appointment.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">endDate</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">End date and time for the slots range.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">participants</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">List of participants involved in the appointment.
                Patient and Facility are required. For single resource
                appointment, include either a <samp class="codeph nolang">Device</samp> (asset) or
                <samp class="codeph nolang">Provider</samp> or
                both for multi-resource appointment.
              </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">service​Categories</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">List of broad categorizations of the service. An
                array of strings. </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required, if none of the following are provided: <a name="ul_szj_lpw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_szj_lpw_kgc">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceTypes</samp></li>

                  <li class="li"><samp class="codeph nolang">appointmentType</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">service​Types</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">List of specific services to be performed. An array
                of strings. </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required, if none of the following are provided: <a name="ul_r2f_jpw_kgc"><!-- --></a>
                <ul class="ul bulletList" id="ul_r2f_jpw_kgc">
                  <li class="li"><samp class="codeph nolang">workTypeId</samp></li>

                  <li class="li"><samp class="codeph nolang">appointmentType</samp></li>

                  <li class="li"><samp class="codeph nolang">serviceCategories</samp></li>

                </ul>
              </td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">slots</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">List of references to the slots the appointment is
                filling. </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required, if the appointment is for an external
                resource.</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">source​System</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Source system associated with the appointment type,
                service type or service category. </td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required, if <samp class="codeph nolang">workTypeId</samp> is not provided but either
                <samp class="codeph nolang">appointmentType</samp>, <samp class="codeph nolang">serviceTypes</samp>, or <samp class="codeph nolang">serviceCategories</samp>
                is.
              </td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">specialties</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">Array</td>

              <td class="entry" headers="d609604e118" data-title="Description">List of the specialties of a practitioner required
                for the service.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">start​Date</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Start date and time for the slots range.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">timeZone</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Timezone in which the appointment is updated.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d609604e112" data-title="Parameter Name"><samp class="codeph nolang">workType​Id</samp></td>

              <td class="entry" headers="d609604e115" data-title="Type">String</td>

              <td class="entry" headers="d609604e118" data-title="Description">Work type associated with the resource.</td>

              <td class="entry" headers="d609604e121" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d609604e124" data-title="Available Version">65.0</td>

            </tr>

          </tbody>

        </table>

## Response Body for POST

[Book Appointment Output](https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_responses_appointment_management.htm "Output representation for appointment management.")