put
https://{telegra.url}/orders//actions/elevateVisitType
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
- Visit Type Conversion: Converts asynchronous visits to synchronous visits
- Video Consultation Trigger: If
videoRequested: trueis included, the system creates an event that triggers video consultation scheduling - 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_egressrequires_schedulingrequires_prerequisite_completionrequires_provider_reviewrequires_affiliate_review
Error Handling
| Error Condition | HTTP Status | Response |
|---|---|---|
| Order not found | 404 | {"error": "Order not found"} |
| No async visits | 409 | {"error": "Order visits is already synchronous"} |
| Invalid order status | 409 | {"error": "Order visits can't be updated to synchronous in [status] status"} |
| Permission denied | 403 | {"error": "Insufficient permissions"} |
