Mirth Connect Documentation

Mirth Connect is an open source healthcare integration engine designed for filtering, transforming, and routing messages between disparate systems. It supports various healthcare standards and protocols, including:

Standards:

• HL7
• EDI/X12
• XML
• NCPDP
• DICOM
• Delimited Text

Protocols:

• TCP/LLP
• HTTP
• JDBC
• File/FTP/SFTP

Mirth Connect acts as an interpreter for healthcare message standards, facilitating integration through four primary capabilities:

• Filtering: Reading message parameters to decide whether to pass a message to the transformation stage or stop it.
• Transformation: Converting incoming message standards to different standards (e.g., HL7 to XML).
• Extraction: Pulling data from or pushing data to a database.
• Routing: Ensuring messages arrive at their assigned destinations.

Users manage and develop channels (message pathways) using the Administrator interface.

You can launch the Mirth Connect Administrator in several ways:

1. Windows Start Menu: Use the 'Mirth Connect Administrator' item.
2. Web Launch Page: Navigate to http://[server address]:8080 (e.g., http://localhost:8080) and click the Launch Mirth Connect Administrator button. This connects to the server listening on https://[server address]:8443.

Default Credentials:

• Username: admin
• Password: admin

Note: Change these credentials immediately after installation for security. If launching for the first time, the Administrator may load libraries automatically to allow remote management without a local installation. You may see a browser security warning; click Run to continue.

There are several ways to access the Mirth Connect Administrator:

1. Windows Start Menu: Use the Mirth Connect Administrator item if available.
2. Web Launch Page: Navigate to http://[server address]:8080 (default is http://localhost:8080).
3. Administrator Launcher (Recommended): Use the Administrator Launcher to manage connections and configure settings like Java runtime and heap size. The server listens on https://[server address]:8443 (default is https://localhost:8443).

Security Note:

• Default Credentials: The default username and password is admin / admin. Change these immediately after installation.
• SSL Certificates: By default, Mirth Connect uses a self-signed certificate. You may see a security warning in your browser; follow the User Guide to replace it with a valid certificate.

Mirth Connect installers are available for various operating systems:

• Windows: .exe or ZIP distributions.
• Linux: .rpm, .sh, or tar.gz distributions.
• Mac OS X: .dmg or tar.gz distributions.

Upgrades: The installer supports automatic upgrades for previous Mirth Connect installations (version 1.5 and later).

Optional Components:

• Service: Option to install and start a background service.
• Server Manager: Allows starting/stopping the service, changing properties and backend database settings, and viewing logs.
• Command Line Interface (CLI): Allows connecting to a running server via command line for scripting and server tasks.
• Administrator Launcher: Manages connections to multiple servers and configures Java runtime, max heap size, and security protocols.

To support Java 9 or higher, you must manually configure VM options:

For the Mirth Connect Server

1. Copy the options from docs/mcservice-java9+.vmoptions.
2. Append these options to either mcserver.vmoptions or mcservice.vmoptions (depending on your deployment).
3. Restart Mirth Connect.

For the Command Line Interface (CLI)

1. Create a new file named mccommand.vmoptions in the Mirth Connect root directory.
2. Copy all options from docs/mcservice-java9+.vmoptions into this new file.
3. Save the file before launching the CLI.

You can clear statistics for channels or the entire system.

• Reset All Statistics: Clears statistics for all channels and connectors.
• Reset Lifetime Statistics: Clears all lifetime statistics for the server.
• Reset Channel Statistics: Clears statistics for specific channels (based on the command arguments).

To interact with a Mirth Connect server, instantiate the Client class. You must provide the server address. The client supports various constructor overloads to configure timeouts, HTTPS protocols, and cipher suites. By default, the timeout is infinite.

Common constructor patterns:

• Basic: new Client(address)
• With Timeout: new Client(address, timeout, httpsProtocols, httpsCipherSuites)
• With Custom API Providers: new Client(address, timeout, httpsProtocols, httpsCipherSuites, apiProviderClasses)

import com.mirth.connect.client.core.Client;
import java.net.URISyntaxException;

// Basic initialization
Client client = new Client("http://localhost:8483");

// Initialization with specific timeout (in milliseconds)
Client clientWithTimeout = new Client("https://mirth-server:8483", 5000, protocols, ciphers);

The CLI supports importing configuration components from XML files.

Import Channels

Imports a channel from an XML file.

• If the channel ID or name already exists, the import will fail unless the --force flag is used.
• When using --force, the existing channel's revision and ID are preserved to allow overwriting.
• The process automatically handles channel dependencies.

Import Global Scripts

Imports a map of global scripts from an XML file.

Import Alerts

Imports a list of AlertModel objects from an XML file.

• Similar to channels, if an alert name already exists, it will not be imported unless --force is used.
• When using --force, the existing alert's ID is used to overwrite it.