Ciclo de vida de la sesión
Una sesión pasa por varios estados. Los valores siguientes se devuelven tal cual en el campostatus.
Recuperar una sesión
Busque una sesión por suid. El id es el consultationInternalId que usted definió, o el id de la sesión (ss_...) que la API devuelve — en esta respuesta y como scribeSessionId en cada evento de webhook. Ambos resuelven a la misma sesión:
Una sesión creada sin
consultationInternalId — por ejemplo una que un clínico grabó directamente — devuelve consultationInternalId: null. Use el id de la sesión (ss_...) para buscarla. Cada endpoint por sesión acepta cualquiera de los dos id.Listar las sesiones de un paciente
GET /v1/patients/{patient_id}/scribe-sessions devuelve las sesiones de scribe de un paciente, de la más reciente a la más antigua. El {patient_id} puede ser el id público (sp_...) o el internalCode que definiste para tu institución. Pagina con page (base 1) y limit (1–50, por defecto 20).
Cada elemento lleva los mismos campos que una sesión individual de arriba.
total y totalPages cuentan todas las sesiones del paciente y están presentes en todas las páginas. Usa id (ss_...) o consultationInternalId para obtener el registro completo de una sesión desde el endpoint de Documentos de Registro Médico. Devuelve 404 si ningún paciente con ese id es visible para tu clave.Recuperar el registro completo
Este endpoint solo devuelve el ciclo de vida y los metadatos de la consulta. El registro completo —la salida de las plantillas de sesión, con todas las secciones— se obtiene por separado desde el endpoint de documentos de registro médico, usando el mismoconsultationInternalId:
purpose — p.ej. primary para el registro del médico, rpa para inyección en el EMR). Filtre con ?purpose=primary para obtener solo el principal. Vea Documentos de Registro Médico para la forma completa de la respuesta y la referencia de campos.