Elevate Visit to Synchronous

The Elevate Visit Type endpoint allows affiliate administrators to convert asynchronous visits to synchronous (video) visits. When the videoRequested flag is included, the system will automatically trigger video consultation scheduling for the patient.

How It Works

  1. Visit Type Conversion: Converts asynchronous visits to synchronous visits
  2. Video Consultation Trigger: If videoRequested: true is included, the system creates an event that triggers video consultation scheduling
  3. Patient Notification: Patient receives video consultation scheduling invite.

Prerequisites

  • Order must contain asynchronous visits
  • Order status must be in an allowable state for visit elevation
  • User must have affiliate admin permissions

Allowable Order Statuses

  • requires_waiting_room_egress
  • requires_scheduling
  • requires_prerequisite_completion
  • requires_provider_review
  • requires_affiliate_review

Error Handling

Error ConditionHTTP StatusResponse
Order not found404{"error": "Order not found"}
No async visits409{"error": "Order visits is already synchronous"}
Invalid order status409{"error": "Order visits can't be updated to synchronous in [status] status"}
Permission denied403{"error": "Insufficient permissions"}

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!