Passer au contenu principal
GET
Récupère une liste de commandes de kit à domicile. Une commande de kit à domicile permet d’envoyer un kit d’auto-prélèvement par courrier — Aniva expédie le kit, le patient effectue lui-même le prélèvement chez lui et le renvoie par la poste. Chaque commande de kit à domicile inclut le profil patient intégré. Lorsque profile_id est fourni, renvoie toutes les commandes de kit à domicile pour ce profil. Lorsqu’il est omis, renvoie toutes les commandes de kit à domicile accessibles. Nécessite le scope home_kit_orders_view ou home_kit_orders_manage.

Requête

Paramètres de requête

string
Filtre par UUID de profil. Lorsqu’il est fourni, toutes les commandes de kit à domicile de ce profil sont renvoyées.
string
Filtre par code laboratoire (correspondance exacte) — retrouve la commande d’un kit physique que tu as en main grâce au code imprimé dessus, par exemple avant d’appeler Activer.

Réponse

En cas de succès, l’API renvoie 200 OK avec un tableau d’objets de commande de kit à domicile.
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. Le détail d’avancement des résultats de laboratoire est obtenu via Récupérer les résultats.
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 un seul (chaque kit à domicile correspond à un seul produit de kit physique), modifiable via Mettre à jour tant que le statut est pending. 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=.

Appels répétés

Aniva conserve la réponse de ce point de terminaison pendant 5 minutes pour chaque clé API. Un appel répété pendant ce délai reçoit la réponse conservée. Les en-têtes Cache-Status et Age indiquent que la réponse est conservée et depuis combien de temps. Pour être informé tout de suite d’un changement, abonne-toi aux événements webhook home_kit_order.created et à l’événement de chaque statut, par exemple home_kit_order.activated. Voir Lectures répétées.

Réponses d’erreur