Interface TelehealthConsultResource

Consult id (also the webhook consultId and the embed token subject).

Our id of the patient.

Your id of the patient, when API-provisioned.

The patient's header card — see PatientSummary. Present on reads made with a physician credential; absent on key-only reads.

Current lifecycle state.

Clinical context you supplied at creation — the physician's handoff summary.

Where the patient is (ISO 3166-2 subdivision, no country prefix), as recorded for licensure routing. Absent when never captured.

The patient's locale as it was when this consult was minted — what the live-queue matcher and book rank the physicians against (see ./languages). FROZEN on the row, distinct from patient.lang (the patient's CURRENT setting): the routing truth for THIS consult. Absent on consults minted before the language was recorded.

The physician who took (or is on) the call. Absent until claimed.

The physician's last heartbeat on THIS consult (booked appointments only — the live queue tracks presence on the physician, not the row). How a waiting room knows the clinician is on their way.

When the patient entered the live queue (mode: 'queue'). Cleared once the consult leaves waiting, so it is the honest "waiting since" for a queue display and the source of TelehealthQueueEntry.waitedSeconds.

When the current ring started — a physician was reserved and the patient's client is being asked to confirm. Present while ringing; cleared when the call starts or the ring times out back to waiting.

1-based place in the live queue. Present only while status === 'waiting' on reads made with a physician credential (the same number the patient's /join reports to them).

True when the in-call chat was used — either side sent a message while the room was open. Set once, never cleared; end reads it to decide whether the patient needs telling what their conversation goes back to.

When the consult was created.

When the invite went out (creation time for API-origin consults).

When this consult stops being joinable, for invites that carry a window.

Consults our own conversation flow opens are reachable for 10 minutes — long enough to walk to a quiet room, short enough that a link in a message history is not a standing door. Absent means no window: partner-originated consults are governed by your own authentication instead, and never expire on their own.

Render a join control only while this is in the future. join enforces the same rule server-side (answering status: 'expired'), so a button left on screen is a UI bug rather than a way in — but a button that silently stops working is exactly the thing that reads as broken.

Which live modality this consult is (docs/SCHEDULED-CONSULTS.md): queue — the on-demand waiting room, matched to the first eligible physician who is ready; scheduled — a booked appointment at a fixed time with a named physician. Absent means queue, which is every consult created before scheduled booking existed.

The tenant specialty slug this consult was routed to, if any.

The booked start, for mode: 'scheduled' once a slot has been taken.

The booked end (the consultation, without the tenant's buffer).

The IANA zone the PATIENT booked from — patientTimezone on the booking call, or the device zone of the surface they booked on. Absent when the booking sent none (notices then use the clinic's zone). On an agenda, show the patient's clock from it when it differs from the physician's.

When the call went live (physician joined).

When the call ended.

Short-lived presigned URL of the composite call recording, minted fresh on every GET once the recording exists. Never persist the URL. Omitted in webhook payloads — re-read GET /v1/telehealth-consults/{id} after telehealth.recording_ready.

Machine transcript, once produced (English calls only).

The rating, once submitted. Write-once.

Who opened it — see ConsultOrigin.