Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

UgandaEMR Sync Module Documentation

Complete documentation for the UgandaEMR Sync Module.

📚 Documentation Overview

The UgandaEMR Sync Module documentation is organized to serve different audiences and use cases.

🎯 Quick Navigation

Document Audience Purpose Reading Time
Getting Started New users Fast setup guide 15 min
Home All users Complete module overview 20 min
API Reference Developers REST API documentation 30 min
Development Developers Development and contribution 45 min
CHANGELOG All users Version history and changes 15 min

📖 Documentation by Category

Getting Started

Core Documentation

Specialized Guides

Development & Support

Reference

🎯 By Audience

For System Administrators

Start With: Getting Started → Configuration

Key Topics:

  • Installation and setup
  • Configuration management
  • User privileges
  • Monitoring and troubleshooting
  • Security setup
  • Performance tuning

For Healthcare Developers

Start With: API Reference → Development

Key Topics:

  • REST API integration
  • FHIR resource handling
  • Custom integrations
  • Extension development
  • Testing and validation

For Clinical Staff

Start With: Getting Started → Use Cases section

Key Topics:

  • Understanding what data is shared
  • How to request lab results
  • Referral management
  • Case surveillance
  • Troubleshooting common issues

For Project Managers

Start With: Home → CHANGELOG

Key Topics:

  • Module capabilities and features
  • Integration possibilities
  • Version planning
  • Support lifecycle
  • Risk assessment

🔧 Common Tasks

Task 1: Install and Configure

  1. Read Getting Started - Installation (5 min)
  2. Follow Configuration - Configuration section
  3. Set up security per Security

Task 2: Create FHIR Profile

  1. Understand profiles from Home - Core Components
  2. Use examples from Getting Started - Use Cases
  3. Reference API endpoints in API Reference

Task 3: Troubleshoot Issues

  1. Check Troubleshooting - Common issues
  2. Review Getting Started - Troubleshooting section
  3. Enable debug logging per Development - Debugging

Task 4: Integrate with External System

  1. Understand architecture from Architecture
  2. Review API endpoints in API Reference
  3. Follow integration examples in Getting Started

Task 5: Develop New Feature

  1. Read Development - Development Environment Setup
  2. Understand architecture from Architecture
  3. Follow coding guidelines in Development

Task 6: Upgrade Module

  1. Check CHANGELOG for target version
  2. Review migration guides in CHANGELOG
  3. Follow upgrade instructions in Getting Started

📊 Documentation Metrics

Metric Value
Total Documentation Pages 16
Total Code Examples 150+
Total Use Cases 20+
Average Reading Time (All) 2 hours
Quick Start Time 15 minutes

🔄 Document Relationships

README.md (Main Hub)
    ├─→ docs/Getting-Started.md (Fast Setup)
    │   └─→ Examples from Home.md
    │   └─→ Troubleshooting from Troubleshooting.md
    │
    ├─→ docs/API_REFERENCE.md (API Documentation)
    │   └─→ API design from Architecture.md
    │   └─→ Examples for Getting Started.md Use Cases
    │
    ├─→ docs/Development.md (Developer Guide)
    │   └─→ Architecture from Architecture.md
    │   └─→ Implementation details for API Reference
    │
    └─→ docs/CHANGELOG.md (Version History)
        └─→ Version updates mentioned in Home.md
        └─→ Migration guides for Developers

📝 Reading Paths

Path 1: Evaluation (30 minutes)

  1. Home - Overview and Features (15 min)
  2. Getting Started - Installation (10 min)
  3. API Reference - Browse endpoints (5 min)

Path 2: Implementation (2 hours)

  1. Getting Started - Full setup (15 min)
  2. Configuration - Configuration (20 min)
  3. API Reference - Required endpoints (30 min)
  4. Getting Started - Use Cases (15 min)
  5. Security - Security (10 min)
  6. Practice and testing (30 min)

Path 3: Development (4 hours)

  1. Architecture - Architecture (30 min)
  2. Development - Environment Setup (45 min)
  3. Architecture - Core Components (45 min)
  4. API Reference - Endpoints (30 min)
  5. Development - Adding Features (30 min)
  6. Development practice (30 min)

Path 4: Expert/Reference (Ongoing)

  1. Home - Reference as needed
  2. API Reference - Look up endpoints
  3. Development - Implementation details
  4. CHANGELOG - Version information

🆘 Getting Help

Documentation Issues

  • Typo Found: Edit directly on GitHub
  • Missing Information: Create GitHub issue
  • Confusing Section: Create GitHub issue with suggestions

Technical Issues

Community Support

  • GitHub Issues: Technical problems and feature requests
  • OpenMRS Talk: Community discussions
  • METS Programme: Professional support contact

📈 Documentation Quality

Coverage

  • ✅ Installation and setup
  • ✅ Configuration and management
  • ✅ API reference
  • ✅ Development guide
  • ✅ Troubleshooting
  • ✅ Security best practices
  • ✅ Performance optimization
  • ✅ Version migration

Quality Metrics

  • ✅ Code examples for all major features
  • ✅ Diagrams for complex concepts
  • ✅ Step-by-step instructions
  • ✅ Copy-paste ready examples
  • ✅ Troubleshooting guides
  • ✅ Cross-references between documents

Maintenance

  • Documentation updated with each release
  • Community contributions welcome
  • Regular reviews for accuracy
  • Feedback integration

🎓 Learning Path

Beginner (New to Module)

  1. Start with Home - Overview
  2. Follow Getting Started - Installation
  3. Try examples in Getting Started - Use Cases
  4. Reference API Reference as needed

Intermediate (Regular User)

  1. Review Home - Complete understanding
  2. Master API Reference - All endpoints
  3. Learn troubleshooting in Troubleshooting
  4. Stay updated with CHANGELOG

Advanced (Developer/Expert)

  1. Study Development - Architecture
  2. Contribute using Development - Guidelines
  3. Deep dive into API Reference - All features
  4. Follow CHANGELOG - Version planning

📋 Document Checklist

For New Installations

For Development Work

  • Set up environment per Development
  • Understand architecture from Architecture
  • Review code style guidelines
  • Study testing strategy
  • Practice with examples

For Production Deployment

  • Complete testing in development
  • Review security checklist in Security
  • Set up monitoring per Getting Started
  • Prepare troubleshooting procedures
  • Review CHANGELOG for version info

🔗 External Resources

OpenMRS Resources

FHIR Resources

Community

📞 Support Contacts

Documentation Feedback

Technical Support

  • GitHub Issues: Bug reports and feature requests
  • OpenMRS Talk: Community support
  • METS Programme: Enterprise support

Training

  • On-site Training: Contact METS Programme
  • Online Training: Check OpenMRS Academy
  • Custom Training: Available upon request

Documentation Version: 2.0.6-SNAPSHOT
Last Updated: May 2, 2026
Maintained By: METS Programme Documentation Team

📝 Quick Links

What You Need Where to Look
"I'm new here" Home
"Get me started fast" Getting Started
"API documentation" API Reference
"I want to contribute" Development
"What's new?" CHANGELOG
"Something's broken" Troubleshooting
"How do I integrate?" API Reference
"Performance issues" Configuration → Performance Tuning
"Security setup" Security