Saltar para o conteúdo principal
GET
Obtém uma lista de encomendas de kit de teste em casa. Uma encomenda de kit de teste em casa envia pelo correio um kit de teste para fazer em casa — a Aniva envia o kit, o paciente colhe a amostra em casa e envia-a de volta pelo correio. Cada encomenda de kit de teste em casa inclui o perfil do paciente incorporado. Quando profile_id é fornecido, devolve todas as encomendas de kit de teste em casa desse perfil. Quando omitido, devolve todas as encomendas de kit de teste em casa acessíveis. Requer o scope home_kit_orders_view ou home_kit_orders_manage.

Pedido

Parâmetros de consulta

string
Filtra por UUID do perfil. Quando fornecido, são devolvidas todas as encomendas de kit de teste em casa deste perfil.
string
Filtra por código de laboratório (correspondência exata) — associa um kit físico em mão à respetiva encomenda através do código impresso nele, por exemplo, antes de chamares Ativar.

Resposta

Em caso de sucesso, a API devolve 200 OK com um array de objetos de encomenda de kit de teste em casa.
string
obrigatório
Identificador único da encomenda de kit de teste em casa (UUID).
string
obrigatório
UUID do perfil a que pertence esta encomenda de kit de teste em casa.
string
obrigatório
Estado atual da encomenda de kit de teste em casa. Um de pending, dispatched, activated ou cancelled. O detalhe de conclusão dos resultados de laboratório é obtido a partir de Obter resultados.
object
obrigatório
A morada para onde enviar o kit — um de dois formatos: { location_id }, que referencia um local de teste conhecido, ou os campos de morada inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionais — o mesmo vocabulário da API de localizações). Indica exatamente um — uma referência de localização ou uma morada inline, não ambos.
string
Código de amostra de laboratório sob o qual os resultados são comunicados — impresso no kit físico e o que o paciente lê na caixa como código de ativação. null até o kit ser embalado. Só de leitura.
string
obrigatório
Data e hora da colheita comunicadas através de Ativar — quando o paciente recolheu a amostra. null até o kit ser ativado.
string
A encomenda de kit de teste em casa que esta substitui, quando se trata de um kit de substituição. null numa encomenda normal. Consulta Criar encomenda de kit de teste em casa.
string
Motivo do envio da substituição. null numa encomenda normal.
string[]
obrigatório
Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta E-mails de resultados prontos.
object
obrigatório
Pares chave/valor definidos pelo parceiro, devolvidos sem alterações. Sempre presente — {} quando não definido.
string
obrigatório
Data e hora ISO 8601 de criação da encomenda de kit de teste em casa.
string
Data e hora ISO 8601 da última atualização. Pode ser null.
object
obrigatório
O perfil do paciente associado a esta encomenda de kit de teste em casa.
HomeKitOrderPanel[]
obrigatório
O painel associado a esta encomenda de kit de teste em casa — sempre exatamente um (um kit de teste em casa corresponde 1:1 a um produto de kit físico), substituível através de Atualizar enquanto estiver pending. Consulta os detalhes do painel (nome, biomarcadores) através de Listar painéis.
HomeKitOrderIndividualBiomarker[]
obrigatório
Biomarcadores avulsos associados a esta encomenda de kit de teste em casa fora de qualquer painel. Cruza cada biomarker_id com Listar biomarcadores com home_kit=true para obter os dados de apresentação.
HomeKitOrderShipmentLink[]
obrigatório
Pacotes associados a esta encomenda de kit de teste em casa, com a associação mais antiga primeiro — normalmente o kit para o paciente e a amostra de volta para o laboratório. Vazio até a expedição imprimir uma etiqueta. Lê os pacotes completos com Listar envios e ?home_kit_order_id=.

Chamadas repetidas

A Aniva guarda a resposta deste endpoint durante 5 minutos por cada chave API. Uma chamada repetida dentro deste período recebe a resposta guardada. Os cabeçalhos Cache-Status e Age mostram que a resposta está guardada e há quanto tempo. Para saberes de uma alteração de imediato, subscreve os eventos de webhook home_kit_order.created e o evento de cada estado, por exemplo home_kit_order.activated. Consulta Leituras repetidas.

Respostas de erro