21 KiB
21 KiB
📖 Aperçu de la Nouvelle Page Documentation
🎯 Accès
URL : http://localhost:4400/documentation
Menu : Cliquez sur "📖 Documentation" dans la barre latérale
🖼️ Aperçu Visuel (Représentation Textuelle)
┌─────────────────────────────────────────────────────────────────────────────┐
│ OMOP Pipeline │
├─────────────────────────────────────────────────────────────────────────────┤
│ │
│ 📊 Dashboard ┌──────────────────────────────────────────────────┐ │
│ ⚙️ ETL Manager │ 📖 Documentation (?) │ │
│ 🗄️ Schema │ Guide complet d'utilisation de OMOP Pipeline │ │
│ ✅ Validation │ │ │
│ 📝 Logs │ ┌─────────────┐ ┌──────────────────────────┐ │ │
│ 📖 Documentation ◄──┤ │ Sections │ │ │ │ │
│ │ ├─────────────┤ │ Vue d'ensemble │ │ │
│ │ │ 📖 Vue │ │ ═══════════════ │ │ │
│ │ │ d'ensemble│ │ │ │ │
│ │ │ │ │ Bienvenue dans OMOP │ │ │
│ │ │ ⚙️ ETL │ │ Pipeline │ │ │
│ │ │ │ │ │ │ │
│ │ │ 🗄️ Schémas │ │ Cette application vous │ │ │
│ │ │ │ │ permet de transformer │ │ │
│ │ │ ✅ Validation│ │ vos données... │ │ │
│ │ │ │ │ │ │ │
│ │ │ 📚 Glossaire│ │ ┌────────────────────┐ │ │ │
│ │ │ │ │ │ 🎯 Objectif │ │ │ │
│ │ │ ❓ FAQ │ │ │ │ │ │ │
│ │ └─────────────┘ │ │ Le pipeline OMOP │ │ │ │
│ │ │ │ standardise vos │ │ │ │
│ │ │ │ données... │ │ │ │
│ │ │ └────────────────────┘ │ │ │
│ │ │ │ │ │
│ │ │ ┌────────────────────┐ │ │ │
│ │ │ │ 🔄 Workflow │ │ │ │
│ │ │ │ │ │ │ │
│ │ │ │ 1. Staging │ │ │ │
│ │ │ │ 2. ETL │ │ │ │
│ │ │ │ 3. Validation │ │ │ │
│ │ │ │ 4. Exploitation │ │ │ │
│ │ │ └────────────────────┘ │ │ │
│ │ └──────────────────────────┘ │ │
│ └──────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────────────────────┘
📋 Sections Disponibles
1. 📖 Vue d'ensemble
┌────────────────────────────────────────┐
│ Bienvenue dans OMOP Pipeline │
├────────────────────────────────────────┤
│ │
│ Cette application transforme vos │
│ données de santé en format OMOP CDM │
│ │
│ ┌────────────────────────────────┐ │
│ │ 🎯 Objectif │ │
│ │ Standardiser les données pour │ │
│ │ analyses interopérables │ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 🔄 Workflow Général │ │
│ │ 1. Staging │ │
│ │ 2. ETL │ │
│ │ 3. Validation │ │
│ │ 4. Exploitation │ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 📊 Architecture │ │
│ │ • Schéma OMOP │ │
│ │ • Schéma Staging │ │
│ │ • Schéma Audit │ │
│ └────────────────────────────────┘ │
└────────────────────────────────────────┘
2. ⚙️ ETL (Extract-Transform-Load)
┌────────────────────────────────────────┐
│ Processus ETL │
├────────────────────────────────────────┤
│ │
│ ETL = Extract-Transform-Load │
│ │
│ ┌────────────────────────────────┐ │
│ │ 1️⃣ Extract (Extraction) │ │
│ │ │ │
│ │ • Tables source │ │
│ │ • Status 'pending' │ │
│ │ • Traitement par lots │ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 2️⃣ Transform (Transformation) │ │
│ │ │ │
│ │ • Mapping des codes │ │
│ │ • Normalisation │ │
│ │ • Enrichissement │ │
│ │ • Validation │ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 3️⃣ Load (Chargement) │ │
│ │ │ │
│ │ • person │ │
│ │ • visit_occurrence │ │
│ │ • condition_occurrence │ │
│ │ • drug_exposure │ │
│ └────────────────────────────────┘ │
│ │
│ ⚡ Paramètres de Performance │
│ ┌──────────┬───────────┬──────────┐ │
│ │ Paramètre│Description│Recommand.│ │
│ ├──────────┼───────────┼──────────┤ │
│ │ Batch │ Enreg/lot │ 1000-5000│ │
│ │ Workers │ Processus │ 4-8 │ │
│ │ Séquent. │ Pas // │ Débogage │ │
│ └──────────┴───────────┴──────────┘ │
└────────────────────────────────────────┘
3. 🗄️ Schémas de Base de Données
┌────────────────────────────────────────┐
│ Architecture des Schémas │
├────────────────────────────────────────┤
│ │
│ ┌────────────────────────────────┐ │
│ │ 📦 Schéma OMOP │ │
│ │ │ │
│ │ Tables standardisées OMOP CDM │ │
│ │ │ │
│ │ • person │ │
│ │ • visit_occurrence │ │
│ │ • condition_occurrence │ │
│ │ • drug_exposure │ │
│ │ • procedure_occurrence │ │
│ │ • measurement │ │
│ │ • observation │ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 📥 Schéma Staging │ │
│ │ │ │
│ │ Zone de transit données brutes │ │
│ │ │ │
│ │ • raw_patients │ │
│ │ • raw_visits │ │
│ │ • raw_conditions │ │
│ │ • raw_drugs │ │
│ │ │ │
│ │ Status: pending/processed/failed│ │
│ └────────────────────────────────┘ │
│ │
│ ┌────────────────────────────────┐ │
│ │ 📝 Schéma Audit │ │
│ │ │ │
│ │ Traçabilité des transformations│ │
│ │ │ │
│ │ • etl_execution │ │
│ │ • etl_execution_stats │ │
│ │ • data_quality_errors │ │
│ │ • unmapped_codes │ │
│ └────────────────────────────────┘ │
└────────────────────────────────────────┘
4. ✅ Validation et Qualité
┌────────────────────────────────────────┐
│ Validation des Données │
├────────────────────────────────────────┤
│ │
│ 🎯 Objectifs │
│ • Conformité OMOP CDM 5.4 │
│ • Détection erreurs │
│ • Codes non mappés │
│ • Intégrité référentielle │
│ │
│ 🔍 Types de Validation │
│ │
│ 1. Validation Structurelle │
│ • Champs obligatoires │
│ • Types de données │
│ • Formats de dates │
│ │
│ 2. Validation Référentielle │
│ • Existence patients │
│ • Cohérence dates │
│ • Validité codes │
│ │
│ 3. Validation Métier │
│ • Âge cohérent │
│ • Genre compatible │
│ • Durées réalistes │
│ │
│ ⚠️ Codes Non Mappés │
│ │
│ Actions recommandées: │
│ 1. Vérifier code source │
│ 2. Chercher équivalent │
│ 3. Créer mapping personnalisé │
│ 4. Documenter non mappables │
└────────────────────────────────────────┘
5. 📚 Glossaire
┌────────────────────────────────────────┐
│ Glossaire des Termes │
├────────────────────────────────────────┤
│ │
│ Audit │
│ └─ Traçabilité des transformations │
│ │
│ Batch │
│ └─ Lot d'enregistrements traités │
│ │
│ CDM (Common Data Model) │
│ └─ Modèle de données standardisé │
│ │
│ Concept │
│ └─ Terme standardisé OMOP │
│ │
│ ETL │
│ └─ Extract-Transform-Load │
│ │
│ Mapping │
│ └─ Correspondance code → concept │
│ │
│ OMOP │
│ └─ Observational Medical Outcomes │
│ Partnership │
│ │
│ Staging │
│ └─ Zone temporaire données brutes │
│ │
│ Vocabulaire │
│ └─ Ensemble termes standardisés │
│ │
│ Worker │
│ └─ Processus parallèle │
└────────────────────────────────────────┘
6. ❓ FAQ
┌────────────────────────────────────────┐
│ Questions Fréquentes │
├────────────────────────────────────────┤
│ │
│ 🚀 Démarrage │
│ │
│ Q: Comment démarrer ? │
│ R: 1. Créez les schémas │
│ 2. Chargez données staging │
│ 3. Lancez pipeline ETL │
│ 4. Validez résultats │
│ │
│ Q: Données sécurisées ? │
│ R: Oui, tout reste dans votre │
│ PostgreSQL local │
│ │
│ ⚙️ ETL │
│ │
│ Q: Temps de traitement ? │
│ R: • 100 patients: ~10-30s │
│ • 1000 patients: ~1-3min │
│ • 10000 patients: ~10-30min │
│ │
│ Q: Pipeline échoue ? │
│ R: 1. Consultez logs │
│ 2. Vérifiez erreurs │
│ 3. Corrigez sources │
│ 4. Relancez │
│ │
│ 📊 Données │
│ │
│ Q: Codes non mappés ? │
│ R: Code source sans correspondance │
│ OMOP. Peut arriver si: │
│ • Code obsolète │
│ • Vocabulaire pas à jour │
│ • Mapping personnalisé nécessaire │
│ │
│ Q: Améliorer qualité ? │
│ R: 1. Validation régulière │
│ 2. Corriger codes non mappés │
│ 3. Vérifier erreurs logs │
│ 4. Données sources complètes │
└────────────────────────────────────────┘
🎨 Caractéristiques du Design
Navigation
- Menu latéral : Toujours visible, sticky
- Section active : Fond bleu (#3498db)
- Hover : Fond gris clair sur survol
- Transition : Fluide, sans rechargement
Contenu
- Cartes colorées : Fond gris clair, bordure bleue
- Titres hiérarchisés : H2 (28px), H3 (22px), H4 (18px)
- Tableaux : En-têtes bleus, lignes alternées
- Code : Fond gris, texte rouge
- Listes : Puces et numérotées, bien espacées
Couleurs
- Bleu principal : #3498db (liens, sections actives)
- Gris foncé : #2c3e50 (titres, texte important)
- Gris moyen : #7f8c8d (texte secondaire)
- Gris clair : #f8f9fa (fonds, cartes)
- Blanc : #ffffff (fond principal)
📱 Responsive
Desktop (>1024px)
┌─────────┬──────────────────┐
│ Menu │ │
│ latéral │ Contenu │
│ (250px) │ (flexible) │
│ │ │
└─────────┴──────────────────┘
Tablette/Mobile (<1024px)
┌──────────────────────────┐
│ Menu horizontal │
├──────────────────────────┤
│ │
│ Contenu │
│ (100%) │
│ │
└──────────────────────────┘
✅ Avantages
Pour les Utilisateurs
✅ Tout en un endroit : Pas besoin de chercher ailleurs
✅ Navigation facile : Clic sur section → contenu
✅ Lecture agréable : Design clair et aéré
✅ Toujours accessible : Un clic dans le menu
Pour Vous
✅ Moins de questions : Les réponses sont dans l'interface
✅ Formation simplifiée : Documentation intégrée
✅ Image professionnelle : Interface complète
✅ Maintenance facile : Code bien structuré
🎉 Résultat
Une page Documentation professionnelle qui rend votre interface OMOP :
- ✅ Auto-documentée
- ✅ Accessible à tous
- ✅ Professionnelle
- ✅ Complète
Testez-la maintenant : http://localhost:4400/documentation 🚀