> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Présentation de l'API partenaire Aniva, une API REST pour les bilans sanguins en pharmacie et en cabinet, les kits de test à domicile et les résultats de laboratoire.

L'API partenaire Aniva est une API REST qui permet aux partenaires de santé de gérer les profils patients, de planifier des rendez-vous de prise de sang dans des lieux de test et de déclencher les pipelines de commandes de laboratoire. Tu interagis avec l'API en HTTPS avec ta clé API partenaire.

## Ce que tu peux faire

* **Gestion des profils** — Créer, récupérer et mettre à jour les profils démographiques des patients.
* **Planification des rendez-vous** — Réserver des rendez-vous de prise de sang dans les lieux de test Aniva.
* **Gestion des panels** — Ajouter ou retirer des panels d'analyses de laboratoire sur un rendez-vous existant.
* **Biomarqueurs individuels** — Associer ou dissocier des biomarqueurs individuels sur un rendez-vous sans choisir de panel.
* **Commandes de kit à domicile** — Envoyer un kit de test par courrier à un patient, suivre ses colis et signaler quand l'échantillon a été prélevé.
* **Catalogue de panels** — Parcourir les panels disponibles avec `GET /api/v1/panels` pour découvrir les ID de panels et les biomarqueurs qu'ils contiennent.
* **Catalogue de biomarqueurs** — Parcourir les biomarqueurs que tu peux commander dans un lieu de test ou dans un kit à domicile avec `GET /api/v1/biomarkers` pour découvrir leurs ID.
* **Confirmation de prise de sang** — Soumettre le ou les codes laboratoire après une prise de sang pour déclencher le pipeline de commande de laboratoire.
* **Résultats de laboratoire** — Récupérer les résultats cliniques et génétiques et télécharger les rapports de laboratoire au format PDF.
* **Découverte des lieux** — Lister les lieux de test disponibles à présenter aux patients.
* **Logistique d'expédition** — Créer, suivre, modifier et annuler des commandes d'expédition par coursier.
* **Webhooks** — Recevoir un appel HTTPS lorsqu'un rendez-vous, une commande de kit à domicile, ses résultats, un lieu, un profil ou une expédition change. Voir [Webhooks](https://docs.anivahealth.com/fr/concepts/webhooks.md).

## Explorer la documentation

> [card] [Authentification](https://docs.anivahealth.com/fr/authentication.md)
>
> Authentifie les requêtes avec ta clé API partenaire.

> [card] [Démarrage rapide](https://docs.anivahealth.com/fr/quickstart.md)
>
> Effectue ton premier appel API en quelques minutes grâce à des exemples étape par étape.

> [card] [Profils](https://docs.anivahealth.com/fr/concepts/profiles.md)
>
> Découvre comment fonctionnent les profils patients et quelles données ils contiennent.

> [card] [Rendez-vous](https://docs.anivahealth.com/fr/concepts/appointments.md)
>
> Comprends le cycle de vie d'un rendez-vous, de la planification à la confirmation.

> [card] [Commandes de kit à domicile](https://docs.anivahealth.com/fr/concepts/home-kit-orders.md)
>
> Envoie un kit de test au domicile d'un patient et suis-le jusqu'à ce que l'échantillon arrive au laboratoire.

## Gestion des versions de l'API

La version actuelle de l'API est **v1**. Tous les points de terminaison sont préfixés par `/api/v1/`. L'URL de base est `https://anivahealth.com`.

```text theme={null}
https://anivahealth.com/api/v1/
```

Les modifications incompatibles seront introduites sous un nouveau préfixe de version. L'API v1 restera disponible, avec un préavis avant toute dépréciation.

## Dates et fuseaux horaires

Tous les instants échangés sont au format **ISO 8601 en UTC** (suffixe `Z`). Les champs purement calendaires utilisent des **valeurs d'horloge
locale** (`YYYY-MM-DD`, `HH:MM`).

| Catégorie | Format | Utilisé pour |
| - | - | - |
| **Instant** | ISO 8601 en UTC (suffixe `Z`, par ex. `2026-04-15T08:30:00Z`) | Chaque date et heure en sortie — `scheduled_at` d'un rendez-vous, `slots[]` des disponibilités, `pickup.from` / `pickup.till` d'une expédition, `created_at`, `updated_at`, `added_at`. À afficher dans n'importe quel fuseau horaire local côté client. |
| **Événement fournisseur** | ISO 8601 avec le décalage du fournisseur en amont (transmis tel quel) | Uniquement `status_updates[].time` d'une expédition — le décalage reflète ce que le coursier a signalé. |
| **Horloge locale** | `YYYY-MM-DD` pour les dates, `HH:MM` pour les heures — sans décalage | Valeurs purement calendaires ou heures de la journée — `date_of_birth`, `tested_at` des résultats, `start_date` / `end_date` des disponibilités, `pickup_date` / `pickup_time_from` / `pickup_time_till` d'une expédition, `open_hours` d'un lieu. |

Remarques particulières :

* **Les entrées qui prennent une date et heure** (par ex. `scheduled_at` sur `POST` / `PATCH /api/v1/appointments`)
  **doivent inclure un indicateur de fuseau horaire** — soit `Z`, soit un décalage explicite comme `+02:00`. Les dates
  et heures sans fuseau sont rejetées avec `400`. Les deux formes encodent le même instant ; la réponse renvoie
  toujours `scheduled_at` en UTC `Z`. Utilise le champ `timezone` du lieu (ou tout autre identifiant
  IANA) pour formater l'instant en heure locale lors de l'affichage.
* **Les entrées d'horloge locale** sont interprétées dans le fuseau horaire de la ressource qu'elles ciblent : les dates
  de disponibilité utilisent le paramètre de requête `timezone` (par défaut le fuseau horaire du lieu) ; les champs
  `pickup_date` / `pickup_time_*` d'une expédition sont interprétés dans le fuseau horaire du lieu d'origine.
* **Les champs de réponse contenant uniquement une date** (par ex. `tested_at`, `availability[].date` des disponibilités) sont
  des dates calendaires sans fuseau horaire.

## Obtenir un accès

Les clés API sont délivrées par Aniva pour chaque partenaire.

> [!NOTE]
>
> Contacte Aniva pour recevoir ta clé API partenaire.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.