Skip to content
Docs
Contact Us

Glossary

Glossary

Section titled “Glossary”

Quick reference for terminology used throughout the MirthSync documentation. Terms are organized alphabetically and cover both MirthSync-specific concepts and general Mirth Connect/OIE terminology.

A

Section titled “A”

Admin Console

Section titled “Admin Console”

The graphical user interface for managing Mirth Connect or OIE servers. Access it via web browser at https://your-server:8443. MirthSync provides an alternative workflow using files and Git instead of the Admin Console.

C

Section titled “C”

Channel

Section titled “Channel”

The fundamental unit of integration in Mirth Connect. A channel receives messages from a source, processes them through filters and transformers, and sends them to one or more destinations. Each channel has a unique ID and name.

Channel Group

Section titled “Channel Group”

A folder-like container for organizing related channels. Groups help manage large numbers of channels by categorizing them (e.g., “ADT Channels”, “Lab Results”, “Production”).

Code Template

Section titled “Code Template”

Reusable JavaScript code that can be shared across multiple channels. Code templates reduce duplication and make it easier to update common logic in one place.

Configuration Map

Section titled “Configuration Map”

Key-value pairs stored on the Mirth server for environment-specific settings. Use configuration maps to store database URLs, API keys, and other values that differ between environments.

Connector

Section titled “Connector”

A component that sends or receives data. Each channel has one source connector (receives messages) and one or more destination connectors (sends messages).

D

Section titled “D”

Deploy

Section titled “Deploy”

The process of activating channel changes on a Mirth server. After modifying a channel, you must deploy it for changes to take effect. MirthSync’s --deploy flag handles this automatically.

Destination

Section titled “Destination”

Where a channel sends processed messages. Common destinations include databases, HTTP endpoints, file systems, and other Mirth channels.

Disk Mode

Section titled “Disk Mode”

MirthSync configuration that controls how files are organized on disk. Options:

  • Flat: All channels in a single directory
  • Grouped: Channels organized by channel group folders

E

Section titled “E”

Embedded Git

Section titled “Embedded Git”

Git functionality built into MirthSync CLI. No separate Git installation required—all mirthsync git commands use the embedded binary.

F

Section titled “F”

FHIR

Section titled “FHIR”

Fast Healthcare Interoperability Resources. A modern standard for exchanging healthcare information electronically. Mirth Connect can transform between FHIR and other formats like HL7v2.

Filter

Section titled “Filter”

A rule that determines whether a message should be processed. Filters run before transformers and can accept or reject messages based on content.

G

Section titled “G”

Global Scripts

Section titled “Global Scripts”

JavaScript code that runs at specific points in the Mirth server lifecycle:

  • Deploy Script: Runs when channels are deployed
  • Undeploy Script: Runs when channels are undeployed
  • Preprocessor Script: Runs before each message is processed
  • Postprocessor Script: Runs after each message is processed
  • Shutdown Script: Runs when the server stops

H

Section titled “H”

HL7

Section titled “HL7”

Health Level Seven International standard for healthcare data exchange. HL7v2 messages are the most common format processed by Mirth Connect channels.

I

Section titled “I”

Infrastructure as Code (IaC)

Section titled “Infrastructure as Code (IaC)”

The practice of managing infrastructure through version-controlled files rather than manual processes. MirthSync brings IaC principles to Mirth Connect by converting server configurations to files.

M

Section titled “M”

Message

Section titled “Message”

A unit of data processed by a channel. Messages flow from source → filters → transformers → destinations. Each message has a unique ID and can be tracked through the message history.

MirthSync CLI

Section titled “MirthSync CLI”

The command-line interface for MirthSync. Includes embedded Git and provides commands for pull, push, and git operations.

MLLP

Section titled “MLLP”

Minimal Lower Layer Protocol. A framing protocol used to transmit HL7v2 messages over TCP/IP. Wraps messages with start/end characters for reliable delivery.

MirthSync Plugin

Section titled “MirthSync Plugin”

A graphical extension for the Mirth Connect Admin Console. Provides the same functionality as the CLI through a point-and-click interface.

O

Section titled “O”

OIE (Open Integration Engine)

Section titled “OIE (Open Integration Engine)”

The community-maintained fork of open-source Mirth Connect. After NextGen discontinued open-source Mirth Connect development, OIE continues the project. MirthSync fully supports both platforms.

P

Section titled “P”

Pull

Section titled “Pull”

MirthSync command that downloads configurations from a Mirth server to local files. Creates or updates the file-based representation of your server’s channels, code templates, and settings.

Terminal window
./mirthsync.sh pull -s https://server:8443/api -u admin -t ./mirth-config

Push

Section titled “Push”

MirthSync command that uploads local file configurations to a Mirth server. Applies your file-based changes to the target server.

Terminal window
./mirthsync.sh push -s https://server:8443/api -u admin -t ./mirth-config

R

Section titled “R”

Resources

Section titled “Resources”

Server-level assets like JAR files, scripts, and certificates that channels can reference. Resources are stored in the Mirth database and can be version-controlled with MirthSync.

REST API

Section titled “REST API”

The HTTP interface for programmatically interacting with Mirth Connect. MirthSync uses the REST API (typically at port 8443) to pull and push configurations.

S

Section titled “S”

Source

Section titled “Source”

Where a channel receives incoming messages. Common sources include TCP/MLLP listeners, HTTP endpoints, file directories, and database queries.

T

Section titled “T”

Transformer

Section titled “Transformer”

JavaScript code that modifies message content or extracts data. Transformers run after filters and can:

  • Map data between formats
  • Extract values to channel/global maps
  • Modify message structure
  • Call external services

V

Section titled “V”

Version Control

Section titled “Version Control”

The practice of tracking changes to files over time using systems like Git. MirthSync enables version control for Mirth Connect configurations by converting them to files that can be committed, branched, and merged.

X

Section titled “X”

X12

Section titled “X12”

ANSI ASC X12 standard for electronic data interchange (EDI). Used for healthcare claims (837), eligibility (270/271), and other administrative transactions. Mirth Connect can parse and generate X12 messages.

XML

Section titled “XML”

Extensible Markup Language. A structured data format used by Mirth Connect for channel definitions, code templates, and many healthcare standards including CDA and FHIR.

Section titled “Related Resources”