A chamada de contexto de consulta envia a identidade e informações clínicas do paciente pra Telepatia antes de uma sessão começar. A Telepatia usa esses dados pra pré-preencher o registro do paciente na interface do scribe e vincular a sessão concluída de volta ao seu sistema.
Chame esse endpoint antes de gerar um link de login. Se omitir, a sessão de scribe iniciará sem contexto do paciente.
Campos principais
| Campo | Obrigatório | Descrição |
|---|
consultationInternalId | Não | Seu ID interno pra essa consulta. Se omitido, a Telepatia gera um. Usado pra recuperar a sessão depois. |
name | Sim | Nome completo do paciente |
idCountry | Sim | País do documento de identidade (ISO alfa-2, alfa-3 ou nome completo) |
idType | Sim | Tipo de documento de identidade (veja tabela abaixo) |
idValue | Sim | Número do documento |
medicalRecordConfiguration | Não | Smart Template inline (recomendado). JSON completo; o servidor deduplica por hash de conteúdo. Veja Smart Templates. |
medicalRecordConfigurationId | Não | Smart Template por id (de /v1/medical-record-configurations). |
scribeSessionConfigurationId | Não | ID de Template de Sessão legado (de /v1/scribe-session-configurations). |
scribeSessionModality | Não | IN_PERSON ou REMOTE |
notes | Não | Notas clínicas em texto livre visíveis pro médico |
pastMedicalHistory | Não | Histórico médico do paciente |
Documentos aceitos por país
| País | idCountry | Documento | idType | Formato |
|---|
| Colômbia | CO / COL / COLOMBIA | Cédula de Ciudadanía | CC | 8–10 dígitos |
| Colômbia | | Tarjeta de Identidad | TI | 10–11 dígitos |
| Colômbia | | Cédula de Extranjería | CE | 6–7 dígitos |
| Colômbia | | 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 |
| Qualquer país | — | Passaporte | PASSPORT | 6–9 alfanumérico |
| Qualquer país | — | Outro | OTHER_DOC | Qualquer string não vazia |
O idType precisa ser válido pro idCountry informado. Por exemplo, enviar CC com idCountry: BR retorna um erro 400.
Templates: passe exatamente um
medicalRecordConfiguration, medicalRecordConfigurationId e scribeSessionConfigurationId são mutuamente exclusivos — passe no máximo um. Recomendamos a forma inline medicalRecordConfiguration: é reproduzível, permite versionar o template junto com o seu código, e o servidor deduplica por hash de conteúdo para você não acumular duplicatas.
Exemplo de requisição — Smart Template inline (recomendado)
curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
-H "Authorization: Bearer SUA_CHAVE_API" \
-H "Content-Type: application/json" \
-d '{
"consultationInternalId": "CONSULT-12345",
"name": "John Doe",
"idCountry": "CO",
"idType": "CC",
"idValue": "123456789",
"notes": "Paciente relata dor de cabeça recorrente",
"pastMedicalHistory": "Hipertensão diagnosticada em 2020",
"scribeSessionModality": "IN_PERSON",
"medicalRecordConfiguration": {
"chiefComplaint": {
"instructionSet": { "telepatiaPromptId": "CHIEF_COMPLAINT" },
"schema": {
"type": "object",
"instructions": "Chief complaint",
"properties": {
"chiefComplaint": { "type": "string", "instructions": "Patient words" }
}
}
}
}
}'
Exemplo de requisição — Smart Template por id
curl -X POST https://scribe-api.telepatia.ai/v1/set-consultation-context \
-H "Authorization: Bearer SUA_CHAVE_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"
}'
{
"success": true,
"consultationInternalId": "CONSULT-12345"
}
Guarde o consultationInternalId — você vai precisar dele pra gerar o link de login e recuperar os resultados da sessão.
