Passer au contenu principal
DELETE
Annule un rendez-vous en passant son statut à cancelled. Seuls les rendez-vous dont la prise de sang n’a pas encore été confirmée peuvent être annulés. Annuler un rendez-vous déjà cancelled renvoie 200 avec ce rendez-vous et n’écrit rien — aucune seconde annulation n’est enregistrée. La réponse inclut Idempotent-Replayed: true pour que tu puisses distinguer une répétition de l’appel qui a effectué l’action. Une répétition qui contient un cancellation_reason différent renvoie plutôt 409 : le motif enregistré n’est jamais écrasé. Voir Idempotence.
Les rendez-vous ne peuvent pas être annulés une fois la prise de sang confirmée — cela renvoie 409 Conflict.
Nécessite le scope appointments_schedule ou appointments_manage.

Requête

Paramètres de chemin

string
requis
Identifiant unique (UUID) du rendez-vous à annuler.

Paramètres du corps

Le corps de la requête est facultatif — n’envoie aucun corps pour annuler sans enregistrer de motif.
string
Motif d’annulation en texte libre, jusqu’à 500 caractères (par ex. Patient no-show). Enregistré sur le rendez-vous et renvoyé dans cancellation_reason lors de cette lecture et des suivantes.

Réponse

En cas de succès, l’API renvoie 200 OK avec le rendez-vous annulé et son profil intégré.
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 du rendez-vous. Sera cancelled après une annulation réussie.
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 rattachés à ce rendez-vous avant l’annulation. Consulte les détails des panels (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 avant l’annulation. Chaque id correspond à Obtenir une expédition.
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.

Réponses d’erreur