ApiBorne
Sommaire du guide

Types de documents

Le référentiel des types de documents appartient à l'éditeur : c'est vous qui déclarez les types que vous gérez, via la route de configuration dédiée. Un vocabulaire standard de 41 codes assure l'interopérabilité des configurations.

Le référentiel vous appartient

Les documents requis d'un rendez-vous (requiredDocumentTypes) et les uploads (documentType) sont pilotés par des codes. La liste de ces codes n'est pas figée par le contrat : vous l'exposez via GET /config/document-types — codes standard quand ils correspondent, codes propres à votre système sinon.

exemple — avec un code maison
GET /config/document-types
→ 200 {
  "documentTypes": [
    { "documentType": "prescription",        "label": "Ordonnance" },
    { "documentType": "mutualInsuranceCard", "label": "Carte Mutuelle" },
    { "documentType": "preOpChecklist",      "label": "Check-list pré-opératoire (maison)" }
  ]
}

Ce référentiel ne sert qu'à construire la liste : le libellé personnalisé et « fournissable par le patient depuis son téléphone » se paramètrent ensuite dans l'admin ApiBorne (page Paramètres des documents requis), à partir de votre liste.

Dans l'implémentation de référence, ce référentiel est éditable dans la page /referentials — ajoutez un type maison et il devient immédiatement proposable comme document requis d'un RDV.

Les règles

  • La borne compare les codes tels quels (calcul des manquants par différence, remplacement) — le libellé affiché voyage toujours dans label ;
  • Reprenez le vocabulaire standard pour tout type qui y correspond : c'est lui qui rend les configurations interopérables entre éditeurs ;
  • Un système qui ne reconnaît pas un code le traite comme other ;
  • Format des codes : ^[A-Za-z][A-Za-z0-9_-]*$, 64 caractères max ;
  • Toute conversion vers un référentiel interne se fait dans vos mappers : aucune valeur propriétaire ne transite sur le contrat.

Le vocabulaire standard (41 codes)

Les libellés sont les valeurs françaises par défaut — les vôtres font foi dans label.

documentTypeLibellé par défaut
prescriptionOrdonnance
bloodTestAnalyse sanguine
careSheetFeuille de soin
medicalReportCompte rendu
questionnaireQuestionnaire
convocationConvocation
otherAutre (valeur par défaut / types inconnus)
mutualInsuranceCardCarte Mutuelle
workAccidentCertificateAttestation Accident Travail
occupationalDiseaseCertificateAttestation Maladie professionnelle
cssRightsCertificateAttestation de droits CSS
urineTestAnalyse d'urine
signedConsentConsentement signé
cardiologistLetterLettre cardiologue
bhcgResultsRésultats BHCG
coagulationResultsRésultats coag
creatinineResultsRésultats créatinémie
calciumResultsRésultats calcémie
psaResultsRésultats PSA
t21ScreeningResultsRésultats dépistage combiné T21
implantCardCarte DMI
hospitalizationFormBon hospi
careAuthorizationAutorisation soins mineurs / majeurs protégés
implantCompatibilityFormFiche compatibilité DMI
implantSurgeryReportCR opératoire pose DMI
mriQuestionnaireQuestionnaire IRM
kneeQuestionnaireQuestionnaire genou
endometriosisQuestionnaireQuestionnaire endométriose
ctScanQuestionnaireQuestionnaire scanner
spineQuestionnaireQuestionnaire rachis
shoulderQuestionnaireQuestionnaire épaule
boneDensitometryQuestionnaireQuestionnaire Ostéodensitométrie
pediatricExamFollowUpFormFiche de suivi examen pédiatrique
quoteDevis
staffReviewFormFiche retour de Staff
pathologyResultsRésultats Anapath
mammographyQuestionnaireQuestionnaire Mammo
skullQuestionnaireQuestionnaire Crâne
pelvicUltrasoundReportCompte Rendu Échographie Pelvienne
lumbarMriReportCompte rendu IRM lombaire de moins de 6 mois
cervicalMriReportCompte rendu IRM cervical de moins de 3 mois