A scribe session is created when a clinician conducts a consultation through the Telepatia interface. Once the session is finished, you can check its lifecycle and consultation metadata here, then fetch the filled record from the Medical Record Documents endpoint.
Session lifecycle
A session moves through several states. The values below are returned verbatim in the status field.
Retrieving a session
Use the consultationInternalId you provided (or received) when setting the consultation context:
Response:
This endpoint returns lifecycle and consultation metadata only. The filled record — and its diagnosis ICD codes — is fetched from the Medical Record Documents endpoint.
While status is still in-flight (created, recording, stopped, processing), poll this endpoint until it reaches a ready state (completed, completedWithErrors, reviewed) before fetching the filled record. error and cancelled are terminal failure states — no documents will be produced.
Retrieving the filled record
This endpoint returns only the session’s lifecycle and consultation metadata. The actual filled record — the output of the session templates, with all sections — is fetched separately from the medical record documents endpoint, using the same consultationInternalId:
A session can produce more than one document (one per purpose — e.g. primary for the clinician-facing record, rpa for EMR injection). Filter with ?purpose=primary to fetch only the main one. See Medical Record Documents for the full response shape and field reference.