Skip to main content
GET
Buscar sessão de Scribe

Autorizações

Authorization
string
header
obrigatório

Chave de API enviada como token Bearer

Parâmetros de caminho

id
string
obrigatório

O ID interno da consulta para busca

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

"CONSULT-12345"

Resposta

Resposta bem-sucedida

Corpo da resposta da busca de sessão de scribe.

id
string
obrigatório
Maximum string length: 255
Exemplo:

"ss_a1b2c3d4e5f6g7h8"

status
string
obrigatório
Maximum string length: 255
Exemplo:

"completed"

createdAt
string<date-time> | null
Exemplo:

"2026-02-20T10:00:00Z"

completedAt
string<date-time> | null
Exemplo:

"2026-02-20T10:30:00Z"

patientName
string | null
Maximum string length: 255
Exemplo:

"John Doe"

scribeSessionModality
string | null

The modality of the scribe session (e.g. 'IN_PERSON', 'TELEMEDICINE').

Exemplo:

"IN_PERSON"

consultationInternalId
string | null

The consultation ID provided by the API consumer.

Exemplo:

"CONSULT-12345"

specialty
string | null

The medical specialty of the clinician who conducted the session.

Exemplo:

"Cardiology"