Saltar para o conteúdo principal
PATCH
Adiciona um ou mais biomarcadores individuais a uma marcação como testes avulso, fora de qualquer painel predefinido. As decisões de encaminhamento são tomadas a jusante pelo pipeline de logística de pedidos com base nos mapeamentos por laboratório de cada biomarcador. O conjunto resultante é validado de forma síncrona face às regras de fecho de cada laboratório. Alguns biomarcadores só podem ser obtidos se forem pedidos em conjunto com outros — um rácio LDL/HDL, por exemplo, é fornecido por um pedido que também devolve LDL e HDL, pelo que pedir o rácio sozinho não é um pedido coerente. (Esses mesmos componentes são também a base do preço do rácio — vê o detalhe de pricing em Listar biomarcadores.) Quando o conjunto não pode ser pedido de forma válida, a chamada devolve 400 com um payload validation e nada é guardado, para que possas chegar a um conjunto válido por tentativa e erro:
  1. PATCH … { "biomarker_ids": [45] } (apenas rácio LDL/HDL) → 400; validation.failures[].fix_options[].add_biomarkers lista LDL e HDL.
  2. PATCH … { "biomarker_ids": [45, 43, 42] } (rácio + LDL + HDL) → 200.
O mesmo ciclo aplica-se aos biomarcadores que a Aniva só vende dentro de uma posição: se pedires um sozinho, a chamada devolve 400 com error: "biomarker_requires_position" e as posições que o vendem. Vê Preços. Listar biomarcadores apresenta alguns biomarcadores com price_cents: null. Estes biomarcadores estão sem curadoria: a Aniva não definiu preço para eles. Se adicionares um, a chamada devolve 400 com error: "biomarker_not_priced". Nenhum outro biomarcador resolve esta falha, porque null significa que não tens preço para comprar o marcador. Os marcadores de kit são a exceção. Associa o painel correspondente ao kit e os seus membros vêm com o painel. A chamada também aceita um membro que adiciones a uma marcação que já tenha esse painel. Numa colheita capilar (draw_method: capillary), a colheita é distribuída por microtainers. Os painéis entram primeiro, por ordem de marcação. Os biomarcadores individuais preenchem depois o espaço livre dos microtainers dos painéis. Quando precisam de mais espaço, abrem novos microtainers. Distribuímo-los de forma uniforme. Cada microtainer comporta no máximo 150 µl de biomarcadores individuais. Um biomarcador que precise de mais de 150 µl num microtainer próprio nunca cabe, tal como um biomarcador sem volume definido. Se o conjunto resultante violar esta regra, a chamada devolve 400 com uma mensagem em error e nada é guardado. Esta chamada é idempotente: os biomarcadores que já estão na marcação mantêm-se. Requer os scopes appointments_schedule e schedule_appointments_with_individual_biomarker_selection.
Não é possível adicionar biomarcadores depois de chamares Confirmar colheita de sangue. Tentar modificar uma marcação confirmada devolve 409 Conflict.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) da marcação.

Parâmetros do corpo

number[]
obrigatório
Array de IDs de biomarcadores a associar. Tem de conter pelo menos um item. Usa Listar biomarcadores para descobrir os IDs.

Resposta

Em caso de sucesso, a API devolve 200 OK a confirmar que os biomarcadores foram associados.
boolean
true quando os biomarcadores foram adicionados com sucesso à marcação.

Ler um 400

Todos os 400 de validação de fecho e de catálogo incluem uma frase em message. Um 400 de validação do corpo ou de microtainer inclui apenas error. Faz a ramificação com base em error. Numa falha de validação de fecho, error é uma frase. Numa falha de catálogo, error é um código de máquina: biomarker_not_priced ou biomarker_requires_position. Validação de fecho — o conjunto não pode ser pedido de forma válida em nenhum laboratório:
  • validation.failures[] — presente apenas em falhas de validação de fecho (ausente em erros simples de validação do corpo). Uma entrada por cada grupo de biomarcadores que nenhum laboratório consegue processar, com os biomarker_ids que falharam e fix_options[], da opção mais pequena para a maior. O add_biomarkers ({ id, name }) de cada opção é um conjunto que tens de adicionar na TOTALIDADE — mantém os teus originais, adiciona esses e tenta novamente. Um fix_options vazio significa que não há nada que possas adicionar para resolver; em vez disso, remove o biomarcador.
Biomarcador sem preço — a Aniva não definiu preço para este biomarcador. Listar biomarcadores apresenta-o com price_cents: null, ou omite-o quando é um rácio com um componente sem preço. error é biomarker_not_priced e biomarker_id identifica o marcador. Nenhum outro biomarcador resolve esta falha, por isso remove o biomarcador. Duas condições permitem pedir um biomarcador: um laboratório para onde a Aniva possa encaminhar tem de o fornecer, e o catálogo da Aniva tem de ter preço para ele. Biomarcador restrito — um biomarcador vendido apenas dentro de uma posição, sem nenhuma posição que o cubra no conjunto. error é biomarker_requires_position, biomarker_id identifica o marcador e positions[] lista todas as posições que o vendem, da mais barata para a mais cara. Adiciona todos os biomarcadores de uma delas. Vê Preços para o modelo e pricing.positions em Obter biomarcador para o conjunto completo de membros de uma posição.

Respostas de erro