Skip to main content
GET
Listar documentos de prontuário médico

Autorizações

Authorization
string
header
obrigatório

Chave de API enviada como token Bearer

Parâmetros de caminho

id
string
obrigatório

A sessão a buscar — seu consultationInternalId, ou o id da sessão (ss_...) que a API retorna.

Required string length: 1 - 128
Pattern: ^[a-zA-Z0-9_-]+$
Exemplos:

"CONSULT-12345"

"ss_sa98vgqyra91q5b8"

Parâmetros de consulta

purpose
string | null

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

Required string length: 1 - 255
Exemplo:

"primary"

Resposta

Resposta bem-sucedida

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

items
MedicalRecordDocumentItem · object[]
obrigatório

Medical record documents for the session, one per purpose.

total
integer
obrigatório

Total number of medical record documents.