ApiBorne
Sommaire du guide

Routes de communication

Les opérations que la borne appelle chez vous pendant le parcours patient — une page par opération : sémantique, requête, réponse, erreurs et implémentation de référence. Quatorze routes sont obligatoires — celles dont vous n'avez pas la fonctionnalité acceptent une implémentation minimale (liste vide, 204, 404…) ; une seule est optionnelle, le contenu d'un document : si elle répond 404, la borne masque simplement l'aperçu.

Les 15 opérations

POST/patients/identify

Identifier un patient — Recherche les patients et leurs RDV du jour (carte de santé ou saisie).

GET/appointments/by-code/{code}

RDV par code (QR) — Résout le code de convocation scanné par le patient.

POST/appointments/by-ticket

RDV par ticket (app Pass) — Résout un RDV du jour par numéro de ticket + date de naissance (app patient).

GET/appointments/{appointmentId}

RDV par identifiant — Rechargement canonique d'un RDV déjà connu.

PUT/appointments/{appointmentId}/status

Statut d'un RDV — Le Cockpit ApiBorne reflète un changement d'état dans votre agenda.

PATCH/patients/{patientId}

Modifier un patient — Correction des données administratives depuis la borne.

PUT/appointments/{appointmentId}/prescriber

Prescripteur du RDV — Le patient valide un prescripteur proposé par l'analyse d'ordonnance.

GET/appointments/{appointmentId}/documents

Lister les documents — Documents présents et types attendus — la borne calcule les manquants.

POST/appointments/{appointmentId}/documents

Téléverser un document — Pages images en base64, analyse d'ordonnance optionnelle en retour.

DELETE/appointments/{appointmentId}/documents/{documentId}

Supprimer un document — Le remplacement d'un document = DELETE de l'ancien puis POST du nouveau.

GET/appointments/{appointmentId}/documents/{documentId}/contentoptionnelle

Contenu d'un document (aperçu) — OPTIONNEL — les pages d'un document déjà déposé, pour l'aperçu « Voir » du patient.

POST/appointments/{appointmentId}/check-in

Check-in — L'opération critique : arrivée du patient, ticket d'appel en retour.

POST/appointments/{appointmentId}/notify-external-system

Notifier le système externe — Accueil RIS différé : déclencher la notification des équipes pour un RDV déjà accueilli.

GET/appointments/{appointmentId}/notification-readiness

Notification readiness — Le dossier est-il complet au sens de l'éditeur ? Toujours répondre.

POST/staff/sign-in

Connexion du personnel — Login Cockpit avec vos identifiants — appelé par le serveur ApiBorne.

La spécification OpenAPI

La source de vérité normative est openapi.yaml (OpenAPI 3.0.3). Ce guide en reprend la sémantique — en cas de doute, la spec fait foi. Les fichiers se branchent directement sur vos outils (générateurs de clients, Postman, Insomnia, Swagger UI…).

La variante JSON est générée automatiquement depuis le YAML à chaque build — les deux fichiers sont strictement équivalents.