Pular para o conteúdo principal
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

Identifique o paciente de uma de três maneiras: os campos inline (name, idCountry, idType, idValue), um patientId existente (sp_...), ou seu próprio internalCode. patientId não pode ser combinado com a identidade inline nem com internalCode. internalCode pode ser enviado sozinho para referenciar um paciente existente, ou junto com a identidade inline completa, que cria e marca o paciente quando o código é novo. Enviar patientId junto com a identidade inline, ou uma identidade inline incompleta, retorna um erro 400.

Documentos aceitos por país

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)

Exemplo de requisição — Smart Template por id

Exemplo de requisição — referenciar um paciente existente

Exemplo de requisição — referenciar por internalCode e definir a unidade

Resposta:
Guarde o consultationInternalId — você vai precisar dele pra gerar o link de login e recuperar os resultados da sessão.

Contexto clínico

O bloco clinicalContext envia os dados clínicos que o seu sistema já tem do paciente: alergias, medicamentos, condições, o atendimento atual (queixa principal, triagem, sinais vitais, diagnósticos, procedimentos e notas) e os atendimentos anteriores. A Telepatia guarda o bloco no registro do paciente. A IA lê o bloco quando escreve a nota da sessão, então a nota cita os medicamentos, as alergias e o histórico corretos. Envie o bloco na mesma chamada que define o paciente e a consulta. Os demais campos da requisição não mudam.

Acesso

  • Um bloco com dados clínicos precisa de uma chave de API de médico com a permissão scribe:write. Uma chave antiga sem o claim de permissões recebe 403 para esse bloco; gere a chave de novo para obter uma válida. Um bloco só com currentEncounter.id mantém as regras de acesso da chamada.
  • O bloco funciona para todas as instituições. Não precisa de configuração: basta uma chave de API com scribe:write vinculada à sua instituição.
  • Um bloco que tem só currentEncounter.id não precisa do recurso. Ele vincula a sessão a esse atendimento, como antes, e não escreve nada no registro do paciente.

Exemplo de requisição — contexto clínico completo

A resposta é a mesma de qualquer outra chamada: { "success": true, "consultationInternalId": "CONSULTA-12345" }.

Campos de clinicalContext

Os nomes de campo são camelCase. Um campo que a Telepatia não conhece, dentro de clinicalContext, retorna 400: o bloco contém dados clínicos, então um nome de campo errado não pode desaparecer em silêncio.

Itens: alergias, medicamentos, condições e diagnósticos

A mesma forma vale para as quatro listas. Só ENTERED_IN_ERROR remove um diagnóstico do histórico do atendimento.

Procedimentos

Um procedimento é { "id", "name", "code" } e existe só dentro de um atendimento. code é opcional. O procedimento recebe a data do seu atendimento. O status dele aceita só ENTERED_IN_ERROR, para remover um procedimento enviado por engano.

Atendimentos

Os padrões de class e startedAt valem só para a primeira escrita de um atendimento.

Sinais vitais

Sistemas de códigos

Um system desconhecido retorna 400.

Como a Telepatia aplica o bloco

  1. Atualizações por id. A Telepatia escreve cada item, atendimento e procedimento pelo seu id. Uma chamada posterior com o mesmo id o atualiza. Um item que a chamada não envia fica como está. Para remover um item, envie-o de novo com ENTERED_IN_ERROR ou INACTIVE.
  2. Atendimentos anteriores. Envie um atendimento anterior uma vez, e de novo só quando ele mudar.
  3. A regra do 409. clinicalContext não faz parte da verificação que retorna 409. Uma chamada que repete a mesma consulta com um clinicalContext diferente não gera conflito.
  4. Ordem. A Telepatia guarda primeiro o contexto da consulta e depois enfileira a escrita do contexto clínico. A resposta não espera essa escrita.
  5. A chamada nunca falha por causa do contexto clínico. Quando a Telepatia não consegue enfileirar a escrita, a chamada ainda retorna 200 e a Telepatia alerta a sua equipe. O bloco dessa chamada não é guardado. A sua próxima chamada para o mesmo atendimento envia o bloco de novo, então envie o atendimento atual em toda chamada.
  6. O paciente do bloco. A Telepatia armazena o bloco no paciente que a chamada resolve. Um paciente armazenado (um patientId, ou um internalCode que corresponde a um paciente) mantém o documento de identidade armazenado, também quando a chamada envia outros campos de identidade inline. Um paciente armazenado sem documento de identidade não recebe a escrita do contexto clínico, e a chamada retorna 200. Adicione o documento ao paciente, para que a Telepatia possa armazenar o bloco.
  7. A sessão que lê o bloco. A sessão que o médico inicia na Telepatia depois desta chamada se vincula ao currentEncounter, e a nota dela lê o bloco. Uma sessão criada por POST /v1/scribe-sessions/audio não se vincula ao encontro, então a nota dela não lê o bloco.

Erros

Veja Erros para o envelope completo de resposta.