Passer au contenu principal
GET
Récupère les résultats de laboratoire cliniques et génétiques d’une commande de kit à domicile, ainsi que les références de documents pour les PDF des rapports de laboratoire. Chaque biomarqueur commandé pour le kit figure dans la réponse, ce qui te permet de suivre toute la commande plutôt que seulement ce qui est déjà revenu. Les résultats sont enregistrés sous le lab_code de la commande — la commande auprès du laboratoire est passée lors de l’activation, et le laboratoire transmet les marqueurs un par un au fil de leur analyse, donc une réponse partielle est normale et le status global reste in_progress jusqu’au rapport final. Lis le status de chaque résultat avant d’utiliser sa value :
  • Les analyses encore en attente apparaissent avec le statut planned tant que la commande est in_progress. Tu peux appeler cet endpoint avant l’activation — chaque marqueur commandé est alors planned.
  • Les résultats transmis par le laboratoire mais qui ne doivent pas être utilisés sur le plan clinique apparaissent avec le statut fault ou undeliverable, accompagnés d’un status_reason qui explique pourquoi. Un résultat fault a quand même sa value renseignée — cette valeur est erronée. Ne la présente jamais comme un résultat exploitable.
  • Les résultats dont Aniva ou le membre doute apparaissent avec le statut likely_wrong et un status_reason. La valeur n’est pas confirmée. Ne l’affiche pas comme un résultat exploitable sans vérification.
Utilise Télécharger un document pour télécharger les rapports de laboratoire en PDF référencés dans le tableau documents. Tu n’as pas besoin d’interroger régulièrement cet endpoint. Abonne-toi aux webhooks home_kit_order.results.updated ou home_kit_order.results.completed, et appelle-le lorsqu’un événement arrive. Le polling reste possible en solution de secours. Nécessite le scope results_view — les résultats de laboratoire et les documents en dépendent toujours, comme pour les résultats de rendez-vous et Télécharger un document — ainsi que le scope home_kit_orders_view ou home_kit_orders_manage pour accéder à la commande de kit elle-même.

Requête

Paramètres de chemin

string
requis
Identifiant unique (UUID) de la commande de kit à domicile pour laquelle récupérer les résultats.

Réponse

En cas de succès, l’API renvoie 200 OK avec l’objet des résultats.
string
requis
Statut global des résultats. L’une des valeurs suivantes :
  • in_progress — certaines demandes sont encore au laboratoire.
  • completed — toutes les demandes sont clôturées et au moins une a rendu ses résultats.
  • fault — toutes les demandes ont échoué sans rendre de résultats. Rien n’est dû.
object[]
requis
Une entrée par demande au laboratoire — une prise de sang répartie sur plusieurs tubes ou laboratoires en comporte plusieurs. Le status principal passe à completed dès que toutes les entrées sont clôturées et que l’une d’elles a rendu ses résultats.
object[]
requis
Tableau des résultats de biomarqueurs cliniques.
object[]
requis
Tableau des résultats de biomarqueurs génétiques.
object[]
requis
Documents de compte rendu de laboratoire. Utilise GET /api/v1/documents/{id} pour télécharger chaque fichier.

Appels répétés

Aniva conserve la réponse de cet endpoint pendant 60 minutes pour chaque clé API. Un appel répété pendant ce délai renvoie la réponse conservée tant que la commande de kit à domicile et ses résultats ne changent pas. Après une modification, tu reçois une nouvelle réponse. Les en-têtes Cache-Status et Age indiquent que la réponse est conservée et son ancienneté. Pour être informé tout de suite d’un changement, abonne-toi aux événements webhook home_kit_order.results.updated, home_kit_order.results.completed et home_kit_order.results.fault. Voir Lectures répétées.

Réponses d’erreur