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.

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.

Input	Type	Description
schedulingPolicyId	String	Required. ID of the scheduling policy that determines the service resource and the visit time to assign to the specified service appointment.
serviceAppointmentId	String	Required. ID of the service appointment that’s assigned a service resource for the home visit.

None.

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
} ]