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.
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.
/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.
| documentType | Libellé par défaut |
|---|---|
prescription | Ordonnance |
bloodTest | Analyse sanguine |
careSheet | Feuille de soin |
medicalReport | Compte rendu |
questionnaire | Questionnaire |
convocation | Convocation |
other | Autre (valeur par défaut / types inconnus) |
mutualInsuranceCard | Carte Mutuelle |
workAccidentCertificate | Attestation Accident Travail |
occupationalDiseaseCertificate | Attestation Maladie professionnelle |
cssRightsCertificate | Attestation de droits CSS |
urineTest | Analyse d'urine |
signedConsent | Consentement signé |
cardiologistLetter | Lettre cardiologue |
bhcgResults | Résultats BHCG |
coagulationResults | Résultats coag |
creatinineResults | Résultats créatinémie |
calciumResults | Résultats calcémie |
psaResults | Résultats PSA |
t21ScreeningResults | Résultats dépistage combiné T21 |
implantCard | Carte DMI |
hospitalizationForm | Bon hospi |
careAuthorization | Autorisation soins mineurs / majeurs protégés |
implantCompatibilityForm | Fiche compatibilité DMI |
implantSurgeryReport | CR opératoire pose DMI |
mriQuestionnaire | Questionnaire IRM |
kneeQuestionnaire | Questionnaire genou |
endometriosisQuestionnaire | Questionnaire endométriose |
ctScanQuestionnaire | Questionnaire scanner |
spineQuestionnaire | Questionnaire rachis |
shoulderQuestionnaire | Questionnaire épaule |
boneDensitometryQuestionnaire | Questionnaire Ostéodensitométrie |
pediatricExamFollowUpForm | Fiche de suivi examen pédiatrique |
quote | Devis |
staffReviewForm | Fiche retour de Staff |
pathologyResults | Résultats Anapath |
mammographyQuestionnaire | Questionnaire Mammo |
skullQuestionnaire | Questionnaire Crâne |
pelvicUltrasoundReport | Compte Rendu Échographie Pelvienne |
lumbarMriReport | Compte rendu IRM lombaire de moins de 6 mois |
cervicalMriReport | Compte rendu IRM cervical de moins de 3 mois |
