Consultas

La llamada de contexto de consulta envía la identidad e información clínica del paciente a Telepatia antes de que comience una sesión. Telepatia utiliza estos datos para pre-cargar el registro del paciente en la interfaz del scribe y vincular la sesión completada de vuelta a su sistema. Llame a este endpoint antes de generar un enlace de inicio de sesión. Si lo omite, la sesión de scribe iniciará sin contexto del paciente.

Campos principales

Campo	Requerido	Descripción
`consultationInternalId`	No	Su ID interno para esta consulta. Si se omite, Telepatia genera uno. Se utiliza para recuperar la sesión después.
`name`	Condicional	Nombre completo del paciente. Requerido a menos que se envíe `patientId`.
`idCountry`	Condicional	País del documento de identidad (ISO alfa-2, alfa-3 o nombre completo). Requerido a menos que se envíe `patientId`.
`idType`	Condicional	Tipo de documento de identidad (ver tabla a continuación). Requerido a menos que se envíe `patientId`.
`idValue`	Condicional	Número del documento. Requerido a menos que se envíe `patientId`.
`patientId`	Condicional	ID público de un paciente existente (`sp_...`, de Pacientes). Úselo en lugar de los campos de identidad inline. Mutuamente excluyente con `name` / `idCountry` / `idType` / `idValue`.
`internalCode`	Condicional	Su propio código de paciente, único por institución. Busca un paciente existente por este código; si el código es nuevo, la identidad inline crea y etiqueta al paciente. Mutuamente excluyente con `patientId`.
`medicalRecordConfiguration`	No	Smart Template inline (recomendado). JSON completo; el servidor deduplica por hash de contenido. Vea Smart Templates.
`medicalRecordConfigurationId`	No	Smart Template por id (de `/v1/medical-record-configurations`).
`scribeSessionConfigurationId`	No	ID de Plantilla de Sesión legada (de `/v1/scribe-session-configurations`).
`scribeSessionModality`	No	Qué tipo de sesión es. `IN_PERSON` o `TELEMEDICINE` para una consulta de Scribe, `DICTATION` para un informe dictado.
`institutionalBranchId`	No	ID de la sede de la institución para esta consulta, devuelto por el endpoint de creación de sede (`POST /v1/institutional/branches`). Se registra en la sesión. Envíe el id o el nombre.
`institutionalBranch`	No	Nombre de la sede de la institución. Se usa cuando `institutionalBranchId` se omite. Envíe el id o el nombre.
`notes`	No	Notas clínicas en texto libre visibles para el médico
`pastMedicalHistory`	No	Historial médico del paciente

Identifique al paciente de una de tres maneras: los campos inline (name, idCountry, idType, idValue), un patientId existente (sp_...), o su 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 y etiqueta al paciente cuando el código es nuevo. Enviar patientId junto con la identidad inline, o una identidad inline incompleta, retorna un error 400.

Documentos aceptados por país

País	`idCountry`	Documento	`idType`	Formato
Colombia	`CO` / `COL` / `COLOMBIA`	Cédula de Ciudadanía	`CC`	5–10 dígitos
Colombia		Tarjeta de Identidad	`TI`	10–11 dígitos
Colombia		Cédula de Extranjería	`CE`	3–7 dígitos
Colombia		Registro Civil	`RC`	1–11 dígitos
Brasil	`BR` / `BRA` / `BRAZIL`	Registro Geral	`RG`	7–9 alfanumérico
Brasil		CPF	`CPF`	XXX.XXX.XXX-XX
Cualquier país	—	Pasaporte	`PASSPORT`	6–9 alfanumérico
Cualquier país	—	Otro	`OTHER_DOC`	Cualquier cadena no vacía

El idType debe ser válido para el idCountry dado. Por ejemplo, enviar CC con idCountry: BR retorna un error 400.

Templates: pase exactamente uno

medicalRecordConfiguration, medicalRecordConfigurationId y scribeSessionConfigurationId son mutuamente excluyentes — pase como máximo uno. Recomendamos la forma inline medicalRecordConfiguration: es reproducible, le permite versionar el template junto a su código, y el servidor deduplica por hash de contenido para que no acumule duplicados.

Ejemplo de solicitud — Smart Template inline (recomendado)

curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
  -H "Authorization: Bearer SU_CLAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "consultationInternalId": "CONSULT-12345",
    "name": "John Doe",
    "idCountry": "CO",
    "idType": "CC",
    "idValue": "123456789",
    "notes": "Paciente reporta dolor de cabeza recurrente",
    "pastMedicalHistory": "Hipertensión diagnosticada en 2020",
    "scribeSessionModality": "IN_PERSON",
    "medicalRecordConfiguration": {
      "chiefComplaint": {
        "instructionSet": { "telepatiaPromptId": "CHIEF_COMPLAINT" },
        "schema": {
          "type": "object",
          "instructions": "Chief complaint",
          "properties": {
            "chiefComplaint": { "type": "string", "instructions": "Patient words" }
          }
        }
      }
    }
  }'

Ejemplo de solicitud — Smart Template por id

curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
  -H "Authorization: Bearer SU_CLAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "consultationInternalId": "CONSULT-12345",
    "name": "John Doe",
    "idCountry": "CO",
    "idType": "CC",
    "idValue": "123456789",
    "scribeSessionModality": "IN_PERSON",
    "medicalRecordConfigurationId": "mrc_a1b2c3d4e5f6g7h8"
  }'

Ejemplo de solicitud — referenciar un paciente existente

curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
  -H "Authorization: Bearer SU_CLAVE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "consultationInternalId": "CONSULT-12345",
    "patientId": "sp_a1b2c3d4e5f6g7h8",
    "scribeSessionModality": "IN_PERSON"
  }'

Ejemplo de solicitud — referenciar por internalCode y definir la sede

curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "consultationInternalId": "CONSULT-12345",
    "internalCode": "MRN-000123",
    "name": "John Doe",
    "idCountry": "CO",
    "idType": "CC",
    "idValue": "123456789",
    "institutionalBranch": "Sede Norte",
    "scribeSessionModality": "IN_PERSON"
  }'

Respuesta:

{
  "success": true,
  "consultationInternalId": "CONSULT-12345"
}

Guarde el consultationInternalId — lo necesitará para generar el enlace de inicio de sesión y recuperar los resultados de la sesión.

Primeros pasos

Conceptos básicos

Cuentas y pacientes

Referencia

Campos principales

Documentos aceptados por país

Templates: pase exactamente uno

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

​Campos principales

​Documentos aceptados por país

​Templates: pase exactamente uno

​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

Campos principales

Documentos aceptados por país

Templates: pase exactamente uno

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