Passer au contenu principal
GET
Récupère une liste de rendez-vous de prise de sang. Chaque rendez-vous inclut le profil patient intégré. Les filtres se combinent :
  • date renvoie les rendez-vous d’un jour calendaire donné. Ce jour correspond à la date locale du lieu de chaque rendez-vous ; ainsi, une prise de sang à 23 h 30 à Berlin est rattachée à sa date berlinoise.
  • location_id renvoie les rendez-vous d’un lieu de prélèvement donné.
  • profile_id sans date renvoie tous les rendez-vous de ce profil, sans limite de temps.
  • Sans profile_id ni date, la fenêtre temporelle par défaut s’applique : des 2 derniers mois au mois à venir.
Nécessite le scope appointments_view ou appointments_schedule.

Requête

Paramètres de requête

string
Filtre par UUID de profil. Lorsqu’il est fourni, tous les rendez-vous de ce profil sont renvoyés, quelle que soit la date prévue. Lorsqu’il est omis, la fenêtre temporelle par défaut s’applique.
string
Filtre par UUID du lieu de prélèvement.
string
Jour calendaire au format YYYY-MM-DD, dans le fuseau horaire du lieu de chaque rendez-vous. Remplace la fenêtre temporelle par défaut. Les résultats sont triés par scheduled_at, du plus ancien au plus récent.

Réponse

En cas de succès, l’API renvoie 200 OK avec un tableau d’objets rendez-vous.
string
requis
Identifiant unique du rendez-vous (UUID).
string
requis
UUID du profil auquel ce rendez-vous appartient.
string
UUID du lieu de test où la prise de sang a lieu.
string
Date et heure prévues du rendez-vous en UTC (ISO 8601 avec suffixe Z, par ex. 2026-05-15T10:30:00Z). Peut être null.
string
requis
Statut actuel du rendez-vous. Prend l’une des valeurs pending, confirmed, blood_drawn ou cancelled. Le détail d’avancement des résultats de laboratoire s’obtient via Récupérer les résultats ; la progression fine des envois via chaque entrée du tableau shipments intégré (voir ci-dessous), puis Récupérer un envoi.
string
Motif en texte libre saisi lors de l’annulation du rendez-vous (par ex. absence, annulation tardive, « Échec. À refaire »). null sauf si status vaut cancelled.
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.
string
requis
Méthode de prise de sang : capillary (au bout du doigt ou sur le haut du bras, dans des microtubes) ou venous (dans la veine, dans des tubes). C’est la méthode définie par le rendez-vous, sinon le default_draw_method de son lieu. Après la prise de sang, c’est la méthode qui a été utilisée.
string
requis
Horodatage ISO 8601 de création du rendez-vous.
string
Horodatage ISO 8601 de la dernière mise à jour. Peut être null.
object
requis
Le profil patient associé à ce rendez-vous.
AppointmentPanel[]
requis
Panels actuellement associés à ce rendez-vous. Exclut les associations annulées. Consulte les détails d’un panel (nom, biomarqueurs) via Lister les panels.
AppointmentIndividualBiomarker[]
requis
Biomarqueurs à la carte rattachés à ce rendez-vous en dehors de tout panel (voir Ajouter des biomarqueurs personnalisés). Croise chaque biomarker_id avec Lister les biomarqueurs pour obtenir les données d’affichage.
AppointmentShipmentLink[]
requis
Expéditions liées à ce rendez-vous, du lien le plus ancien au plus récent. Tableau vide lorsqu’aucune expédition n’est liée. Recoupe chaque id avec Obtenir une expédition pour obtenir les données complètes de l’expédition (statut, numéro de suivi, mises à jour de statut, etc.).
string[]
requis
Codes laboratoire (codes-barres des tubes) enregistrés pour ce rendez-vous, dans l’ordre de scan. Vide jusqu’à la confirmation de la prise de sang. Une prise de sang veineuse porte un seul code imprimé sur chaque tube ; une prise de sang capillaire porte un code par microtube. Les résultats et documents dans Obtenir les résultats référencent ces codes via lab_code.

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é d’un changement immédiatement, abonne-toi aux événements webhook appointment.created, appointment.rescheduled et à l’événement de chaque statut, par exemple appointment.confirmed. Voir Lectures répétées.

Réponses d’erreur