Saltar para o conteúdo principal
PATCH
Atualiza a morada de entrega, o painel, os metadados ou os emails de resultados prontos de um pedido de kit de teste em casa. Inclui apenas os campos que queres alterar. A morada de entrega e o painel só podem ser alterados enquanto o pedido estiver em pending, porque o kit físico é enviado no momento da expedição. metadata serve para o teu próprio registo e mantém-se editável durante todo o ciclo de vida do pedido. Não existem endpoints para adicionar/remover painéis: um kit de teste em casa tem exatamente um painel (corresponde 1:1 a um produto de kit físico), pelo que a única operação de painel com sentido é a troca que fazes aqui. Requer o âmbito home_kit_orders_manage.

Pedido

Parâmetros de caminho

string
obrigatório
Identificador único (UUID) do pedido de kit de teste em casa a atualizar.

Parâmetros do corpo

Todos os parâmetros do corpo são opcionais — inclui apenas os campos que queres alterar.
object
A morada para a qual enviar o kit por correio — num de dois formatos: { location_id } a referenciar uma localização de teste conhecida, ou os campos de morada em linha (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 em linha, não ambos.
Packstation ou Postfiliale (apenas Alemanha): define street como Packstation ou Postfiliale, house_number como o número de três dígitos da estação e address_line_2 como o DHL Postnummer do destinatário (6–10 dígitos, espaços permitidos). Sem o Postnummer, não é possível registar o envio. Não é suportado Postfach.
string
UUID do painel a associar em substituição do atual — com exatamente um painel por kit, uma troca é a única operação com sentido. Apenas enquanto o pedido estiver em pending, e apenas para um painel que a Aniva tenha configurado com um produto de kit de expedição (422 caso contrário); trocar para o painel já associado não tem efeito.
object
Os teus próprios pares chave/valor. São combinados com os metadados existentes em vez de os substituírem: as chaves que omitires são preservadas, uma chave enviada com valor null é eliminada e um objeto vazio {} limpa tudo. Os limites correspondem aos de Criar pedido de kit de teste em casa e a validação é tudo-ou-nada — se qualquer chave for rejeitada, nada é gravado. Nunca coloques dados pessoais ou clínicos em metadata — estes não são tratados como dados de paciente.
string[]
Substitui a lista de até 5 endereços que recebem um email assim que todos os resultados laboratoriais forem finais. Envia [] para desativar os emails. Editável em todos os estados exceto cancelled. A tua chave precisa de acesso results_view ao paciente, caso contrário devolve 403. Consulta Emails de resultados prontos.

Resposta

Em caso de sucesso, a API devolve 200 OK com o pedido de kit de teste em casa atualizado e o respetivo perfil incorporado.
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 do pedido de kit de teste em casa. Um de pending, dispatched, activated ou cancelled.
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 este pedido 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ído no local quando passas panel_id. 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=.

Respostas de erro