---
schema_version: "1"
id: 2ccb5e29e9d2be01d422995eab40436a122f78220fdabf4f28a68e2308720e26
title: Schedule Home Visit Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/actions_obj_schedule_home_visit.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/actions_obj_schedule_home_visit.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 0c05411a07913e8ea79d174b880b54176edbfd690847d766267cf2fd00d86f2a
description: Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care.
---
# Schedule Home Visit Action

Schedule a home visit for the patient to assess the condition before scheduling the recurring visits for the patient care.

This action is available in API version 58.0 and later.

## Special Access Rules

The Schedule Home Visit action is available in Enterprise and Unlimited Editions with Health Cloud enabled with the Home Health setting.

## Supported REST HTTP Methods

**URI**: /services/data/vXX.X/actions/standard/scheduleHomeVisit

Where XX.X is the latest API version.

**Formats**: JSON, XML

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

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



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d312813e107">Input</th>

              <th class="featureTableHeader  " id="d312813e110">Type</th>

              <th class="featureTableHeader  " id="d312813e113">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d312813e107" data-title="Input"><span class="keyword parmname">schedulingPolicyId</span></td>

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

              <td class="entry" headers="d312813e113" data-title="Description">Required.<p class="p">ID of the scheduling policy that determines the
                  service resource and the visit time to assign to the
                  specified service appointment.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d312813e107" data-title="Input"><span class="keyword parmname">serviceAppointmentId</span></td>

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

              <td class="entry" headers="d312813e113" data-title="Description">Required.<p class="p">ID of the service appointment that’s assigned a service resource for the home
                  visit.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Outputs

None.

## Example

**POST**

This sample request is for the Schedule Home Visit action.

{ 
  "inputs" : \[
    {
      "schedulingPolicyId" : "7sTSG00000001H32AI",
      "serviceAppointmentId" : "08pSG0000000QSLYA2"
    }
  \]
}

This sample response is for the Schedule Home Visit action.

\[ {
  "actionName" : "scheduleHomeVisit",
  "errors" : null,
  "isSuccess" : true,
  "outputValues" : null,
  "version" : 1
} \]