The UgandaEMR Sync Module provides comprehensive data sharing and health information exchange (HIE) capabilities for OpenMRS installations. It enables seamless interoperability between facility-level EMR systems and external health information systems using FHIR (Fast Healthcare Interoperability Resources) standards.
- FHIR-based Data Exchange: HL7 FHIR R4 standard for healthcare data interoperability
- Multi-system Integration: Connect with DHIS2, central servers, lab systems, and other HIEs
- National DWH: Advanced disease surveillance and reporting capabilities
- Resource-based Sync: Flexible FHIR resource synchronization profiles
- Bi-directional Communication: Send data to and receive data from external systems
- Secure & Reliable: Enterprise-grade security with circuit breaker patterns and retry mechanisms
Complete documentation is available in the docs/ folder.
- Getting Started - 15-minute installation guide ⭐
- Home - Complete module overview and features
- API Reference - REST API documentation
- Configuration - Configuration options and settings
- FHIR Profiles - FHIR profile configuration guide
- Troubleshooting - Common issues and solutions
- Development - Developer guide and contribution
- Security - Security considerations and best practices
- CHANGELOG - Version history and changes
| 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 |
# 1. Download the latest OAM file
wget https://github.com/METS-Programme/openmrs-module-ugandaemr-sync/releases/download/v2.0.5/openmrs-module-ugandaemr-sync-2.0.5.oam
# 2. Upload via OpenMRS Admin UI
# Navigate to: Administration → Manage Modules → Add Module
# Select the downloaded OAM file and click "Upload"
# 3. Configure global properties
# Navigate to: Administration → Advanced Settings → Global Properties
ugandaemrsync.healthCenterSyncId = YOUR_FACILITY_ID
ugandaemrsync.protocol = https
# 4. Create your first FHIR profile
curl -X POST \
https://your-openmrs/openmrs/ws/rest/v1/syncfhirprofile \
-H 'Content-Type: application/json' \
-u admin:Admin123 \
-d '{
"name": "Patient Data Sync",
"description": "Sync patient demographics and encounters",
"resourceTypes": "Patient,Encounter,Observation",
"profileEnabled": true,
"url": "https://central-server.health.gov/fhir",
"urlUserName": "facility-id",
"urlPassword": "api-key"
}'For detailed installation instructions, see the Getting Started guide.
- FHIR Profile Management: Resource-based and case-based profiles with flexible scheduling
- Data Exchange Capabilities: Push/pull data to central servers, DHIS2, lab systems
- Advanced Scheduling: Anti-blocking protection with priority-based execution
- Security & Compliance: Role-based access control, audit logging, HIPAA-compliant
- Developer-Friendly: REST APIs, extensive documentation, community support
For complete feature list, see the module overview.
- OpenMRS Platform 2.7.0 or higher
- Administrator access to OpenMRS
- MySQL 5.7+ or PostgreSQL 9.6+
- Java 8 or higher
- Download the latest OAM file from releases
- Upload via OpenMRS Admin UI (Administration → Manage Modules → Add Module)
- Configure global properties
- Set up scheduled tasks
For detailed installation instructions, see the Getting Started guide.
curl -X POST \
https://your-openmrs/openmrs/ws/rest/v1/syncfhirprofile \
-H 'Content-Type: application/json' \
-u admin:Admin123 \
-d '{
"name": "Central Server Sync",
"resourceTypes": "Patient,Encounter,Observation",
"profileEnabled": true,
"url": "https://central-server.health.gov/fhir",
"urlUserName": "your-facility-id",
"urlPassword": "your-api-key",
"syncLimit": 1000
}'curl -X POST \
https://your-openmrs/openmrs/ws/rest/v1/syncfhirprofile \
-H 'Content-Type: application/json' \
-u admin:Admin123 \
-d '{
"name": "HIV Case Surveillance",
"isCaseBasedProfile": true,
"caseBasedPrimaryResourceType": "Condition",
"resourceTypes": "Patient,Condition,Observation,Encounter",
"profileEnabled": true,
"scheduleEnabled": true,
"fixedRateInterval": 3600000,
"executionPriority": 1
}'For more usage examples, see the Getting Started guide.
- docs/ - Complete documentation
- API Reference - REST API documentation
- Troubleshooting - Common issues and solutions
- GitHub Issues: Report bugs or request features
- OpenMRS Talk: Community discussions
- METS Programme: Professional support
We welcome contributions! Please see the Development Guide for details on how to contribute to this project.
This project is licensed under the Mozilla Public License 2.0 - see the LICENSE file for details.
- Current Version: 2.0.6-SNAPSHOT
- Minimum OpenMRS Version: 2.7.0
- FHIR Version: R4
- Maintainer: METS Programme
For complete documentation, visit the docs/ folder.