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_-]+$
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.