Skip to content
Docs
Contact Us

Mirth Connect & OIE FAQ

Answers to the most common Mirth Connect and Open Integration Engine (OIE) questions from our healthcare IT experts. Whether you are running the commercial version of Mirth Connect or the community-maintained OIE fork, the guidance below applies to both platforms unless noted otherwise.

Open Integration Engine (OIE)

Section titled “Open Integration Engine (OIE)”
Does this documentation apply to Open Integration Engine (OIE)?

Yes. OIE is a community fork of the open-source Mirth Connect codebase. All troubleshooting, channel development, and configuration guidance in this FAQ applies to both Mirth Connect and Open Integration Engine.

The underlying architecture, API, channel model, and connector framework are the same across both platforms. Any differences are noted where relevant.

What is the difference between OIE and commercial Mirth Connect?

Open Integration Engine (OIE) is the community-maintained open-source fork created after NextGen Healthcare made Mirth Connect commercial-only in March 2025. Here is how they compare:

OIE (Open Integration Engine):

  • Free and open-source under the same license as the original Mirth Connect
  • Community-driven development and security patches
  • Active contributor community
  • Same core integration engine, channel model, and connector framework

Commercial Mirth Connect (NextGen):

  • Requires a paid license from NextGen Healthcare
  • Proprietary features and vendor support
  • Commercial SLA and professional services
  • Bundled with NextGen’s broader product ecosystem

The bottom line: If you need open-source flexibility and community support, OIE is the path forward. If you need vendor-backed SLAs and commercial support, NextGen’s commercial offering is available.

How do I migrate from Mirth Connect to OIE?

Migration from open-source Mirth Connect to OIE is straightforward because OIE uses the same configuration format:

  1. Export channels and configurations from your existing Mirth Connect instance
  2. Install OIE from the OIE GitHub repository
  3. Import your channels into the new OIE instance
  4. Verify connectors and transformations — they should work without modification
  5. Update MirthSync (if used) — simply point your server URL to the new OIE instance
Where can I download OIE?

OIE is available on GitHub at https://github.com/kayyagari/connect. It is a direct fork of the open-source Mirth Connect codebase.

Download the latest release from the Releases page, or build from source using the instructions in the repository README.

Installation & Setup

Section titled “Installation & Setup”
What are the system requirements for Mirth Connect and OIE?

Minimum Requirements:

  • Java: OpenJDK 8 or Oracle JDK 8 (or higher)
  • RAM: 2GB minimum, 4GB recommended
  • Disk Space: 1GB for installation, additional space for logs and data
  • Database: MySQL, PostgreSQL, SQL Server, or Oracle (for production)

Recommended Production Setup:

  • Java: OpenJDK 11 or higher
  • RAM: 8GB or more
  • CPU: 4+ cores
  • Database: Dedicated database server
  • Load Balancer: For high availability setups

These requirements are the same for both Mirth Connect and OIE.

How do I install Mirth Connect or OIE?

For Mirth Connect:

  1. Download the latest version from NextGen Healthcare
  2. Install Java if not already installed
  3. Run the installer and follow the setup wizard
  4. Configure database connection (MySQL recommended for production)
  5. Start the service and access the Administrator at http://localhost:8080

For OIE:

  1. Download the latest release from GitHub
  2. Install Java (OpenJDK 11+ recommended)
  3. Extract the archive and run the installer
  4. Configure database connection
  5. Start the service and access the Administrator at http://localhost:8080

The installation process is nearly identical for both platforms.

Can Mirth Connect or OIE run in the cloud?

Yes. Both Mirth Connect and OIE can be deployed on any major cloud platform:

  • AWS EC2 with RDS database
  • Azure Virtual Machines with Azure SQL
  • Google Cloud Platform with Cloud SQL
  • Docker containers for containerized deployments
  • Kubernetes for orchestrated deployments

Cloud deployments follow the same configuration patterns as on-premise installations. The main considerations are network security (VPC configuration, security groups), database connectivity, and TLS certificate management.

Learn about our cloud deployment services

Channel Development

Section titled “Channel Development”
What is the difference between Source and Destination connectors?

Source Connectors:

  • Receive or retrieve data from external systems
  • Examples: File Reader, Database Reader, HTTP Listener, TCP Listener
  • Only one source connector per channel

Destination Connectors:

  • Send or write data to external systems
  • Examples: File Writer, Database Writer, HTTP Sender, TCP Sender
  • Multiple destination connectors allowed per channel

This connector model is identical in Mirth Connect and OIE.

How do I handle HL7 messages in Mirth Connect and OIE?

Both platforms have built-in HL7 support:

  1. Use HL7 v2.x Reader/Writer connectors

  2. Enable HL7 parsing in the source connector

  3. Access HL7 segments using dot notation:

    Accessing HL7 fields
    var patientName = msg['PID']['PID.5']['PID.5.1'].toString();
    var patientID = msg['PID']['PID.3']['PID.3.1'].toString();

  4. Transform messages using the built-in mapper or JavaScript

How do I debug channels?

Debugging Techniques:

  1. Use Logger Statements:

    Logger examples
    logger.info('Processing message: ' + msg);
    logger.error('Error occurred: ' + error);

  2. Enable Channel Logging:

    • Set log level to DEBUG in channel settings
    • Monitor the Dashboard for real-time statistics

  3. Use Message Templates:

    • Create test messages in the channel editor
    • Test transformations step by step

  4. Check Error Logs:

    • Review channel-specific error logs
    • Check the main Mirth log file (mirth.log)
What is the best way to handle errors in channels?

Error Handling Best Practices:

  1. Use Try-Catch Blocks:

    Error handling pattern
    try {
        // Your transformation code
        var result = processMessage(msg);
    } catch (error) {
        logger.error('Transformation failed: ' + error);
        // Handle error appropriately
    }

  2. Configure Error Destinations:

    • Set up dedicated error handling destinations
    • Route failed messages to error queues

  3. Implement Retry Logic:

    • Use channel-level retry settings
    • Implement custom retry mechanisms for specific scenarios

  4. Monitor and Alert:

    • Set up alerts for channel failures
    • Monitor error rates and patterns

Integration Patterns

Section titled “Integration Patterns”
How do I integrate Mirth Connect or OIE with Epic EHR?

Epic integration typically involves:

  1. HL7 Interfaces:

    • ADT (Patient Administration)
    • ORU (Lab Results)
    • ORM (Orders)

  2. Web Services:

    • Epic’s MyChart API
    • FHIR R4 endpoints
    • Custom web services

  3. File-Based Integration:

    • CSV/XML file exchanges
    • Scheduled batch processing

Both Mirth Connect and OIE support all of these integration patterns. The channel configuration is identical regardless of which platform you use.

Learn more about Epic integration

Can Mirth Connect and OIE handle FHIR?

Yes. Both platforms support FHIR:

  • FHIR R4 support built-in
  • FHIR Listener connector for receiving FHIR resources
  • FHIR Sender connector for sending FHIR resources
  • Built-in FHIR validation and transformation tools
  • JSON and XML format support
How do I implement real-time vs batch processing?

Real-time Processing:

  • Use TCP/HTTP listeners
  • Process messages as they arrive
  • Immediate response to source systems
  • Best for: ADT events, lab results, critical alerts

Batch Processing:

  • Use File Reader with polling
  • Database Reader with scheduled queries
  • Process multiple messages together
  • Best for: High-volume non-urgent data, nightly reconciliation, bulk data loads

Both approaches work identically in Mirth Connect and OIE.

Performance & Scaling

Section titled “Performance & Scaling”
How many messages can Mirth Connect or OIE handle?

Performance depends on several factors, but typical benchmarks:

Workload TypeThroughput
Simple transformations1,000+ messages/second
Complex transformations100–500 messages/second
Database operations50–200 messages/second

Optimization Strategies:

  • Use connection pooling
  • Optimize JavaScript transformations
  • Implement message batching
  • Scale horizontally with multiple instances
How do I optimize Mirth Connect or OIE performance?

Performance Tuning Tips:

  1. JVM Tuning:

    JVM memory settings
    -Xmx4g -Xms2g -XX:+UseG1GC

  2. Database Optimization:

    • Use connection pooling
    • Optimize queries and indexes
    • Consider read replicas for reporting

  3. Channel Optimization:

    • Minimize JavaScript complexity
    • Use appropriate connector types
    • Implement proper error handling

  4. System Resources:

    • Adequate RAM and CPU allocation
    • Fast storage (SSD recommended)
    • Sufficient network bandwidth

For detailed guidance, see our Troubleshooting Guide.

Can I run multiple Mirth Connect or OIE instances?

Yes. For high availability and load distribution:

Clustering Options:

  • Active-Passive: Failover setup with shared database
  • Active-Active: Load balancing with message routing
  • Horizontal Scaling: Multiple instances handling different channels

Requirements:

  • Shared database for configuration
  • Load balancer for traffic distribution
  • Proper message routing strategy

Security

Section titled “Security”
How do I secure Mirth Connect and OIE?

Security Best Practices:

  1. Network Security:

    • Use HTTPS/TLS for all connections
    • Implement firewall rules
    • VPN for remote access

  2. Authentication:

    • Strong passwords for all accounts
    • LDAP/Active Directory integration
    • Multi-factor authentication

  3. Data Encryption:

    • Encrypt data at rest
    • Use TLS for data in transit
    • Secure key management

  4. Access Control:

    • Role-based permissions
    • Principle of least privilege
    • Regular access reviews

These practices apply to both Mirth Connect and OIE deployments.

How do I implement SSL/TLS?

SSL/TLS Configuration:

  1. Generate or Obtain Certificates:

    Generate a self-signed certificate
    keytool -genkey -alias mirth -keyalg RSA -keysize 2048 -keystore keystore.jks

  2. Configure HTTPS Listener:

    • Import certificate into Java keystore
    • Configure connector with SSL settings
    • Test connection with SSL client

  3. Client Certificate Authentication (Mutual TLS):

    • Configure mutual TLS in the connector settings
    • Import client certificates into the truststore
    • Validate certificate chains

Troubleshooting

Section titled “Troubleshooting”
Why is my channel not processing messages?

Common Causes:

  1. Channel Not Started: Check channel status in the Dashboard
  2. Source Configuration: Verify source connector settings (port, path, polling interval)
  3. Permissions: Check file system or database permissions
  4. Network Issues: Test connectivity to source systems
  5. Transformation Errors: Review error logs for JavaScript issues

For more detailed solutions, visit our Troubleshooting Guide.

How do I backup and restore Mirth Connect or OIE?

Backup Strategy:

  1. Configuration Backup:

    • Export channels, code templates, and global scripts
    • Use MirthSync for automated Git-based version control
    • Schedule regular automated backups

  2. Database Backup:

    • Backup the Mirth configuration database
    • Include message storage if using database persistence
    • Test restore procedures regularly

  3. File System Backup:

    • Backup custom libraries and extensions
    • Include log files for audit purposes
    • Document custom configurations

Getting Help

Section titled “Getting Help”
Where can I find more Mirth Connect and OIE resources?

Official Resources:

Saga IT Resources:

When should I consider professional support?

Consider professional support for:

  • Complex Integration Projects — Multi-system integrations involving Epic, Cerner, or multiple data formats
  • Performance Optimization — High-volume message processing and throughput tuning
  • Security Implementation — HIPAA compliance, security hardening, and TLS configuration
  • OIE Migration — Moving from commercial Mirth Connect to Open Integration Engine
  • Custom Development — Specialized connectors, transformations, and workflow automation
  • Training — Team onboarding and best practices adoption

Contact Saga IT for expert Mirth Connect and OIE support