Skip to main content
GET
List Medical Record Documents

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Path Parameters

id
string
required

The session to look up — either your consultationInternalId, or the session id (ss_...) the API returns.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-][A-Za-z0-9._-]{0,127}$
Examples:

"CONSULT-12345"

"ss_sa98vgqyra91q5b8"

Query Parameters

purpose
string | null

Optional filter — return only documents with this purpose. Use 'report' to get only the dictated reports.

Required string length: 1 - 255
Example:

"primary"

Response

Successful Response

Response body for listing a scribe session's medical record documents.

items
MedicalRecordDocumentItem · object[]
required

Medical record documents for the session, one per purpose.

total
integer
required

Total number of medical record documents.

transcript
SessionTranscript · object | null

The transcript of the session, the same for every item. Null in five cases. Temporary: the session has no transcript yet (read again after the session completes); a read error (request again); the stored text still holds masked patient identifiers because the identifier store did not answer (request again later). Can stay null: the stored transcript is older than the current one of the session. Permanent: the institution's retention policy deleted it.