MIRTH and Info Router Installation

Instructions for Reporting – CARESTREAM

Vue PACS v11.3.2

Part # 6K4037
2012-07-17

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 1 of 20
 Table of Contents
1 Introduction ............................................................................................................................................ 3
1.1 What You Need Before You Begin ............................................................................................... 3
2 MIRTH Administration GUI .................................................................................................................... 4
2.1 Login .............................................................................................................................................. 4
2.2 Add Customer Login ..................................................................................................................... 5
2.3 Configure/Enable a Channel ......................................................................................................... 6
2.4 Customize Channel ....................................................................................................................... 8
2.5 Transformers ............................................................................................................................... 11
3 Info Router Rules ................................................................................................................................. 15
3.1 Distribute PACS Report .............................................................................................................. 15
4 Troubleshooting MIRTH ....................................................................................................................... 16
4.1 Monitoring Message Processing ................................................................................................. 16
4.2 Deploying Channel Changes ...................................................................................................... 17
5 Document History ................................................................................................................................ 18
6 Document Contributors ........................................................................................................................ 18

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 2 of 20
1 Introduction
MIRTH Connect is an open source HL7 broker. It enables receiving, processing, and distributing data in
several known industry standards like XML, DICOM, and HL7. Within the scope of Native Reporting,
MIRTH Connect provides the ability to convert CARESTREAM Vue PACS reports from their XML format
into an HL7 format that facilitates integration with third party HIS/RIS/EMR systems.
The HL7 integration capabilities provided by MIRTH allow custom HL7 message mappings for all inbound
and outbound HL7 connections, enabling CARESTREAM Vue PACS to be integrated with most third
party HIS/RIS/EMR systems. In addition, incoming HL7 messages can be routed to multiple outbound
HL7 destinations with different custom mappings applied for each destination interface. This means that
reports that are generated in Vue PACS can be sent to multiple destinations such as an EMR and RIS as
part of the report distribution process.
MIRTH primarily interacts with the Info Router module in Vue PACS. Basically, when a study is dictated in
Vue PACS and the report is signed, this triggers an Info Router rule to gather all the details of the report
that was dictated and then pass these details (report text, radiologist name, report time etc.) to the MIRTH
application in the form of an SOAP/XML transaction. MIRTH then generates an HL7 Report message with
the details it got from the Info Router and sends it to the destination applications (RIS, EMR etc...)

1.1 What You Need Before You Begin

You will need details of the format of the HL7 that you are attempting to deliver.
• An understanding of the expected inputs to the customer’s RIS system, such as:
o The sections, and order of those sections to be delivered to the RIS.
o Any special information you may need in those reports (radiologist RIS IDs, patient or
study information, etc.).
o Understanding of information needed for Addenda (some sites want JUST the addendum
text, others want the addendum text as well as the original report data)
• HL7 format information for reports
o OBX type for reports (options include “single_obx” and “multi_obx”)

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 3 of 20
2 MIRTH Administration GUI
2.1 Login
1. Launch the MIRTH Administration GUI from a web browser or on the WFM server. Note: If you
choose to run it on the WFM server, use the following URL:
http://localhost:8014/webstart

2. You will see a few security screens, as each of the JAVA components gets added. Click Run to
continue with the install.

3. Eventually, you will be presented with a login window. Log in with the username “administrator”
and password “imaginet2000”.
4. Click Login.

5. The MIRTH Connect Administrative GUI is displayed.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 4 of 20
2.2 Add Customer Login
1. From the MIRTH Connect Administrator GUI, select Users.

2. Select New User.

3. Enter new customer login information as follows:

a. Username: mirth
b. Password: kodak200
c. Confirm Password: kodak200

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 5 of 20
 d. First Name: mirth
e. Last Name: administrator
f. Description: mirth customer login
4. Click Finish.

2.3 Configure/Enable a Channel

Note: Please consult with an integration specialist for site-specific configuration. These instructions cover
the more generic information.
1. From the MIRTH Connect Administrative GUI, select Channels from the left hand column.

2. Depending on the customer, you may need to import a custom-made channel. That can be done
from Import Channel.

3. Select a file to import.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 6 of 20
 4. After importing (or if you skip the import step), there is a list of available channels.

5. The “default” channel is named “XML2HL7LineOBXSOAP2”. Select that channel, or the channel
you just imported and either:
a. Right-click and select Enable Channel.
b. Use Enable Channel on the left section under Channel Tasks.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 7 of 20
2.4 Customize Channel
1. After logging into the MIRTH Connect Administrative GUI, select Channels from the left side of
the window.

2. Double-click on the channel to customize.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 8 of 20
 3. The channel has multiple parts, each accessible from one of the tabs across the right-side panel.
Click on the appropriate tab(s) to customize as needed:
a. Source tab
• No changes should be needed to this tab. These are the settings that control the
incoming message (from the WFM Info Router). Note the WSDL URL entry, this
will need to be copied into the Info Router distribution rule discussed later in this
document.

b. Destinations tab
• Each channel can have multiple destinations. The standard for writing to RIS
systems is named RIS LLP and should have a status of “Enabled”.
• The File System destination is handy for troubleshooting MIRTH output. It will
create files containing the HL7 message, which is sent to the RIS.
• Only a few of the settings should need to be adjusted in this tab.
1. Connector Type: LLP Sender
2. Host Address: Set this to the address of the RIS system that will be
receiving the HL7 data.
3. Host Port: Is set to the TCP/IP Port number (of the RIS) to receive HL7
messages.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 9 of 20
 4. Keep Connection Open: Set to “Yes” if the RIS system will maintain an
open connection for multiple reports.
5. Template: Will always be “$(message.encodedData)”

c. Scripts tab.
• This tab is not used.
4. If you make changes to the channel, you must save those changes using the Save Changes
option on the left side panel.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 10 of 20
 5. After saving changes, click Validate Connector to make sure that your changes are valid. You
will see a pop-up message to provide the results of the validation.

6. Assuming the connector validates, activate the changes by returning to the Channels screen.

7. IMPORTANT: For the changes in a channel to go into effect, you must select Deploy All from the
Channel Tasks menu on the left side of the screen.

2.5 Transformers
The Source and Destinations data can be manipulated with a combination of Filters and Transformers.
This section will show a little about using Transformers to make minor adjustments to the format of the
HL7 messages.
1. After logging into the MIRTH Connect Administrative GUI, select Channels from the left side of
the window.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 11 of 20
 2. Double-click on the channel to edit.

3. Select the Destinations tab. Note: You can also perform transformations on the Source, if you
want those items to be available for all destinations of the channel.

4. Select the specific destination from the middle.

5. Then select Edit Transformer from the left-side panel under Channel Tasks. You will notice the
number in parenthesis is the number of transformers defined for this.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 12 of 20
 6. Note: The transformers can perform different types of activities. “Mappers” allow you to create
variables, which can be used inside the HL7 messages. “Message Builders” help create the HL7
messages. In the example above, the Status transformer is a Mapper, which converts the
contents of the SR.TAMAR_REPORT_HAS_ADDENDUM variable to an “A”, or “F”. In an example
Message Builder transformer shown below, you can see that the study ACCESSION_NUMBER is
populated to the OBR 3.1 location in the HL7 message.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 13 of 20
 Once you have made changes, return to the Channel view, with the Back to Channel link at the top of
the left column.

7. Save your changes using the Save Changes option on the left-side panel.

8. Then use Validate Connector to make sure that your changes are valid. You will see a pop-up
message to provide the results of the validation.

9. Assuming the connector validates, you can activate the changes by returning to the Channels
screen.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 14 of 20
 10. IMPORTANT: For the changes in a channel to go into effect, you must select Deploy All from the
Channel Tasks menu on the left side of the screen.

3 Info Router Rules

3.1 Distribute PACS Report
Create or edit the Distribute PACS Report rule.
1. Click Configure next to the Formatter Type label.

2. In the HL7 Formatter Configuration dialog box, enter the path to the template file, and a
WordWrap length.
a. For WINDOWS WFM:
C:\PROGRA~1\Kodak\System5\medilink\resources\template.xml
b. For UNIX WFM:/usr/algotec/medilink/resources/template.xml
c. Note: The word wrap may be set to a very large number (because we don’t need to wrap
long lines.) Some reporting sites have set this value to 30,000 or more.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 15 of 20
 3. Click OK to return to the Distribution rule.
4. Click Configure next to the Channel Type label to bring up the Soap Channel Configuration
window.
a. Soap Endpoint: Set to the contents of the MIRTH Channel’s “WSDL URL” (shown on the
Source tab of the Channel definition.)
b. Method: acceptMessage

5. Click OK.

4 Troubleshooting MIRTH
4.1 Monitoring Message Processing
1. Click the Dashboard in the MIRTH panel.

2. There is a line for each channel in the dashboard and statistics on the amount of Received, Sent,
and Errored messages in each channel. Double-click on the channel you want to display, and

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 16 of 20
 choose dates to filter. Message processed will display as an entry of source and an entry for each
destination.

3. Each entry will have a tab for:

• Raw Message: Incoming.
• Transformed Message: Transformed but still in XML format.
• Encoded Message: Will contain the encoded HL7.
• Mapping: Will contain a table for the all the variable mapped and their values.
• Errors: Will contain detailed description of the errors occurred during message processing.

8. Right-click the source of a message to perform tasks on it, like Reprocess Message.

4.2 Deploying Channel Changes

IMPORTANT: For the changes in a channel to go into effect, you must select Deploy All from the
Channel Tasks menu on the left side of the screen.

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 17 of 20
5 Document History
Version Comments Date Updated By

1.0 Initial draft from R&D 2012-07-17

1.0 Technical Writer edit 2012-07-17 Marci Wolfe

6 Document Contributors
Name Contribution Type

Marci Wolfe Technical Writer edit

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 18 of 20
 CARESTREAM is a trademark of Carestream Health, Inc.
The Kodak trademark and trade dress are used under license from Kodak.

© Carestream Health, Inc. 2012

150 Verona Street
Rochester, NY 14608
United States

TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 19 of 20
TITLE: MIRTH and Info Router Installation Instructions for Reporting - CARESTREAM Vue PACS v11.3.2
PART #: 6K4037 VERSION # 1.0 Confidential (C)
PAGE 20 of 20