Skip to main content
GET
Consultar sesión de Scribe

Autorizaciones

Authorization
string
header
requerido

Clave API enviada como token Bearer

Parámetros de ruta

id
string
requerido

La sesión a buscar — su consultationInternalId, o el id de la sesión (ss_...) que la API devuelve.

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

"CONSULT-12345"

"ss_sa98vgqyra91q5b8"

Respuesta

Respuesta exitosa

Cuerpo de respuesta para la consulta de sesión de scribe.

id
string
requerido
Maximum string length: 255
Ejemplo:

"ss_a1b2c3d4e5f6g7h8"

status
string
requerido
Maximum string length: 255
Ejemplo:

"completed"

createdAt
string<date-time> | null
Ejemplo:

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

completedAt
string<date-time> | null
Ejemplo:

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

patientName
string | null
Maximum string length: 255
Ejemplo:

"John Doe"

scribeSessionModality
string | null

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

Ejemplo:

"IN_PERSON"

consultationInternalId
string | null

The consultation ID provided by the API consumer.

Ejemplo:

"CONSULT-12345"

specialty
string | null

The medical specialty of the clinician who conducted the session.

Ejemplo:

"Cardiology"