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
Contexto clínico
O blococlinicalContext 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 recebe403para esse bloco; gere a chave de novo para obter uma válida. Um bloco só comcurrentEncounter.idmanté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:writevinculada à sua instituição. - Um bloco que tem só
currentEncounter.idnã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
{ "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
- Atualizações por id. A Telepatia escreve cada item, atendimento e procedimento pelo seu
id. Uma chamada posterior com o mesmoido atualiza. Um item que a chamada não envia fica como está. Para remover um item, envie-o de novo comENTERED_IN_ERRORouINACTIVE. - Atendimentos anteriores. Envie um atendimento anterior uma vez, e de novo só quando ele mudar.
- A regra do
409.clinicalContextnão faz parte da verificação que retorna409. Uma chamada que repete a mesma consulta com umclinicalContextdiferente não gera conflito. - 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.
- A chamada nunca falha por causa do contexto clínico. Quando a Telepatia não consegue enfileirar a escrita, a chamada ainda retorna
200e 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. - O paciente do bloco. A Telepatia armazena o bloco no paciente que a chamada resolve. Um paciente armazenado (um
patientId, ou uminternalCodeque 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 retorna200. Adicione o documento ao paciente, para que a Telepatia possa armazenar o bloco. - 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 porPOST /v1/scribe-sessions/audionão se vincula ao encontro, então a nota dela não lê o bloco.
Erros
Veja Erros para o envelope completo de resposta.