TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples

TIBCO ActiveMatrix

BusinessWorks® Plug-in for HL7

Examples

Software Release 6.0

August 2012

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer, TIBCO Runtime Agent, TIBCO BusinessPartner, TIBCO Administrator, TIBCO Rendezvous, TIBCO Hawk, TIBCO TurboXML,TIBCO Enterprise Message Service, and TIBCO BusinessConnect are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries.

EJB, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2008-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v

Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Chapter 1 Introduction of Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Overview of the Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Prerequisites for Running the Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 GetStarted Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Example Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

LLP Connection Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Processes Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Setting Up the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Running the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapter 3 ParserAndRenderer Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

Example Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

ParseAndRender Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Setting Up the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18


Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20


iv | Contents

Chapter 4 Batch Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21


Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Parsing HL7 Header Batch Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Setting Up the Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24


Expected Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Chapter 5 CDA Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27


Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Process Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28




Chapter 6 HIPAA Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35


Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Processes Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36




Chapter 7 LLP Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45


Example Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Process Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46




Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53


| v

Preface

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is the TIBCO implementation of

the HL7 standard based on TIBCO BusinessWorks integration platform.

Topics

• Changes from the Previous Release of this Guide, page vi

• Related Documentation, page vii

• Typographical Conventions, page viii

• Connecting with TIBCO Resources, page x


vi | Changes from the Previous Release of this Guide

Changes from the Previous Release of this Guide

This section itemizes the major changes from the previous release of this guide.

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples is a newly created manual.

All the examples packaged with the installation of the plug-in are added in this manual.


Preface | vii

Related Documentation

This section lists documentation resources you may find useful.

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Documentation

The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in for HL7

documentation set:

• TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Installation Read this manual

for instructions on site preparation and installation.

• TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide Read this manual

for instructions on using the product.

• TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples Read this manual for

instructions on how to use the shipped samples.

• TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Release Notes Read the release

notes for a list of new and changed features. This document also contains lists of

known issues and closed issues for this release.

Other TIBCO Product Documentation

You may find it useful to read the documentation for the following TIBCO products:

• TIBCO Designer™

• TIBCO Administrator™

• TIBCO Rendezvous®

• TIBCO Hawk®

• TIBCO Runtime Agent™

• TIBCO ActiveMatrix BusinessWorks®

• TIBCO Enterprise Message Service™

• TIBCO BusinessConnect™

• TIBCO Foresight™ Instream®

• TIBCO Foresight™ Translator

• TIBCO Foresight EDISIM®

• TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream


viii | Typographical Conventions

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

bwpluginhl7_HOM

E

TIBCO_FORESIG

HT_HOME

TIBCO products are installed into an installation environment. A product installed into

an installation environment does not access components in other installation

environments. Incompatible products and multiple instances of the same product must be

installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced in

documentation as ENV_NAME. On Microsoft Windows, the name is appended to the

name of Windows services created by the installer and is a component of the path to

the product shortcut in the Windows Start > All Programs menu.

• Path The folder into which the product is installed. This folder is referenced in

documentation as TIBCO_HOME.

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 installs into a directory within a

TIBCO_HOME. This directory is referenced in documentation as bwpluginhl7_HOME. The

default value of bwpluginhl7_HOME depends on the operating system. For example on

Windows systems, the default value is C:\tibco\bw\plugins\hl7.

TIBCO Foresight products are installed into a directory. This directory is referenced in

documentation as TIBCO_FORESIGHT_HOME. The default value of

TIBCO_FORESIGHT_HOME depends on the operating system. For example, on Windows

systems, the default value is C:\Foresight.

code font Code font identifies commands, code examples, filenames, pathnames, and output

displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are of particular

interest.

• In command syntax, to indicate the default parameter for a command. For example,

if no parameter is specified, MyCommand is enabled:

MyCommand [enable | disable]


Preface | ix

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks

Concepts.

• To introduce new terms. For example: A portal page may contain several portlets.

Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace. For

example: MyCommand PathName

Key

combinations

Key name separated by a plus sign indicate keys pressed simultaneously. For example:

Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other.

For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example,

an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the

information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss

or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use


x | Connecting with TIBCO Resources

Connecting with TIBCO Resources

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident

experts. It is a place to share and access the collective experience of the TIBCO

community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To

register, go to http://www.tibcommunity.com.

How to Access TIBCO Documentation

You can access TIBCO documentation here:

http://docs.tibco.com

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO

Support as follows:

• For an overview of TIBCO Support, and information about getting started with

TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name,

you can request one.

http://www.tibco.com/services/support

https://support.tibco.com

http://docs.tibco.com

http://www.tibcommunity.com


| 1

Chapter 1 Introduction of Examples

This chapter contains an overview of the examples and the prerequisites needed to run the

examples.

Topics

• Overview of the Examples, page 2

• Prerequisites for Running the Examples, page 3


2 | Chapter 1 Introduction of Examples

Overview of the Examples

The TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 examples are packaged with

the installation of the plug-in. This manual describes how to run the examples on a

Microsoft Windows platform.

The following examples are located in the BWPLUGINHL7_HOME\samples directory:

• GetStarted Example— how a patient admission event triggers a message flow and

how an Interface Engine integrates with TIBCO ActiveMatrix BusinessWorks Plug-in

for HL7 to communicate with a Hospital Information System (HIS).

• ParserAndRenderer Example—shows how to translate input data from one data

format to another data format.

• Batch Example—shows how to use TIBCO BusinessWorks HL7 Plug-in to translate

an HL7 batch file and to return a sequence of individual HL7 messages. The input

batch file contains two batches; each batch uses a specialized segment and contains a

list of HL7 messages.

• CDA Example—shows how to process HL7 V3 messages in XML format.

• HIPAA Example—shows how to use TIBCO BusinessWorks HL7 Plug-in to extract

HL7 messages from an EDI document, which contains HIPAA messages.

• LLP Example—shows how to transport HL7 messages from client to server by using

LLP.

See Also

You should be familiar with the plug-in before running the examples. See TIBCO

ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide for details about the plug-in.


Prerequisites for Running the Examples | 3

Prerequisites for Running the Examples

Before performing any of these exercises, make sure that the following tasks are

completed:

• Install the plug-in and required software according to the procedures in TIBCO

ActiveMatrix BusinessWorks Plug-in for HL7 Installation.

• Unzip the SchemaFile ZIP file to the TIBCO_FORESIGHT_HOME\Translator\Database

directory.

The SchemaFile ZIP file is in the BWPLUGINHL7_HOME\samples\ParserAndRenderer directory.

• Unzip the Resources ZIP file to the TIBCO_FORESIGHT_HOME\Translator\Database directory.

The Resources ZIP file is in the BWPLUGINHL7_HOME\samples\HIPAA directory.


4 | Chapter 1 Introduction of Examples


| 5

Chapter 2 GetStarted Example

This chapter describes the GetStarted example packaged with TIBCO ActiveMatrix

BusinessWorks Plug-in for HL7. Working through the sample project helps you

understand how a patient admission message is processed in an Interface Engine and

Hospital Information System.

Topics

• Example Description, page 6

• Setting Up the Example, page 11

• Running the Example, page 12

• Expected Results, page 13


6 | Chapter 2 GetStarted Example

Example Description

The GetStarted example shows how a patient admission event triggers a message flow and

how an Interface Engine integrates with TIBCO ActiveMatrix BusinessWorks Plug-in for

HL7 to communicate with a Hospital Information System (HIS).

This section introduces the usage of LLP connections, input files, and process definitions

of the example.

LLP Connection Description

The LLP Connection defines how a client and a server establish a connection. For more

information about configuring LLP connection, see “LLP Connection” in TIBCO

ActiveMatrix BusinessWorks Plug-in HL7 User’s Guide.

The example contains four types of LLP Connections. Figure 1 shows the usage of the

LLP Connections.

Figure 1 Shared LLP Connection and Usage

SchedulerInterface

Engine HIS

Scheduler Client

Connection

(to IEngine)

ADT_A05

ADT_A28

IEngine Server

Connection

IEngine Client

Connection

(to HIS)

HIS Server

Connection


Example Description | 7

The LLP Connections are specified as follows:

Scheduler Client Connection

A connection enables sending messages from the Scheduler application (client ) to the

Interface Engine (server). This resource is used in the LLP Connection field of an activity

that sends a message from the Scheduler application to the Interface Engine.

Interface Engine Server Connection

A connection enables receiving messages by the Interface Engine (server) from the

Scheduler application (client). This resource is used in the LLP Connection field of an

activity in the Interface Engine that receives a message from the Scheduler application.

Interface Engine Client Connection

A connection enables sending messages from the Interface Engine (client) to the HIS

system (server). This resource is used in the LLP Connection field of an activity that sends

a message from the Interface Engine to the HIS system.

HIS Server Connection

A connection enables receiving messages by the HIS system (server) from the Interface

Engine (client). This resource is used in the LLP Connection field of an activity in the HIS

system that receives a message from the Interface Engine.

Example Files

The example contains the following items:

• GetStarted—The project folder that contains the example resources.

• ADT_A05.hl7—HL7 message definition that triggers the Scheduler process.



• SchemaFile ZIP file—The folder contains the guidelines and map files used by the

example:

— HL7_26_ADT_A05_EX.map—The predefined map file used to translate the ADT_A05

message from HL7 format into XML format.

— HL7_26_ADT_A05.std—The schema definition for an ADT_A05 message in HL7 format.

This is the source guideline that describes the message before translation.

— HL7_26_ADT_A05.xsd—The schema definition for an ADT_A05 message in XML

format. This is the target guideline that describes the message after translation.

— HL7_26_ADT_A28_XE.map—The predefined map file used to translate the ADT_A28

message from XML format into HL7 format.

— HL7_26_ADT_A28.xsd—The schema definition for an ADT_A28 message in XML format.



This is the target guideline that describes the message after translation.

Processes Description

The example contains the following predefined processes:

• Scheduler Process

• Process ADT_A05 Process

• HIS Process

Scheduler Process

The Scheduler process simulates a scheduling system. It polls for the HL7 message and then

sends the message to the Interface Engine. Figure 2 shows the Scheduler process definition.

Figure 2 Scheduler Process

The process performs the following operations:

1. The File Poller activity polls the file named ADT_A05.hl7 in the directory specified in the

File Name field of the Configuration tab. If the file exists then the process starts.



2. The Send Request activity forwards the ADT_A05.hl7 file to the Process ADT_A05 process.

Process ADT_A05 Process

The Interface Engine process (Process ADT_A05) simulates an Interface Engine. It receives the

ADT_A05.hl7 file from the Scheduler process, transforms ADT_A05 data to meet the

requirements of the HIS system, and sends the converted data, ADT_A28, to the HIS system.

Figure 3 shows the Process ADT_A05 process definition.

Figure 3 Process ADT_05 Process


1. The Receiver A05 from Scheduling activity receives the ADT_A05.hl7 file from the Scheduler

process. The process starts.

2. The Parse Header And Create ACK activity parses the header of the HL7 message to get the

message type and generates an acknowledgement message.

3. The Send Ack activity sends the acknowledgement message to the Scheduler process.

4. The HL7 To XML activity translates the input ADT_A05 HL7 message into an XML string

message based on the HL7_26_ADT_A05_EX translation map.

5. The Parse XML activity receives the mapped XML data from the HL7 to XML activity, and

parses the XML string into an XML tree.

6. The Map A28 XML activity renders the ADT_A05 (pre-admit) HL7 message tree, and

creates an ADT_A28 (new patient) XML string message.

7. The XML To HL7 activity translates the ADT_A28 XML string message into an HL7

message based on the HL7_26_ADT_A28_XE translation map.

8. The Send To HIS activity receives the HL7 message from the XML To HL7 activity and then

sends the message to the HIS process.



HIS Process

The HIS process simulates the Hospital Information System. It receives messages from the

Interface Engine (the Process ADT_A05 process), and writes messages to the Hospital

Information system. Figure 4 shows the HIS process definition.

Figure 4 HIS Process


1. The Receiver activity receives the ADT_A28 message from the Process ADT_A05 process.

The process starts.

2. The Write Output File activity writes the ADT_A28 message to the ADT_A28processID.hl7 file

where the processID variable is the ID for process instance.

3. The Write Result File activity writes the Success message to the GetStarted.log file, which is

located in the BWPLUGINHL7_HOME\samples\GetStarted directory.


Setting Up the Example | 11

Setting Up the Example

Before running the example, you need to perform the following steps to set up the GetStarted

project in TIBCO Designer:

1. Start TIBCO Designer.

2. Click the Open Existing Project button in the TIBCO Designer startup panel. The

Open Project dialog appears.

3. Click the button next to the Project Directory field and then select the GetStarted

folder, which is located in the BWPLUGINHL7_HOME\samples\GetStarted directory. Click

the OK button. The project appears.

4. Click the Project tab in the Project panel.

5. Import the HL7 Custom Function resource:

a. Click the HL7CustomFunction item under the HL7Resource folder in the Project

panel.

b. In the Configuration panel, click the Browse button next to the Class Location

field and then select the HL7CustomFunctions.class file, which is located in the

BWPLUGINHL7_HOME\resources directory. Click the Load button next to the Class

Data field.

c. Click the Apply button to save the changes.

6. Configure the hl7.samples.GetStarted.dir global variable to ensure that it points to the

directory containing the ADT_A05.hl7 file:

a. Click the Global Variables tab in the Project panel. The list of global variables

appears.

b. Select the hl7.samples.GetStarted.dir item and then click the button at the

top left corner in this panel. The Global Variables dialog appears.

c. Specify the location of the ADT_A05.hl7 file in the hl7.samples.GetStarted.dir variable.

d. Click the OK button to save the change.

7. Select Project > Save from the menu to save the project.



Running the Example

After setting up the GetStarted example, complete the following steps to trigger the

Scheduler, Process ADT_A05, and HIS processes:

1. In the Project panel, click the Tester tab and then click the button at the top of the

left corner in this panel. The Select Process To Load dialog appears.

2. Expand the IEngine folder and then check the Process ADT_A05 checkbox.

3. Expand the Simulator folder and then check the HIS and Scheduler checkboxes.

4. Click the Load Selected button. The processes are started.

When the process executes, the elements of the process change colors depending upon

what is occurring in the executing process instance. If all the transition lines change to

green, it means the process runs successfully.

5. Click the button to return to the Design mode.

You can set breakpoints in the process definition at a specified point where you want to

stop a running process and examine its state and process data, for example, you can set

breakpoints before or after an activity.

See TIBCO BusinessWorks Process Design Guide for detailed information on using the

test mode including setting breakpoints and the element colors in the test mode.


Expected Results | 13

Expected Results

If all the processes perform successfully, the ADT_A28processID.hl7 file, which is located in

the BWPLUGINHL7_HOME\samples\GetStarted directory, is created. The processID variable in

the file name is the ID for the process instance.

The ADT_A28processID.hl7 file displays the following messages:

MSH|^~\&|IFENG||DESTApp|DESTFac|20120725034703||ADTÂ28ÂDT_A28|000001|P|2.6

EVN|A28|199901101500|199901101400|1

PID|||191919^^^GENHOS^MR|253763|MASSIE^JAMESÂ||19560129|M|||171

ZOBERLEIN^ÎSHPEMING^MI^49849^""||||S|C|10199925^^^GENHOSÂN|371-66-9256

PV1||O|O/R||||0148ÂDDISON,JAMES|0148ÂDDISON,JAMES|0148ÂDDISON,JAMES|CAR|||||||0148ÂDDISON,

JAMES|S|1400|A|||||||||||||||||||GE|||||199501101410

The date is different depending on your execution time.


| 15

Chapter 3 ParserAndRenderer Example

This chapter describes the ParseAndRenderer example packaged with TIBCO

ActiveMatrix BusinessWorks Plug-in for HL7. Working through the sample project helps

you understand how to translate an HL7 message.

Topics






16 | Chapter 3 ParserAndRenderer Example

Example Description

The ParseAndRenderer example shows how to translate input data from one data format

to another data format.

This section introduces the input files and process definition of the example.

Example Files


• ParseAndRenderer—The project folder that contains the example resources.

• ADT_A05.hl7—The HL7 ADT_A05 message that triggers the ParseAndRender process. The

file is located in the BWPLUGINHL7_HOME\ParserAndRenderer directory.

• SchemaFile ZIP file—The folder contains the guidelines and map files used by the

example:

— HL7_26_ADT_A05_EX.map—The predefined map file that is used to translate the

ADT_A05 message from HL7 format into XML format.

— HL7_26_ADT_A05.xsd—The guideline for an ADT_A05 message in XML format. This is

the target guideline that describes the message after translation.

— HL7_26_ADT_A28_XE.map—The predefined map file that is used to translate the

ADT_A28 message from XML format into HL7 format.

— HL7_26_ADT_A28.xsd—The guideline for an ADT_A28 message in XML format. This is

the source guideline that describes the message before translation.




This is the target guideline that describes the message after translation.

ParseAndRender Process

The ParseAndRender process gets the ADT_A05.hl7 file, translates the ADT_A05 message into

the ADT_A28 message, and renders the message into the ADT_A28.hl7 file.

Figure 5 illustrates the process definition.



Figure 5 ParseAndRender Process

The ParseAndRender process performs the following operations:

1. The File Poller activity polls the file named ADT_A05.hl7 in the directory specified in the


The ADT_A05.hl7 file is passed to the Parse ADT_A05 activity.

2. The Parse ADT_A05 activity translates the ADT_A05.hl7 file into an XML string based on

the HL7_26_ADT_A05_EX.map file.

The XML string is passed to the Parse XML ADT_A05 activity.

3. The Parse XML ADT_A05 activity parses the input XML string into an XML schema tree

based on the HL7_26_ADT_A05.xsd file that is specified in the Output Editor tab.

The parsed XML schema is passed to the Map To ADT_A28 activity.

4. The Map To ADT_A28 activity takes the parsed XML schema and renders it as an XML

string based on the HL7_26_ADT_A28.xsd file that is specified in the Input Editor tab.

The XML string is passed to the XML To HL7 activity.

5. The XML To HL7 activity translates the input XML string into the HL7 message.

The HL7 message is passed to the Write File activity.

6. The Write File activity gets the HL7 message and writes it into the ADT_28.hl7 file in the

BWPLUGINHL7_HOME\ParserAndRenderer directory.

7. The Write Success Msg To File activity writes the Success message to the

ParserAndRendererProj.log file, which is located in the

BWPLUGINHL7_HOME\ParserAndRenderer directory.




Before running the example, you need to perform the following steps to set up the

ParseAndRenderer project in TIBCO Designer:




3. Click the button next to the Project Directory to locate the sample project, which is

in the BWPLUGINHL7_HOME\ParserAndRenderer\ParserAndRenderer directory, and then click

the OK button. The project is displayed on the Project panel.



panel.




Data field.


5. Configure the hl7.samples.ParseRenderer.dir global variable to ensure that it points to the

directory containing the ADT_A05.hl7 file:


appears.

b. Select the hl7.samples.ParseRenderer.dir item and then click the button at

the top left corner in this panel. The Global Variables dialog appears.

c. Specify the location of the ADT_A05.hl7 file in the hl7.samples.ParseRenderer.dir variable.




Running the Example | 19

Running the Example

After setting up the ParseAndRenderer example, complete the following steps to run the

Process Definition process:

1. Click the Tester tab on the left of the Project panel to open the Test panel.

2. Click the button. The Selected Processes To Load dialog appears.

3. Select the ParseAndRender process, and click the Load Selected button to start the

process.

When you test your process definition, the elements of the process change colors

depending upon what is occurring in the executing process instance. If all the

transition lines change to green, it means the process runs successfully.

4. Click the button to stop the testing and return to the Design mode.

See TIBCO BusinessWorks Process Design Guide for detailed information on using test

mode including setting breakpoints and the element colors in test mode.






Expected Results

If the process performs successfully, the ADT_A05.hl7 file is translated into the ADT_28.hl7

file, and the ParserAndRendererProj.log file is created with the Success message. These two output

files are located in the BWPLUGINHL7_HOME\samples\ParserAndRenderer directory.

Figure 6 indicates that the process runs successfully, and the ADT_28.hl7 file is created.

Click the Write Success msg to File activity to check the log.

Figure 6 Process Definition Process Output

The following is an example of the ADT_A28.hl7 file:

MSH|^~\&|IFENG||DESTApp|DESTFac|20120729072851||ADTÂ28ÂDT_A28|000001|P|2.6

EVN|A28|199901101500|199901101400|1

PID|||191919^^^GENHOS^MR|253763|MASSIE^JAMESÂ||19560129|M|||171

ZOBERLEIN^ÎSHPEMING^MI^49849^""||||S|C|10199925^^^GENHOSÂN|371-66-9256

NK1|aa

PV1||O|O/R||||0148ÂDDISON,JAMES|0148ÂDDISON,JAMES|0148ÂDDISON,JAMES|CAR|||||||0148ÂDDISON,

JAMES|S|1400|A|||||||||||||||||||GE|||||199501101410


| 21

Chapter 4 Batch Example

This chapter describes the batch example packaged with TIBCO ActiveMatrix


understand how to handle a batch message.

Topics






22 | Chapter 4 Batch Example

Example Description

The batch example shows how to use TIBCO BusinessWorks HL7 Plug-in to translate an

HL7 batch file and to return a sequence of individual HL7 messages. The input batch file

contains two batches; each batch uses a specialized segment and contains a list of HL7

messages.

This section introduces the input files and process definition of the example.

Example Files


• batch—The project directory that contains the example project files.

• batch.hl7—The HL7 message file that triggers the Parsing HL7 Header Batch process.

Parsing HL7 Header Batch Process

The Parsing HL7 Header Batch process translates a batch file, and returns individual HL7

messages. Figure 7 shows the Parsing HL7 Header Batch process definition.

Figure 7 Parsing HL7 Header Batch Process


1. The File Poller activity polls the HL7 batch file named batch.hl7 in the directory specified

in the File Name field of the Configuration tab. If the file exists then the process starts.

2. The Strip Away Batch Wapping activity removes the batch header segment (BHS) and the

batch trailer segment (BTS) from the input batch file by calling the separateMsgsFromBatch

custom function and then passes the modified messages to the Write Msgs File activity.

The separateMsgsFromBatch function is an HL7 related custom function. It is used to return

individual messages in the batch file by removing the FHS, BHS, BTS, and FTS

segments. To use the HL7 custom functions in the project, load the

HL7CustomFunctions.class file, which is located in the BWPLUGINHL7_HOME\resources



directory. For more information about HL7 custom functions, see “Custom Functions”

in TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide.

3. The Write Msgs File activity writes the modified HL7 batch file to the msgs.txt file.

4. The Parse Into Message Set activity parses the header of a set of HL7 string messages into a

message set. The messages in the message set are then passed to a group containing

one activity, Write Msg Type.

5. The Write Msg Type activity writes the type of each message to the messageType.txt file,

appending to the file as each HL7 message is written.

6. The group iterates once for every message in the message set, and transits to the Write

Success Msg To File activity once the last message is processed.

7. If the group succeeds, the Write Success Msg To File activity writes the Success message to

the batch.log file, which is located in the BWPLUGINHL7_HOME\samples\batch directory.




Before running the example, you need to perform the following steps to set up the batch





3. Click the button next to the Project Directory field and then select the batch folder,

which is located in the BWPLUGINHL7_HOME\samples\batch directory. Click the OK

button. The project appears.




panel.

b. Click the Browse button next to the Class Location field in the Project panel, and

select the HL7CustomFunctions.class file, which is located in the


Data field.


6. Configure the hl7.samples.batch.dir global variable to ensure that it points to the directory

containing the batch.hl7 file:


appears.

b. Select the hl7.samples.batch.dir item and then click the button at the top left

corner in this panel. The Global Variables dialog appears.

c. Specify the location of the batch.hl7 file in the hl7.samples.batch.dir variable.





Running the Example

After setting up the batch example, complete the following steps to trigger the Parsing HL7

Header Batch processes:

1. In the Project panel, click the Project tab and then select the Process Definition item.

2. Click the Tester tab in the Project panel and then click the button at the top of the

left corner in this panel. The Select Process To Load dialog appears. The Parsing HL7

Header Batch (current) checkbox is checked by default. Click the Load Selected

button. The process starts.

When the process executes, the elements of the process change colors depending upon

what is occurring in the executing process instance. If all the transition lines change to

green, it means the process runs successfully.





See TIBCO BusinessWorks Process Design Guide for detailed information on using the

test mode including setting breakpoints and the element colors in the test mode.



Expected Results

If the process succeeds, the messageType.txt file, which is located in the

BWPLUGINHL7_HOME\samples\batch directory, is created.

The messageType.txt file displays the following messages:

1: msgType=ADT^08

2: msgType=VXU^04

3: msgType=VXU^04

4: msgType=ADT^08

5: msgType=VXU^04


| 27

Chapter 5 CDA Example

This chapter describes the CDA example packaged with TIBCO ActiveMatrix


understand how to process HL7 messages in XML format.

Topics






28 | Chapter 5 CDA Example

Example Description

The CDA (Clinical Document Architecture) example shows how to process HL7 V3

messages in XML format.

This section introduces the input files and process definitions of the example.

Example Files


• CDA—The project folder that contains the example resources.

• CDA.dtd—The schema definition in XML format.

• CDA_minimal_sample.xml—The XML message file that triggers the CDA Minimal Sample

process.

• CDA_rich_sample.xml—The XML message file that triggers the CDA Rich Sample process.

Process Description

This example contains the following predefined processes:

• CDA Minimal Sample

• CDA Rich Sample

CDA Minimal Sample

The CDA Minimal Sample process takes the minimal XML messages in the

CDA_minimal_sample.xml file and parses them based on the specified CDA Schema.dtd file.




Figure 8 CDA Minimal Sample


1. The Read XML File activity polls the file named CDA_minimal_sample.xml in the directory

specified in the File Name field of the Configuration tab. If the file exists then the

process starts.

2. If an error occurs when the Read XML File activity reads the file, the Log Error activity

writes the error messages in the CDA.log file, which is located in the

WorkingDirectory\username\.TIBCO\logs directory. Otherwise, the XML strings are passed

to the Parse XML activity.

3. The Parse XML activity takes the XML string and turns them into an XML schema tree

based on the CDA Schema.dtd file, which is specified in the Schema field in the Output

Editor tab.

4. If an error occurs when the Parse XML activity parses the file, the Log Error activity writes

the error message in the CDA.log file. Otherwise, the XML messages are passed to the

Log Info On Message activity.

5. The Log Info On Message activity writes a message containing the information in the XML

messages to the CDA.log file.

6. The Write Success Msg To File activity writes a Success message to the CDAProj_minimal.log file,

which is located in the BWPLUGINHL7_HOME\samples\CDA directory.

See Expected Results on page 32 for more information on the logged messages. Or you

can select Window > Show Console in TIBCO Designer to view the log messages.

CDA Rich Sample

The CDA Rich Sample process takes the rich XML messages in the CDA_rich_sample.xml file and

parses them based on the specified CDA Schema.dtd file. This process is similar to the CDA

Minimal Sample process, see CDA Minimal Sample on page 28 for more information.




Before running the example, you need to perform the following steps to set up the CDA






in the BWPLUGINHL7_HOME\samples\CDA\CDA directory, and then click the OK button.

The project is displayed on the Project panel.

4. Configure hl7.samples.CDA.dir global variables to ensure that it points to the directory

containing the CDA_minimal_sample.xml and the CDA_rich_sample.xml files:


appears.

b. Select the hl7.samples.CDA.dir item and then click the button at the top left


c. Specify the value for the hl7.samples.CDA.dir variable:

BWPLUGINHL7_HOME\samples\CDA.

d. Click the OK button to save the changes.




Running the Example

After setting up the CDA example, complete the following steps to run the example:



3. Select the process definition you want to load, and then click the Load Selected

button to start the process.




4. Click the button to stop the testing and return to the Design mode.


mode and setting breakpoints.






Expected Results

The following results are expected after you run the processes:

• If all the processes performs successfully, messages similar to the following are

written in the CDA.log file, which is generated in the

WorkingDirectory\username\.TIBCO\logs directory.

— For the CDA Minimal Sample process,

HL7 CDA Sample PROCESS CDA MINIMAL SAMPLE: RECEIVED A Consultation note REQUEST

FROM: General internal medicine clinic

— For the CDA Rich Sample process,

HL7 CDA Sample PROCESS CDA RICH SAMPLE: RECEIVED A Consultation note REQUEST FROM:

General internal medicine clinic

Meanwhile, a Success message is written in the CDAProj_minimal.log or CDAProj_rich.log file,

which is located in the BWPLUGINHL7_HOME\samples\CDA directory.

• If an error occurs, the error messages are written in the CDA.log file.


| 33

Chapter 6 HIPAA Example

This chapter describes the HIPAA example packaged with TIBCO ActiveMatrix


understand how to handle HIPAA messages.

Topics






34 | Chapter 6 HIPAA Example

Example Description

The HIPAA example shows how to use TIBCO BusinessWorks HL7 Plug-in to extract

HL7 messages from an EDI document, which contains HIPAA messages.

This section introduces the input files and process definitions of the example.

Example Files


• ClaimsAttachments—The project directory containing the project files.

• 275_HL7ex1.xml—The EDI message file that triggers the Process EX1 process.

• 275_HL7ex2.xml—The EDI message file that triggers the Process EX2 process.

• Resources ZIP file—The folder contains the guidelines and map files used by the

example:

— ORU_R01_ORU_R01_EX.map—The predefined map file used to translate data from HL7

format into XML format.

— ORU_R01.std—The schema definition for an HL7 file. This is the source guideline

that describes the message before translation.

— ORU_R01_ORU_R01.xsd—The schema definition for an XML file. This is the target

guideline that describes the message after translation.

Processes Description

The example contains the following predefined processes:

• Process Ex1 Process

• Process Ex2 Process

• Process 275 Process

Process Ex1 Process

The Process Ex1 process passes the text content of the encoded XML files to the Process 275

process, and logs the status of the message after the Process 275 process operation. Figure 9

shows the Process Ex1 process definition.



Figure 9 Process Ex1 Process


1. The Read XML File 275_HL7Ex1 activity polls the EDI file named 275_HL7ex1.xml in the

directory specified in the File Name field of the Configuration tab. If the file exists

then the process starts. The activity then passes the file to the Process 275 process.

2. Perform the Process 275 process.

3. If the Process 275 process performs successfully, the Write Success Msg To File activity writes

the Success message to the ClaimsAttachments_ex1 log file, which is located in the

BWPLUGINHL7_HOME\samples\HIPAA directory. Otherwise, the Write-Error-Msg-To-File

activity logs the error messages in the ClaimsAttachments_ex1 log file.

Process Ex2 Process

The Process Ex2 process passes the text content of the encoded XML files to the Process 275

process, and logs the status of the message after the Process 275 process operation.

The Process Ex2 process performs similar operations with the Process Ex1 process, but imports

different EDI files. For more information about the Process Ex2 process, see Process Ex1

Process on page 34.

Process 275 Process

The Process 275 process parses an EDI-X12 275 HIPAA message, and creates an embedded

HL7 ORU (Observation Result/Unsolicited) message. Figure 10 shows the Process 275

process definition.



Figure 10 Process 275 Process


1. The process receives the XML file from the Process Ex1 or Process Ex2 process and then

passes the file to the Parse Incoming XML activity.

2. The Parse Incoming XML activity converts the XML file to an XML schema tree based on

the prescribed XSD file.

3. If errors occurred during parsing the XML file, the Generate Error activity halts the

process execution and logs error messages in the ClaimsAttachments_Exn log file where n is

the example number. Otherwise the parsed XML schema is passed to the Loop Over LX

group.

4. The two groups are processed. The outer group, Loop Over LX, iterates once for every

Loop-LX element in the parsed XML file. The inner group, Loop Over DTP, iterates once

for every Loop-DTP element contained in the current iteration Loop-LX element.



For each outer loop, iterate a complete inner group. For each inner loop, the following

activities are processed:

a. The Extract HL7 activity converts the XSD type of the Element-785 element from

base64Binary to string by calling the base64-to-string function.

b. The Write-Error-Msg-To-File activity receives the mapped Element-785 data elements and

then writes the data elements to the ClaimsAttachments_ex.hl7 file.

c. The Write File activity receives the mapped Element-785 data elements and then writes

the data elements to the output_temp.hl7 file.

d. The Read File activity reads the output_temp.hl7 file, and passes the file content to the

HL7 to XML activity. Simultaneously, the Write-Error-msg-to-file activity passes the

data to the HL7 To XML activity as well.

e. The HL7 To XML activity translates the HL7 string message into an XML string

message based on the ORU_R01_ORU_R01_EX translation map.

f. If errors occurred during translating the HL7 string message, the Fail Convert To XML

activity halts the process execution and logs error messages in the

ClaimsAttachments_exn log file where n is the example number. Otherwise, the HL7 to

XML activity passes the generated XML message to the Parse XML activity.

g. The Parse XML activity parses the XML string message into HL7 ORU message

based on the ORU_R01 schema.

h. If errors occurred during parsing the XML string message, the Fail Parse Converted

XML activity halts the process execution and logs error messages in the

ClaimsAttachments_exn log file where n is the example number.




Before running the example, you need to perform the following steps to set up the

ClaimsAttachments project in TIBCO Designer:




3. Click the button next to the Project Directory field and then select the

ClaimsAttachments folder, which is located in the BWPLUGINHL7_HOME\samples\HIPAA

directory. Click the OK button. The project appears.




panel.




Data field.


6. Configure the hl7.samples.HIPAA.dir global variable to ensure that it points to the directory

containing the 275_HL7ex1.xml and 275_HL7ex2.xml files:


appears.

b. Select the hl7.samples.HIPAA.dir item and then click the button at the top

left corner in this panel. The Global Variables dialog appears.

c. Specify the location of the 275_HL7ex1.xml and 275_HL7ex2.xml files in the

hl7.samples.HIPAA.dir variable.





Running the Example

After setting up the batch example, complete the following steps to trigger the Process EX1

or Process EX2 processes:

Run the Process Ex1 Process

To run the Process EX1 process, complete the following steps:

1. In the Project panel, click the Project tab and then select the Process 275 item. Click

the button in the TIBCO Designer toolbar. The Set BreakPoints On

Processes/Process275.process dialog appears.

2. Click the Select All button and then click the OK button. The red octagon (a stop

sign) appears on the top left and right sizes of each activity to indicate the activity has

a breakpoint.

3. Select the Process Ex1 item. Click the button in the TIBCO Designer toolbar. The

Set BreakPoints On Processes/Process Ex1.process dialog appears.

4. Click the Select All button and then click the OK button. The red octagon (a stop

sign) appears on the top left and right sizes of each activity.

5. Click the Tester tab in the Project panel and then click the button at the top of the

left corner in this panel. The Select Process To Load dialog appears. The Process Ex1

(current) checkbox is checked by default. Click the Load Selected button. The

process is now in the Test mode.

6. After the process starter is highlighted (indicating a process has started), click the

button in the vertical toolbar to step through the process.


Run the Process Ex2 Process

The Process EX2 process performs the similar operations with the Process EX1 process. To run

the Process EX2 process, follow the steps in Run the Process Ex1 Process on page 39.


mode including setting breakpoints and the element colors in the test mode.



Expected Results

If the Parse Incoming XML and Extract HL7 activities in the Process 275 process perform

successfully, the ClaimsAttachments_ex.hl7 file, which is located in the

BWPLUGINHL7_HOME\samples\HIPAA directory, is created.

The ClaimsAttachments_ex.hl7 file displays the following information:

MSH|^~\&|Ascend|Lab|Ascend|Lab|20120726010407||ORU^R01ÔRU_R01|0000123456|P|2.6|1|||NE||ASCII|||

PID|1|^^^^^^^|12345678^9^M11|^^^^^^^|ONEILL^RITA|^|19411125120000|M|||AUTUMN WOODS^681

SEPTEMBER DR^DAMASCUS^MD^20872ÛSA^H^^^^||^PRN^^^^^^|||||204411||||||||||||||||||||

PV1|1|I|IN1^214^1^1^^^S|A||IN1^214^1|21^MACDERMAND^FLORENCE^^^^^ÔFFICEMGR^^^ÂM|||CAR||||1|||

37^MACDERMAND^FLORENCE^^^^^ÔFFICEMGRr^^^ÂM|2|40007716^^ÂccMgr^VN|4||||||||||||||||1|||1||P|||20050

110045253|20050112152000|3115.89|3115.89|||

ORC|RE|1138972^BIOHEMATOLOGY|^||CM|E|||20120726115200|^^||9584^PAPPAS^DON||||||||||||100 MEDICAL

DR^^DAMASCUS^MD^20872^^M^^^^|

OBR|1|1234567^BIOHEMATOLOGY|000000799869^BIOHEMATOLOGY|1843^CBC^^^^CAS|S|20120626115200|

20120626120900|||||||20120626120900|^^^^|^^||||||||||||||||||^^|||||||||||||

NTE|1|||^This requisition was edited and resaved on the:2012/08/26 12:09:08 PM|GR

NTE|2|||^This requisition was edited and resaved on the:2012/08/26 12:10:02 PM|GR

TQ1|01||

OBX|1|ST|1843^CBC^^^Ê5|1|666|||N|||F|||||^^|||

SPM|01|||AA|

OBR|1|1138972^BIOHEMATOLOGY|000000799869^BIOHEMATOLOGY|1843^CBC^^^^CAS|S|20120626115200|

20120626120900|||||||20120626120900|^^^^|^^||||||||||||||||||^^|||||||||||||

TQ1|01||

OBX|1|ST|1843^CBC^^^Ê5|1|666|||N|||F|||||^^|||

SPM|01|||AA|

OBR|2|1138972^BIOHEMATOLOGY|000000799871^BIOHEMATOLOGY|2604^CMP^^^^CD2|S|20120626115200|

20120626120900|||||||20120626120900|^^^^|^^||||||||||||||||||^^|||||||||||||

TQ1|01||

OBX|1|ST|2604^CMP^^^Ê6|1|555|||N|||F|||||^^|||

SPM|01|||AA|

OBR|3|1138972^BIOHEMATOLOGY|000000799874^BIOHEMATOLOGY|2701ÎNR^CAS^^^CCC|S|20120626115

200|20120626120900|||||||20120626120900|^^^^|^^||||||||||||||||||^^|||||||||||||

NTE|1|||ÎNRTherapeutic range for INR is 2.00 to 3.00 |GR

TQ1|01||

OBX|1|NM|2701ÎNR^CAS^^Ê6|1|1.03||0.76 - 1.28|N|||F|||||00040^FAKE^MELODY|||

SPM|01|||AA|

OBR|4|1138972^BIOHEMATOLOGY|000000799875^BIOHEMATOLOGY|2741^PTT^^^Ê6|S|20120626115200|20

120626120900|||||||20120626120900|^^^^|^^||||||||||||||||||^^|||||||||||||

TQ1|01||

OBX|1|NM|2741^PTT^^^Ê6|1|30|secs|23 - 40|N|||F|||||00040^FAKE^MELODY||

SPM|01|||AA|

SPM|01|||AA|

If the Process 275, Process EX1, and Process EX2 processes perform successfully, the

ClaimsAttachments_ex1.log and ClaimsAttachments_ex2.log files, which are located in the

BWPLUGINHL7_HOME\samples\HIPAA directory, log the operations succeed.

If errors occurred during performing the Process 275, Process EX1, and Process EX2 processes, the

ClaimsAttachments_ex1.log and ClaimsAttachments_ex2.log files log the error messages and the

unparsed HL7 messages.


| 41

Chapter 7 LLP Example

This chapter describes the LLP example packaged with TIBCO ActiveMatrix


understand how to transport HL7 messages by using LLP.

Topics






42 | Chapter 7 LLP Example

Example Description

The LLP (Lower Level Protocol) example shows how to transport HL7 messages from

client to server by using LLP.

This section introduces input files and process definitions of the example.

Example Files


• LLPAutoAck—The project folder that contains the example resources.

• ADT_A05AL.hl7—The HL7 message file that triggers the Illustrate AL process.

• ADT_A05NE.hl7—The HL7 message file that triggers the Illustrate NE process.

Process Description

This example contains the following predefined processes:

• Illustrate AL Process

• Illustrate NE Process

• Receive Process

Illustrate AL Process

The Illustrate AL process sends the HL7 message strings and receives an acknowledgement

message as the response. Figure 11 illustrates the process definition.

The Illustrate AL process and the Illustrate NE process both simulate clients, and the Receive

process simulates a server. You need to run the Illustrate AL or the Illustrate NE process along

with the Receive process.



Figure 11 Illustrate AL Process


1. The File Poller activity polls the file named ADT_A05AL.hl7 in the directory specified in the


2. The LLP Request Response activity sends the request HL7 messages in the ADT_A05AL.hl7

file to the server, and then receives an acknowledgement message as response from

the server.

The group that contains the LLP Request Response activity does not stop until the condition

evaluates to true. The condition of the group is specified in the Configuration tab of

the Group, as shown in Figure 12.

Figure 12 Configuration Tab in Group

3. If an error occurs in the group, the Log Error activity writes the error messages to the

LLPAutoAck.log file, which is located in the WorkingDirectory\username\.TIBCO\logs

directory. Otherwise, after the group executes successfully, the Write Success Msg to File

activity writes a Success message in the LLPAutoAck_AL.log file, which is located in the

BWPLUGINHL7_HOME\samples\LLP directory.



See Expected Results on page 47 for more information on the logged messages and the

location of the log files. Or you can select Window > Show Console in TIBCO Designer

to view the log messages.

Illustrate NE Process

The Illustrate NE process sends the request HL7 message strings and expects no response,

since the Is One way checkbox is checked. This process is similar to the Illustrate AL process,

see Illustrate AL Process on page 42 for more information.

Receive Process

The Receive process parses the header of the received HL7 messages and sends the

generated acknowledgement response back depending on the acknowledgement type.


Figure 13 Receive Process


1. The HL7 LLP Receiver activity receives the HL7 messages sent from the client. The

process starts.

2. The Parse HL7 Header activity parses the header of the received HL7 messages and

generates its acknowledgement.

3. If the acknowledgement type matches the condition specified in the XPath field of the

transition line, the Send Ack activity sends the generated acknowledgement back to the

client. Otherwise, the parsed HL7 message is passed to the Log Info activity directly.

4. The Log Info activity writes a message containing the parsed message type and

acknowledgement type to the LLPAutoAck.log file, no matter whether the

acknowledgement is sent back or not.

See Expected Results on page 47 for more information. Or you can select Window >

Show Console in TIBCO Designer to view the log messages.


Setting Up the Example | 45


Before running the LLP example, you need to perform the following steps to set up the






in the BWPLUGINHL7_HOME\samples\LLP\LLPAutoAck directory, and then click the OK

button. The project is displayed on the Project panel.

4. Configure the hl7.samples.LLP.dir global variable to ensure that it points to the directory

containing the ADT_A05AL.hl7 and the ADT_A05NE.hl7 files:


appears.

b. Select the hl7.samples.LLP.dir item and then click the button at the top left


c. Specify the value for the hl7.samples.LLP.dir variable:

BWPLUGINHL7_HOME\samples\LLP.

d. Click the OK button to save the changes.




Running the Example

After setting up the LLP example, complete the following steps to run the example:



3. Select the Illustrate AL process or the Illustrate NE process along with the Receive

process, and then click the Load Selected button. The process starts.




4. Click the button to stop the testing and return to the design mode.


mode and setting breakpoints.





Expected Results | 47

Expected Results

The following results are expected after you run the processes:

• If all the processes performs successfully, messages similar to the following are

written in the LLPAutoAck.log file, which is generated in the

WorkingDirectory\username\.TIBCO\logs directory.

— For the Illustrate AL process,

HL7 LLP Sample RECEIVE : Received a ADTA05 message with ACK TYPE : AL

— For the Illustrate NE process,

HL7 LLP Sample RECEIVE : Received a ADTA05 message with ACK TYPE : NE

Meanwhile, a Success message is written in the LLPAutoAck_AL.log or LLPAutoAck_NE.log

file, which is located in the BWPLUGINHL7_HOME\samples\LLP directory.

• If an error occurs, the error messages are written in the LLPAutoAck.log file.


| 53

Index

Numerics

275_HL7ex1.xml 36

275_HL7ex2.xml 36

A

ADT_A05.hl7 7, 16

ADT_A05AL.hl7 46

ADT_A05NE.hl7 46

B

Batch example

Parsing HL7 Header Batch process 22, 22

batch.hl7 22

bwpluginhl7_HOME viii

C

CDA example

CDA Minimal Sample 28

CDA Rich Sample 30

CDA_minimal_sample.xml 28

CDA_rich_sample.xml 28

CDA.dtd 28

changes from the previous release of TIBCO ActiveMatrix

BusinessWorks Plug-in for HL7 User’s Guide vi

ClaimsAttachments 36

customer support x

E

Examples

Batch 21

CDA 27

GetStarted 5

HIPAA 35

LLP 45

ParserAndRenderer 15

G

GetStarted example

HIS process 10

Process ADT_05 process 9

Scheduler process 8

H

HIPAA example

Process 275 process 37

Process Ex1 process 36

Process Ex2 process 37

L

LLP connection 6

HIS server connection 7

Interface Engine client connection 7

Interface Engine server connection 7

Scheduler client connection 7


54 | Index

LLP example

Illustrate AL process 46

Illustrate NE process 48

Receive process 48

P

ParseAndRender example

ParseAndRender process 16

R

Resources 36

S

SchemaFile 8, 16

support, contacting x

T

technical support x

TIBCO_FORESIGHT_HOME viii

TIBCO_HOME viii

TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples

Documents

Transcript of TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Examples