Passer au contenu principal
PATCH
Mets à jour l’adresse de livraison, le panel, les métadonnées ou les e-mails de résultats prêts d’une commande de kit à domicile. N’inclus que les champs que tu veux modifier. L’adresse de livraison et le panel ne peuvent être modifiés que lorsque la commande est pending, car le kit physique part à l’expédition. metadata correspond à ton propre suivi interne et reste modifiable pendant toute la durée de vie de la commande. Il n’y a pas d’endpoints pour ajouter ou retirer un panel : un kit à domicile contient exactement un panel (il correspond en 1:1 à un kit physique), donc la seule opération pertinente sur le panel est le remplacement que tu fais ici. Requiert le scope home_kit_orders_manage.

Requête

Paramètres de chemin

string
requis
Identifiant unique (UUID) de la commande de kit à domicile à mettre à jour.

Paramètres du corps

Tous les paramètres du corps sont facultatifs — inclus uniquement les champs que tu veux modifier.
object
L’adresse à laquelle envoyer le kit — deux formats possibles : soit { location_id } en référence à un lieu de test connu, soit les champs d’adresse intégrés (name, street, city, postal_code, country_code ; company_name / house_number / address_line_2 / state / phone / email facultatifs — le même vocabulaire que l’API des lieux). Fournis exactement l’un des deux — une référence de lieu ou une adresse intégrée, pas les deux.
Packstation ou Postfiliale (Allemagne uniquement) : définis street sur Packstation ou Postfiliale, house_number sur le numéro de station à trois chiffres, et address_line_2 sur le DHL Postnummer du destinataire (6 à 10 chiffres, espaces autorisés). Sans le Postnummer, le colis ne peut pas être enregistré. Un Postfach n’est pas pris en charge.
string
UUID du panel à associer à la place du panel actuel — avec exactement un panel par kit, un remplacement est la seule opération pertinente. Uniquement lorsque la commande est pending, et uniquement vers un panel qu’Aniva a configuré avec un produit de kit d’expédition (422 sinon) ; un remplacement par le panel déjà associé est sans effet.
object
Tes propres paires clé/valeur. Fusionnées avec les métadonnées existantes plutôt que de les remplacer : les clés que tu omets sont conservées, une clé envoyée avec la valeur null est supprimée, et un objet vide {} efface tout. Les limites sont les mêmes que pour Créer une commande de kit à domicile, et la validation est tout-ou-rien — si une clé est rejetée, rien n’est enregistré. Ne mets jamais de données personnelles ou cliniques dans metadata — elles ne sont pas traitées comme des données patient.
string[]
Remplace la liste de 5 adresses maximum qui reçoivent chacune un e-mail dès que tous les résultats de laboratoire sont définitifs. Envoie [] pour désactiver les e-mails. Modifiable dans tous les statuts sauf cancelled. Ta clé a besoin de l’accès results_view pour le patient, sinon 403. Voir E-mails de résultats prêts.

Réponse

En cas de succès, l’API renvoie 200 OK avec la commande de kit à domicile mise à jour et son profil intégré.
string
requis
Identifiant unique de la commande de kit à domicile (UUID).
string
requis
UUID du profil auquel appartient cette commande de kit à domicile.
string
requis
Statut actuel de la commande de kit à domicile. L’une des valeurs pending, dispatched, activated ou cancelled.
object
requis
L’adresse à laquelle envoyer le kit — deux formats possibles : soit { location_id } faisant référence à un lieu de test connu, soit les champs d’adresse directe (name, street, city, postal_code, country_code ; company_name / house_number / address_line_2 / state / phone / email facultatifs — le même vocabulaire que l’API des lieux). Indique exactement un format — une référence de lieu ou une adresse directe, pas les deux.
string
Code d’échantillon de laboratoire sous lequel les résultats sont enregistrés — imprimé sur le kit physique, et que le patient lit sur la boîte comme code d’activation. null tant que le kit n’est pas emballé. En lecture seule.
string
requis
Horodatage du prélèvement transmis via Activer — moment auquel le patient a effectué son prélèvement. null tant que le kit n’est pas activé.
string
La commande de kit à domicile que celle-ci remplace, lorsqu’il s’agit d’un kit de remplacement. null pour une commande normale. Voir Créer une commande de kit à domicile.
string
Motif de l’envoi du kit de remplacement. null pour une commande normale.
string[]
requis
Adresses en minuscules qui reçoivent chacune un e-mail une fois tous les résultats de laboratoire définitifs. Vide si désactivé. Voir E-mails de résultats prêts.
object
requis
Paires clé/valeur définies par le partenaire, renvoyées telles quelles. Toujours présent — {} lorsqu’aucune valeur n’est définie.
string
requis
Horodatage ISO 8601 de la création de la commande de kit à domicile.
string
Horodatage ISO 8601 de la dernière mise à jour. Peut être null.
object
requis
Le profil patient associé à cette commande de kit à domicile.
HomeKitOrderPanel[]
requis
Le panel associé à cette commande de kit à domicile — toujours exactement un (un kit à domicile correspond en 1:1 à un kit physique), remplacé sur place lorsque tu passes panel_id. Consulte les détails du panel (nom, biomarqueurs) via Lister les panels.
HomeKitOrderIndividualBiomarker[]
requis
Biomarqueurs à la carte associés à cette commande de kit à domicile en dehors de tout panel. Croise chaque biomarker_id avec Lister les biomarqueurs et home_kit=true pour obtenir les données d’affichage.
HomeKitOrderShipmentLink[]
requis
Colis liés à cette commande de kit à domicile, du lien le plus ancien au plus récent — normalement le kit envoyé au patient et l’échantillon renvoyé au laboratoire. Vide tant que la logistique n’a pas imprimé d’étiquette. Consulte les colis complets avec Lister les expéditions et ?home_kit_order_id=.

Réponses d’erreur