Campos principales
Identifica al paciente de una de estas tres maneras: con los campos inline (
name, idCountry, idType, idValue), con un patientId existente (sp_...) o con tu propio internalCode. patientId no se puede combinar con la identidad inline ni con internalCode. internalCode se puede enviar solo, para referenciar a un paciente existente, o junto con la identidad inline completa, que crea el paciente y le asigna el código cuando el código es nuevo. Enviar patientId junto con la identidad inline, o una identidad inline incompleta, devuelve un error 400.Documentos aceptados por país
El
idType debe ser válido para el idCountry indicado. Por ejemplo, enviar CC con idCountry: BR devuelve un error 400.Plantillas: envía exactamente una
medicalRecordConfiguration, medicalRecordConfigurationId y scribeSessionConfigurationId son mutuamente excluyentes: envía como máximo uno. Recomendamos la forma inline medicalRecordConfiguration: es reproducible, te permite versionar la plantilla junto con tu código y el servidor elimina duplicados por hash de contenido, así que no se te acumulan copias.
Ejemplo de solicitud — Smart Template inline (recomendado)
Ejemplo de solicitud — Smart Template por id
Ejemplo de solicitud — referenciar un paciente existente
Ejemplo de solicitud — referenciar por internalCode y definir la sede
Contexto clínico
El bloqueclinicalContext envía los datos clínicos que tu sistema ya tiene del paciente: alergias, medicamentos, condiciones, la atención actual (motivo de consulta, triage, signos vitales, diagnósticos, procedimientos y notas) y las atenciones anteriores. Telepatia guarda el bloque en el registro del paciente. La IA lo lee cuando escribe la nota de la sesión, para que la nota incluya los medicamentos, las alergias y los antecedentes correctos.
Envía el bloque en la misma llamada que define el paciente y la consulta. Los demás campos de la solicitud no cambian.
Acceso
- Un bloque con datos clínicos necesita una API key de médico con el permiso
scribe:write. Una key antigua sin el claim de permisos recibe403para ese bloque; regenera la key para obtener ese claim. Un bloque que solo tienecurrentEncounter.idmantiene las reglas de acceso de la llamada. - El bloque funciona para todas las instituciones. No necesita configuración: basta una API key con
scribe:writevinculada a tu institución. - Un bloque que solo tiene
currentEncounter.idno necesita la función. Vincula la sesión a esa atención, como hasta ahora, y no escribe nada en el registro del paciente.
Ejemplo de solicitud — contexto clínico completo
{ "success": true, "consultationInternalId": "CONSULTA-12345" }.
Campos de clinicalContext
Los nombres de campo van en camelCase. Un campo que Telepatia no conoce, dentro de
clinicalContext, devuelve 400: el bloque contiene datos clínicos, así que un nombre de campo incorrecto no debe desaparecer en silencio.
Ítems: alergias, medicamentos, condiciones y diagnósticos
La misma estructura se aplica a las cuatro listas.
Solo
ENTERED_IN_ERROR elimina un diagnóstico del historial de atenciones.
Procedimientos
Un procedimiento es{ "id", "name", "code" } y solo existe dentro de una atención. code es opcional. El procedimiento toma la fecha de su atención. Su status solo acepta ENTERED_IN_ERROR, para eliminar un procedimiento enviado por error.
Atenciones
Los valores por defecto de
class y startedAt solo aplican a la primera escritura de una atención.
Signos vitales
Sistemas de códigos
Un
system desconocido devuelve 400.
Cómo Telepatia aplica el bloque
- Actualizaciones por id. Telepatia escribe cada ítem, atención y procedimiento por su
id. Una llamada posterior con el mismoidlo actualiza. Un ítem que la llamada no envía queda como está. Para eliminar uno, vuelve a enviarlo conENTERED_IN_ERRORoINACTIVE. - Atenciones anteriores. Envía una atención anterior una sola vez, y de nuevo solo cuando cambie.
- La regla del
409.clinicalContextno forma parte de la verificación que devuelve409. Una llamada que repite la misma consulta con unclinicalContextdistinto no genera conflicto. - Orden. Telepatia guarda primero el contexto de la consulta y luego encola la escritura del contexto clínico. La respuesta no espera esa escritura.
- La llamada nunca falla por el contexto clínico. Cuando Telepatia no puede encolar la escritura, la llamada aun así devuelve
200y Telepatia alerta a su equipo interno. El bloque de esa llamada no se guarda. Tu siguiente llamada para la misma atención vuelve a enviar el bloque, así que envía la atención actual en cada llamada. - El paciente del bloque. Telepatia guarda el bloque en el paciente que resuelve la llamada. Un paciente ya guardado (un
patientId, o uninternalCodeque coincide con un paciente) conserva el documento de identidad guardado, incluso cuando la llamada envía otros campos de identidad inline. Si un paciente guardado no tiene documento de identidad, no se escribe el contexto clínico, y la llamada aun así devuelve200. Agrega el documento al paciente para que Telepatia pueda guardar el bloque. - La sesión que lee el bloque. La sesión que el médico inicia en Telepatia después de esta llamada se vincula a
currentEncounter, y su nota lee el bloque. Una sesión que creaPOST /v1/scribe-sessions/audiono se vincula al encuentro, así que su nota no lee el bloque.
Errores
Consulta Errores para ver la estructura completa de la respuesta de error.