Saltar para o conteúdo principal
POST
Carrega um ficheiro para um perfil. Envia-o como multipart/form-data. Sem extract_results, a Aniva apenas guarda o ficheiro. Com extract_results: true, a Aniva também lê os valores de laboratório a partir do ficheiro. Não indicas que tipo de relatório é o ficheiro. A Aniva decide. Um ficheiro sem resultados de laboratório, como uma carta médica, termina como stored e não é um erro. Lê os valores com Obter resultados do documento. Não precisas de fazer polling: subscreve os webhooks document.results.*. Requer o âmbito documents_upload num grupo de perfis do perfil. extract_results: true também requer o âmbito documents_extract_results no mesmo grupo. Pede à Aniva para os adicionar. O documento pertence a esse grupo: as chaves com results_view nesse grupo leem o documento e os seus resultados. Envia um cabeçalho opcional Idempotency-Key para tornar seguro repetir o carregamento. Consulta Idempotência.

O que faz a extração

Com extract_results: true:
  1. A Aniva envia o ficheiro aos seus subcontratantes de OCR e IA para ler os valores.
  2. Os valores aparecem na app Aniva do membro, como qualquer outro resultado.
  3. Cada valor inclui origin: partner_upload e o mesmo status que qualquer outro resultado. Um valor de que a verificação automática da Aniva duvida tem o estado likely_wrong.
Sem isso, o ficheiro não vai para nenhum serviço externo quando também envias document_date.
  • A leitura automática pode ler mal um valor, uma unidade ou uma data. O ficheiro original continua a ser a fonte de verdade. Confirma o valor com ele antes de o usares para uma decisão médica. Os valores extraídos não são um diagnóstico.
  • Os subcontratantes são a Mistral AI (OCR, UE) e o Google Cloud Vertex AI, acedido através do Vercel AI Gateway (extração, pode processar fora da UE). Processam o ficheiro apenas para o ler.
  • Precisas de uma base legal para carregar os dados de saúde de um membro, normalmente o consentimento explícito do membro. És responsável por isso.

Pedido

Campos do formulário

file
obrigatório
O ficheiro. PDF, DOC, DOCX, PNG ou JPEG, no máximo 4 MB.
string
obrigatório
UUID do perfil a que o documento pertence.
boolean
padrão:"false"
true para ler os valores laboratoriais do ficheiro. Envia true ou false.
string
A data da amostra no formato YYYY-MM-DD, quando a conheces. Sem ela, a Aniva lê a data do ficheiro.

Resposta

A API devolve 201 Created quando apenas guardou o ficheiro e 202 Accepted quando a extração é executada.
string
obrigatório
ID do documento (UUID). Usa-o com Obter resultados do documento e Transferir documento.
string
obrigatório
processing enquanto a Aniva extrai os valores, ou stored quando o ficheiro é apenas guardado.
string
obrigatório
O perfil a que o documento pertence.
string
A data da amostra que enviaste, ou a que a Aniva leu de um ficheiro guardado. Pode ser null.
string
obrigatório
O URL de Obter resultados do documento deste documento.
string
obrigatório
Nome do ficheiro a apresentar, o mesmo que Transferir documento envia.
string
obrigatório
O nome do ficheiro que carregaste.
string
obrigatório
Sempre partner_upload.
string
obrigatório
Tipo de média do ficheiro, por ex., application/pdf.
string
Versão do conteúdo do ficheiro. Pode ser null.
integer
Tamanho do ficheiro em bytes. Pode ser null.
string
Sempre null para um documento carregado.

Respostas de erro