ApiBorne
Sommaire du guide

Référentiel : types d'examens

Les familles d'examens (RADIO, SCANNER, IRM…).

GET/config/exam-types
Base : {editorBaseUrl}/api/apiborneIntegrationService/v1Auth : X-Kiosk-Auth-Key seule

Pourquoi cette route existe

Les familles d'examens pilotent la numérotation des tickets d'appel : chaque type amorce un préfixe (SC-12, IR-3…) que l'admin ApiBorne peut ensuite surcharger. Sans ce référentiel, pas de préfixes par type, donc pas de tickets lisibles pour les patients et les écrans d'appel.

C'est aussi la maille de ciblage large : un message patient ou un critère d'admission peut viser toute une famille (« tous les SCANNER »), et les sélecteurs de l'admin se remplissent avec cette liste. L'id doit être celui de l'examTypeId de vos RDV.

Structure : chaque type d'examen (famille) amorce un préfixe de ticket et regroupe des examens ; les RDV portent examTypeId et examId, ce qui permet un ciblage par famille ou par examen précis.Vos référentiels /config/exam-types et /config/examsType — SCANNER (id 2)ticketPrefix « SC » → tickets SC-1, SC-2…Type — IRM (id 3)ticketPrefix « IR » → tickets IR-1, IR-2…SCANNER THORACIQUEid 7 — examTypeId 2SCANNER ABDOMINALid 8 — examTypeId 2IRM GENOUid 12 — examTypeId 3RDV : examTypeId = 2, examId = 7 — les mêmes ids que vos référentielsmessages patient et critères d'admission ciblables par famille OU par examen précis
Deux référentiels, deux mailles de ciblage : /config/exam-types (famille, préfixe de tickets) et /config/exams (examen précis) — reliés aux RDV par examTypeId / examId.

Comment l'appeler

L'appelant est le serveur ApiBorne — jamais une borne : un GET sous votre base contrat, authentifié par la seule clé d'autorisation compte dans X-Kiosk-Auth-Key (admin ApiBorne, page Connectivité), sans X-Kiosk-Device-Id. Il l'appelle à l'activation de l'intégration (sonde config-check) puis à chaque ouverture des pages d'admin qui s'appuient sur ce référentiel.

bash
# AUTH_KEY = la clé d'autorisation compte (admin ApiBorne, page Connectivité)
# L'appelant est le serveur ApiBorne — jamais une borne
curl -sS "$EDITEUR/api/apiborneIntegrationService/v1/config/exam-types" \
  -H "X-Kiosk-Auth-Key: $AUTH_KEY"

Ce que vous devez retourner

200
{ "examTypes": [
  { "id": "2", "name": "SCANNER", "ticketPrefix": "SC" },
  { "id": "3", "name": "IRM", "ticketPrefix": "IR" },
  { "id": "5", "name": "RADIO" }
] }
  • idle même que l'examTypeId des RDV du contrat
  • ticketPrefixoptionnel — amorce du format de ticket, surchargeable ensuite dans l'admin ApiBorne

Toujours un 200 avec l'enveloppe ci-dessus — liste vide acceptée (établissement neuf). Schéma complet dans le swagger des routes de configuration.

Implémentation de référence