For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sessions

List and retrieve provider-owned clinical documentation sessions with lifecycle state and transcript, note, summary, and coding artifact availability.

Sessions represent clinical documentation encounters. Each session tracks a lifecycle status and the availability of its transcript, note, summary, and coding artifacts.

These provider-facing Scribe routes are absent from the Platform API OpenAPI document. The schemas on this page are manual until the separate Scribe contract is published.

Session Object

Field
Type
Description

id

string (uuid)

Unique session identifier

status

string

Session lifecycle status: created, in-progress, in-review, completed, cancelled, or failed

external_appointment_id

string or null

Optional external system appointment identifier (max 512 characters)

started_at

string (datetime) or null

When the session started

ended_at

string (datetime) or null

When the session ended

created_at

string (datetime)

When the session was created

updated_at

string (datetime)

When the session was last updated

artifacts

object

Artifact availability summary

Artifact Availability

The artifacts object reports the availability of each artifact type:

Field
Type
Description

transcript

string

pending, available, or failed

note

string

pending, available, or failed

summary

string

pending, available, or failed

codes

string

pending, available, or failed

List Sessions

Returns a paginated list of sessions owned by the authenticated provider, ordered by creation time (newest first).

Query Parameters

Parameter
Type
Default
Description

limit

integer

50

Number of sessions to return (1-200)

continuation_token

string

null

Opaque token from a previous response to fetch the next page

Response

Field
Type
Description

items

array

List of session objects

has_more

boolean

Whether more sessions are available

continuation_token

string or null

Token to pass as a query parameter to retrieve the next page. Null when there are no more results

Example Request

Example Response

Get Session

Returns a single session owned by the authenticated provider.

Path Parameters

Parameter
Type
Description

workspace_id

string (uuid)

Workspace identifier

session_id

string (uuid)

Session identifier

Response

Returns a session object (see schema above).

Errors

Status
Code
Description

404

not_found

Session does not exist or is not owned by the authenticated provider

Last updated

Was this helpful?