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
Busca una sesión por suid. El id es el consultationInternalId que definiste o el id de la sesión (ss_...) que devuelve la API, tanto en esta respuesta como en scribeSessionId de cada evento de webhook. Ambos apuntan a la misma sesión:
Contexto del EMR
Este endpoint devuelve solo metadatos del ciclo de vida y de la consulta. La historia clínica completada, con los códigos CIE-10 de sus diagnósticos, se obtiene del endpoint de documentos de historia clínica.
Una sesión creada sin
consultationInternalId (por ejemplo, una que un médico grabó directamente) devuelve consultationInternalId: null. Usa el id de la sesión (ss_...) para buscarla. Todos los endpoints asociados a una sesión aceptan 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 tiene los mismos campos de ciclo de vida que la sesión individual de arriba;
emrEncounterId y branch solo se devuelven al recuperar una sesión. 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 la historia clínica completada de una sesión desde el endpoint de documentos de historia clínica. Devuelve 404 si tu API key no tiene visibilidad sobre ningún paciente con ese id.Obtener la historia clínica completada
Este endpoint solo devuelve el ciclo de vida y los metadatos de la consulta. La historia clínica completada (el resultado de las plantillas de sesión, con todas sus secciones) se obtiene por separado desde el endpoint de documentos de historia clínica, usando el mismoconsultationInternalId:
purpose; p. ej., primary para la historia clínica que ve el médico y rpa para la inyección en el EMR). Filtra con ?purpose=primary para obtener solo el principal. Consulta documentos de historia clínica para ver la estructura completa de la respuesta y la referencia de campos.