TIBCO ActiveMatrix BusinessWorks Plug

TIBCO ActiveMatrix BusinessWorks Plug
TIBCO ActiveMatrix
BusinessWorks® Plug-in for HL7
User’s Guide
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
Administrator, TIBCO Rendezvous, TIBCO Hawk,TIBCO Enterprise Message Service, TIBCO Foresight Instream, TIBCO
Foresight Translator, TIBCO Foresight EDISIM, 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
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
xvii
xvii
xvii
Chapter 1 Healthcare Messaging Standards and TIBCO Solutions . . . . . . . . . . . . . . . . . . . . . . .1
HL7 and HIPAA Healthcare Messaging Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
How HL7 and HIPAA Messaging Can Overlap. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
HL7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
HL7 Implementation Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
HL7 Protocol Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
HL7 Functional View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
HL7 Implied Data Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
TIBCO HL7 and HIPAA Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 2 HL7 Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
HL7 Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
.Shared Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
HL7 Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
LLP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
iv
| Contents
Translate HL7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
17
17
18
19
19
Validate HL7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
21
21
22
22
Parse HL7 Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
23
24
25
25
LLP Request Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
26
27
27
27
LLP Receiver. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
28
28
28
28
28
LLP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
30
31
31
31
Chapter 3 Introduction to TIBCO Foresight EDISIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
TIBCO Foresight EDISIM GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Creating XSD and MAP files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Validating a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Creating Mapping Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Chapter 4 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Starting TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Creating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Contents v
|
Creating A LLP Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Creating A TIBCO ActiveMatrix BusinessWorks Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Adding Activities to the Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Testing the Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Deploying A Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Custom Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Chapter 5 Port Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
Port Management Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Information for Server Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Information for Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Port Management on TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Chapter 6 TIBCO HL7/HIPAA Messaging Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
HIPAA and HL7 Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
TIBCO HL7/HIPAA Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Working with TIBCO BusinessConnect EDI Protocol HIPAA Edition Powered by Instream . . . . . . . . . . . . . . . . . 65
Sample High-Level Scenario . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Provider and Payor Roles When Sending an EDI-X12 275 HIPAA Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Payor Role When Receiving an EDI-X12 275 HIPAA Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Appendix A HL7 Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
HL7 Message Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
HL7 Message Definition Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
HL7 Sample Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Making HL7 Messages More Readable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
HL7 ORU Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Appendix B HL7 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
HL7 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
vi
| Contents
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Figures vii
|
Figures
Figure 1
HIPAA and HL7 Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 2
Messaging Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Figure 3
HL7 Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 4
Creating a Guideline in EDISIM Application Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Figure 5
Selecting A User Guideline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Figure 6
Selecting Transaction Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Figure 7
Selecting Export Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Figure 8
Export Guideline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Figure 9
Validating a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Figure 10
Rule Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Figure 11
Custom Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 12
Information for Server Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Figure 13
Information for Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Figure 14
Message Exchange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
viii
| Figures
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Tables ix
|
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Table 2
LLP Connection Client Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Table 3
LLP Connection Server Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Table 4
Translated Data Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Table 5
Translate HL7 Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Table 6
Translate HL7 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 7
Translate HL7 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Table 8
Translate HL7 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 9
Validate HL7 Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 10
Validate HL7 Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 11
Validate HL7 Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 12
Validate HL7 Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 13
Parse HL7 Header Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Table 14
Parse HL7 Header Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 15
Parse HL7 Header Error Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 16
LLP Request Response Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Table 17
LLP Request Response Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 18
LLP Request Response Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 19
LLP Receiver Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 20
LLP Receiver Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 21
LLP Response Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 22
LLP Response Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Table 23
LLP Response Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Table 24
Custom Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 25
Port Management Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
x
| Tables
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| xi
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 xii
•
Related Documentation, page xiv
•
Typographical Conventions, page xv
•
Connecting with TIBCO Resources, page xvii
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
xii
| 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.
Added New HL7 Activities
The following HL7 activities are documented:
•
Translate HL7, see Translate HL7 on page 17.
•
Validate HL7, see Validate HL7 on page 21.
Added Introduction for TIBCO Foresight EDISIM®
A new chapter is added to introduce how to use TIBCO Foresight EDISIM, see
Introduction to TIBCO Foresight EDISIM, page 33.
Enhanced Error Codes
More HL7 error codes are included in this book, see HL7 Error Codes on page 75.
Reorganized Chapters
The TIBCO Designer—HL7 Components chapter is divided into the two following
chapters:
•
HL7 Palette This chapter describes sthe HL7 Palette, which contains shared
resources and HL7 activities for TIBCO ActiveMatrix BusinessWorks Plug-in for
HL7, see HL7 Palette on page 11.
•
Getting Started This chapter describes HL7 custom functions and the basic steps
required to configure and run TIBCO ActiveMatrix BusinessWorks Plug-in for HL7
in TIBCO Designer, see Getting Started on page 43.
Obsolete Features
The following features are removed from this guide:
•
The HL7 Definition Resource section is removed from the shared resources palette
section, see HL7 Palette on page 11.
•
The Parse HL7, Render HL7, and Transform HL7 sections are removed from the HL7
activities introduction section, see HL7 Palette on page 11.
•
The HL7 HeaderAndAck Definition field in the configuration tab of the Parse HL7
Header activity is removed, see Parse HL7 Header on page 23.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Preface xiii
|
•
The bytesToRead field in the Input tab of the LLP Request Response activity is
removed, see LLP Request Response, page 26.
•
The project template section is removed from this book.
•
The Appendix, HL7 Utilities, is removed from this book.
•
The Installing TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 chapter is
removed from this book. A new book, TIBCO ActiveMatrix BusinessWorks Plug-in
for HL7 Installation, is created in this release.
•
The iNTERFACEWARE Chameleon chapter is removed from this book. TIBCO
Foresight products are used as the HL7 parser engine instead of iNTERFACEWARE
Chameleon.
•
The Tutorials for TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 chapter is
removed from this book. A new book, TIBCO ActiveMatrix BusinessWorks Plug-in
for HL7 Examples is created to introduce the shipped samples.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
xiv
| Related Documentation
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
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Preface xv
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention
Use
ENV_NAME
BWPLUGINHL7_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.
TIBCO_FORESIGHT_HOME
An installation environment consists of the following properties:
TIBCO_HOME
•
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.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
xvi
| Typographical Conventions
Table 1 General Typographical Conventions (Cont’d)
Convention
Use
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]
italic font
Key combinations
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 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.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Preface xvii
|
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.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
xviii Connecting with TIBCO Resources
|
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
|1
Chapter 1
Healthcare Messaging Standards and
TIBCO Solutions
This chapter gives an overview of HL7, TIBCO ActiveMatrix BusinessWorks Plug-in for
HL7, HIPAA, and TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by
Instream.
Topics
•
HL7 and HIPAA Healthcare Messaging Standards, page 2
•
HL7, page 3
•
TIBCO HL7 and HIPAA Solutions, page 7
•
Architecture, page 9
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
2
| Chapter 1
Healthcare Messaging Standards and TIBCO Solutions
HL7 and HIPAA Healthcare Messaging Standards
HL7 (Health Level Seven) is a messaging standard for exchanging clinical and
administrative data between healthcare applications from various vendors, typically
within an enterprise. HIPAA was enacted in 1996 and is designed to streamline healthcare
transactions across enterprises and to uphold patients' privacy rights.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 can address the HL7 integration
needs of an enterprise. In addition to addressing HL7 needs, TIBCO ActiveMatrix
BusinessWorks Plug-in for HL7 addresses the HL7 requirement for integration with
HIPAA, as HIPAA has HL7 requirements for some of its transactions. See TIBCO HL7
and HIPAA Solutions on page 7 for more information.
For more information on HIPAA, see TIBCO BusinessConnect EDI Protocol HIPAA
Edition powered by Instream Configuration.
How HL7 and HIPAA Messaging Can Overlap
Within enterprises like hospitals, events like patient admission and billing trigger HL7
messages between enterprise applications. Between enterprises like hospitals and
insurance companies, which exchange HIPAA (Health Insurance Portability and
Accountability Act) EDI-X12 transactions, HL7 is used in certain HIPAA EDI-X12
transactions.
For example, when a patient is admitted to hospital, the Patient Administration System
(PAS) records details about the patient and the admission. Other systems, such as
Pathology Laboratory Information Systems or Pharmacy Systems, are likely to need
information about the new patient. The PAS sends an HL7 message about the patient to
each of the appropriate hospital systems.
Later, when the hospital sends a claim for payment to another enterprise, like an insurance
company, the hospital and the insurance company exchange HIPAA EDI-X12 messages.
One or more of those HIPAA EDI-X12 messages may contain an embedded HL7 message
with additional patient information.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 3
|
HL7
Before HL7, enabling two healthcare applications to communicate involved a negotiation
that had few ground rules. Details as minor as record separators could be a source of
disagreement and delay. Vendor preference tended to influence the outcome more than
customer requirements.
Over the past 10 years, application integration using HL7 has gained wide acceptance and
support. This success has come because HL7 responded to earlier integration difficulties
by providing a common vocabulary and architecture to connect the analysis/negotiation
process more closely to customer requirements.
For customers, using HL7 as a healthcare messaging standard establishes the baseline
architectural rules for integration and the vocabulary for accomplishing it. For software
developers, HL7 provides a framework, but the HL7 specification itself does not define
canonical rules that allow a standard implementation. While HL7 implies a data model
and business rules, it is not based on an explicit reference architecture, so compliance
testing is not practical. This has been a trade-off within the HL7 community.
HL7 Implementation Questions
The following questions are expected when a decision is made to use HL7 to support an
integration approach:
•
What integration capabilities must be offered?
•
How do we establish and manage the boundary between application functions and
message functions?
•
How do we support HL7 messaging as a general approach without having to program
support for all possible combinations of transactions, including ones that are almost
never used?
HL7 neither intends nor necessarily recommends that a complete implementation of an
interface must include support for the entire hierarchy of protocol features. The answer to
the question "Which transactions must I support?" is normally "Support the ones that you
need." The HL7 specification allows tremendous flexibility for a developer working on a
specific implementation by supporting many common requirements.
For example, an ADT vendor may support fewer than half the ADT message definitions
that the standard describes, and yet be functionally and operationally compliant. This is
even more the case with Order Entry, where vendor capabilities can vary considerably.
Since HL7 does not establish or endorse canonical rules for compliance testing, an
interactive interface development process is a natural consequence.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
4
| Chapter 1
Healthcare Messaging Standards and TIBCO Solutions
HL7 is a broad protocol framework, so no one set of prescribed functions exists.
Application business rules determine which areas of the protocol make the most sense to
support. Attempting to prescribe or anticipate a transaction set may fail due to the
functional concerns of interface requirements.
For a software integrator, HL7 messaging requires setting boundaries between application
functions and messaging infrastructure. Our technical approach is to develop an interface
engine as a messaging hub within which to address issues with vendor support for HL7 as
well as to provide managed, guaranteed delivery and queue management functions.
HL7 Protocol Description
HL7 is a structured, message-oriented framework for communications between healthcare
application systems. When designers began to develop HL7, they borrowed from what is
now ASC X.12 (EDI). However, the current similarity between the two standards is
accidental for practical purposes since HL7 has evolved down its own path since its
creation.
The HL7 protocol architecture is hierarchical, moving from high-level groupings and
structures to a set of several hundred data fields. Each level of the hierarchy serves a
different organizing purpose.
Functional Group
Areas of the protocol are grouped according to common application function. For
example, ADT, Order Entry, Finance, Control, and Ancillary Reporting all represent
groups described in the standard. Different functional groups are typically given
individual chapters in the HL7 specification document.
Message Type
Within a functional group, one or more message types are defined that can be
implemented in various combinations to support high-level business rules for the
applications involved. For example, ADT only specifies one message type, while Order
Entry describes more than a dozen.
Message Definition
Within each message type, one or more message definitions describe the specific set or
combination of segments that make up a properly formed message. For example, ADT
distinguishes among more than 30 separate message definitions based on trigger events or
more detailed business rules. Each message definition includes one or more segments.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 5
|
Segment Definition
Segments provide a logical grouping for data elements. For example, the Patient
Identification (PID) segment includes fields for such identifying information as patient
name, social security number, medical record number, account number, and miscellaneous
demographic details. How fields are grouped in segments forms part of the HL7 implied
data model. Segments can be required or optional, can be nested, and can repeat. A parsed
message, then, can take on a relatively arbitrary yet unambiguous form. This is an
important characteristic in the context of decoding and encoding messages.
Field
The HL7 standard identifies several hundred data elements for communicating patient
demographic, clinical, and financial information. HL7 uses more than a dozen abstract
data types to define the nature of the fields. One consequence is that some fields may hold
more than one data element.
For example, a field that holds a time stamp (TS) follows a prescribed format. In addition,
many fields are or can be coded, and the standard includes a variety of code tables to
define acceptable contents. While each field is defined with a maximum length, the
standard does not intend to prescribe format to that level of detail. In merely includes
lengths because it helps readers understand the purpose of the field, and it may have a
practical importance in specific implementations.
HL7 Functional View
On a functional level, HL7 can be thought of as an architecture with a set of constituent
protocols. The division of message definitions into functional groups and the division of
HL7 itself into functional groups, has resulted in key conceptual differences between
groups.
The idea of the trigger event governs ADT messages. Each ADT message definition
includes an event (EVN) segment that describes the necessary action. Orders messages on
the other hand follow a similar, but not identical scheme. Rather than an event segment,
order messages use a common order segment (ORC) with an order control code (SEQ 1)
that determines the function. The control code is analogous to a trigger event, but is
further broken down into classes-request, acknowledgement, and notification.
In addition, rather than define ancillary-specific segments that fall under the general order
message (ORM) definition, some ancillary segments have distinct message definitions
with the order entry group. Fortunately, these message definitions follow the same general
encoding rules. Specific ancillary support for these fairly complex rules, however, is
practically always a matter of negotiation.
Not every vendor supports HL7 messaging in exactly the same way. No vendor supports
all forms of all messages.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
6
| Chapter 1
Healthcare Messaging Standards and TIBCO Solutions
HL7 Implied Data Model
Because HL7 is not based on an explicit data model, compliance testing against a
reference architecture has not been part of the HL7 culture. The HL7 community itself
tends to accept this as a reasonable trade-off for the sake of flexibility. Vendors and their
systems are diverse and evolve slowly, so the benefits of greater purity of method would
be at the cost of actual utility.
The HL7 protocol architecture does imply a data model that is reflected in the message
structure. HL7 has made a reasonable attempt to insure that data elements do not overlap
in segment definitions, so the organization of data elements into message segments is
analogous to a set of tables in a relational database. Message definitions would be
analogous to database views that involve relating multiple tables to satisfy implied
business rules.
Neither the implied data model nor the implied business rules should be considered a
generic reflection of the shared attributes of all healthcare applications, even if they do
represent much that is commonly accepted.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
TIBCO HL7 and HIPAA Solutions 7
|
TIBCO HL7 and HIPAA Solutions
The following TIBCO products work together to provide a solution to a company’s
internal and external HL7 and HIPAA healthcare messaging needs:
•
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is the implementation of the
HL7 standard with TIBCO ActiveMatrix BusinessWorks. TIBCO ActiveMatrix
BusinessWorks Plug-in for HL7 is a software package that provides a framework for
quick integration of a healthcare provider’s HL7 systems.
By combining
— process design-time HL7 activities in TIBCO ActiveMatrix BusinessWorks,
— runtime Interface Engine in TIBCO ActiveMatrix BusinessWorks,
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is able to offer HL7 message
customizations together with business process design and management.
The Interface Engine, implemented in TIBCO ActiveMatrix BusinessWorks with the
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7, can receive inbound and
outbound HL7 messages and convert data back and forth between HL7 and XML. The
Interface Engine can then make business decisions by looking at the data in the
messages. The Interface Engine also provides centralized message routing.
In summary, the TIBCO implementation of the HL7 standard offers healthcare
customers the ability to quickly implement the complex integration of various
healthcare enterprise systems through intuitive process modeling.
•
TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream
TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream is the
TIBCO implementation of the EDI standard, and offers specialized functionality for
customers who require HIPAA compliance.
TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream enables
the exchange of HIPAA messages and embedded HL7 messages between enterprises
like hospitals and insurance companies.
For information on how TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream can
work together, see Chapter 6, TIBCO HL7/HIPAA Messaging Solution, on page 61.
•
TIBCO Foresight Products
TIBCO Foresight Translator and Instream act as the HL7 parser engine. TIBCO
Foresight Translator is a specialized, high-speed transformation engine that enables
the mass conversion of transaction files based on pre-built or custom maps, providing
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
8
| Chapter 1
Healthcare Messaging Standards and TIBCO Solutions
direct translation to and from HL7, XML, and Flat File formats with no interim
staging required.
TIBCO Foresight Instream ensures the compliance of inbound and outbound data
using the fastest and most thorough transaction validation engine.
TIBCO Foresight EDISIM is a design-time tool that allows you to:
— create and edit HL7 message definitions based on your needs.
— validate HL7 messages based on the message definition.
— create STD, MAP, XML, and XSD files
For more information, see the TIBCO Foresight documentation.
Figure 1 shows an overview of how HIPAA and HL7 transactions are exchanged in the
context of TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and TIBCO
BusinessConnect EDI Protocol HIPAA Edition powered by Instream.
Figure 1 HIPAA and HL7 Transactions
Pharmacy
Enterprise
Application
Radiology
Enterprise
Application
Pathology
Enterprise
Application
Physicians'
Enterprise
Application
HL7 / XML
HL7
TIBCO
ActiveMatrix
Business
Works Plugin for HL7
XML
TIBCO
Business
Connect
EDI
Protocol
HIPAA
Edition
EDI HIPAA
Claims
Transactions
HL7
Healthcare Provider Space
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
TIBCO
Business
Connect
EDI
Protocol
HIPAA
Edition
XML
TIBCO
ActiveMatrix
Business
Works Plugin for HL7
HL7 / XML
Healthcare Payor Space
Insurance
Company
Application
Government
Funded
Insurance
Application
Employer
Funded
Insurance
Application
Medicare
Application
Architecture 9
|
Architecture
Figure 2 shows an example of how the key components, such as an interface engine
implemented with TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 on top of
TIBCO ActiveMatrix BusinessWorks, fits into a hospital’s messaging architecture. It
illustrates how an event like a patient admission would trigger message flow to the
relevant systems and components
Figure 2 Messaging Architecture
.
Event:
Patient Admission
Data is entered into the
Scheduling System
Pathology
Laboratory
Information
System
Enterprise
Application
HL7 Message
Interface
Engine
Radiology
Information
System
Enterprise
Application
Patient
Administration
System
Enterprise
Application
Hospital
Information
System
(HIS)
Pharmacy
Systems
Enterprise
Application
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
10
| Chapter 1
Healthcare Messaging Standards and TIBCO Solutions
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 11
Chapter 2
HL7 Palette
This chapter describes the HL7 Palette, which contains shared resources and HL7
activities for TIBCO ActiveMatrix BusinessWorks Plug-in for HL7.
Topics
•
HL7 Palette Overview, page 12
•
LLP Connection, page 14
•
Translate HL7, page 17
•
Validate HL7, page 21
•
Parse HL7 Header, page 23
•
LLP Request Response, page 26
•
LLP Receiver, page 28
•
LLP Response, page 30
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
12
| Chapter 2
HL7 Palette
HL7 Palette Overview
One of the key activities in integrating health care systems is to implement the Interface
Engine functionality using the TIBCO ActiveMatrix BusinessWorks Process Engine in the
course of defining process models. This process modeling is done in TIBCO Designer
using the HL7 features, as well as the many features that are part of TIBCO ActiveMatrix
BusinessWorks. These include FTP, the file poller, and logging support.
HL7 palette includes one shared resource and six activities. It is in the Palettes panel, as
shown in Figure 3.
Figure 3 HL7 Palette
.Shared
Resources
The shared resource for TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is listed
below:
•
LLP Connection
HL7 Activities
To achieve different functionalities, HL7 activities can be divided into the following
groups:
•
Basic activities.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Palette Overview 13
|
The following activities are mostly likely to be used in your HL7 integration project:
— Translate HL7
— Validate HL7
— Parse HL7 Header
•
LLP activities.
Most HL7 messages are sent using TCP using Lower Level Protocol (LLP). The
following activities can be used to send or receive HL7 messages using LLP. These
activities are related to TCP over LLP. These are used to send or receive HL7
messages to or from other systems in the provider space.
— LLP Request Response
— LLP Receiver
— LLP Response
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
14
| Chapter 2
HL7 Palette
LLP Connection
Shared Resource
Each LLP Configuration defines how a client and a server can establish a connection.
This shared resource is used with the following activities:
•
LLP Request Response. See LLP Request Response on page 26.
•
LLP Receiver with Ack. See LLP Receiver on page 28.
•
LLP Response. See LLP Response on page 30.
The fields on the configuration tab depend on whether you are configuring a client or
server.
Client Configuration
Table 2 describe the client configuration.
Table 2 LLP Connection Client Configuration Tab
Field
Description
Name
The name to appear as the label for the resource in the process definition.
Description
Short description of the resource.
Type
Select Client if your system is acting as a client by sending requests.
Host
The machine name or IP of the server machine.
Port
The port through which your client connects to a server system. Only one port can be
given.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
LLP Connection 15
|
Table 2 LLP Connection Client Configuration Tab (Cont’d)
Field
Description
Separator
List of allowed separators:
•
Minimal LLP - Default
•
Linefeed
•
Linefeed-Linefeed
•
Carriage return-linefeed
•
Empty line using linefeed
•
Empty line using Carriage return-linefeed
•
No separator
Note: The separator only separates messages. It does not separate a message into lines.
Encoding
The encoding used to convert between binary and text formats.
Request
Timeout
(MilliSec)
Number of milliseconds to wait before the request or read times out.
Connection
Retries
Number of retries if connection fails.
Retry Wait (Sec)
Number of seconds to wait before next retry, if any.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
16
| Chapter 2
HL7 Palette
Server Configuration
Table 3 describes the server configuration.
Table 3 LLP Connection Server Configuration Tab
Field
Description
Name
The name to appear as the label for the resource in the process definition.
Description
Short description of the resource.
Type
Select Server if your system is acting as a server by receiving requests.
Port
The port on which your server is listening for HL7 messages from a client. One or more
ports can be given with a semicolon as a separator.
Separator
List of allowed separators:
•
Minimal LLP - Default
•
Linefeed
•
Linefeed-Linefeed
•
Carriage return-linefeed
•
Empty line using linefeed
•
Empty line using Carriage return-linefeed
•
No separator
Note: The separator only separates messages. It does not separate a message into lines.
Encoding
The encoding used to convert between binary and text formats.
Read Timeout
(Sec)
Number of seconds before server terminates the connection.
Input
This resource requires no input.
Output
This resource has no output.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Translate HL7 17
|
Translate HL7
Activity
The Translate HL7 activity translates input data in one format to another format with no
interim staging required.
Table 4 lists the input data formats for translation supported by this activity.
Table 4 Translated Data Formats
From (Source)
To (Target)
HL7
XML
HL7
HL7
HL7
Flat File
XML
HL7
Flat File
HL7
Configuration
The configuration tab has the following fields.
Table 5
Translate HL7 Configuration Tab
Field
Description
Name
The name to appear as the label for the activity in the process definition.
Description
Short description of the activity.
Operation Type
This drop-down list allows you to specify the operation type. See Table 4.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
18
| Chapter 2
HL7 Palette
Input
Table 6 lists the input items.
Table 6 Translate HL7 Input
Input Item
Description
map_filename
This field specifies the name and extension of a map file. TIBCO ActiveMatrix
BusinessWorks Plug-in for HL7 supports map files with the .map and .xml file name
extensions.
A map file specifies the source and target guidelines for each translation map.
•
Source guideline describes the data before translation.
•
Target guideline describes the data after translation.
Note: All involved XSD, STD, and MAP files must be in the
TIBCO_FORESIGHT_HOME/Translator/Database directory. If you want to share guidelines with
the TIBCO_FORESIGHT_HOME/Instream/Database directory, see Share Guidelines and Maps
on page 18.
msg_content
The message content to be translated.
encoding
(Optional) The encoding used for translation. The default encoding is UTF-8.
Share Guidelines and Maps
If you install TIBCO Foresight Translator and Instream in different directories, you can
share their Database directories by modifying the
TIBCO_FORESIGHT_HOME/Instream/bin/$dir.ini or
TIBCO_FORESIGHT_HOME/Translator/bin/$dir.ini file.
For example, if you want to use the TIBCO_FORESIGHT_HOME/Instream/Database directory as
shared, perform the following steps:
1. Open the TIBCO_FORESIGHT_HOME/Translator/bin/$dir.ini file.
2. Modify the database path and point it to the TIBCO_FORESIGHT_HOME/Instream/Database
directory.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Translate HL7 19
|
The following is an example.
:* FORESIGHT Supplied .STD Standard Files
FSFACTORY
= "C:\Foresigh\InStream\Static"
:* User-defined .STD Standard Files
ALLUSERSSHARED = "C:\Foresigh\InStream\Database"
The value must be enclosed with double quotation marks.
After making the modification, you can put the involved XSD, STD, and MAP files either
in the TIBCO_FORESIGHT_HOME/Translator/Database directory or in the
TIBCO_FORESIGHT_HOME/Instream/Database directory.
Output
Table 7 lists the output items.
Table 7 Translate HL7 Output
Input Item
Description
msg_content
The output of this activity is the translated message in the specified format, which can be
the HL7, XML, or Flat File format.
The generated message format is specified in the Operation Type field on the
Configuration tab.
return_code
Specifies the return code.
For example, 100 means the transaction ran successfully, 158 means the map file cannot
be opened, and so on.
Return codes are listed in Appendix C of Translator.pdf which is located in
TIBCO_FORESIGHT_HOME/Translator/Doc.
encoding
The encoding used for translation.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
20
| Chapter 2
Table 8
HL7 Palette
Translate HL7 Error Output
Item
Description
msg
Error message description.
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Validate HL7 21
|
Validate HL7
Activity
This activity validates HL7 input data and generates a result and a summary report.
Configuration
Table 9 lists the configuration fields.
Table 9 Validate HL7 Configuration Tab
Field
Description
Name
Activity Name.
Description
Short description of this activity.
Input
Table 10 lists the input items.
Table 10 Validate HL7 Input
Input Item
Description
validator_profile
(Optional) It contains configuration information for this activity. Each time you validate,
this file is read to determine what is to be checked and what is to be displayed on the
screen or written to output files.
The value is the full path of the validator_profile file.
The $fsdeflt.apf file, which is installed in the Foresight Instream bin directory, is the default
profile file for the validate operation. If the $fsdeflt.apf file is modified, the changes do not
take effect until you stop, and restart TIBCO Designer.
guideline_name
The name of the guideline used for the validation. It must be in the
TIBCO_FORESIGHT_HOME/Instream/Database directory. If you want to share guidelines with
the TIBCO_FORESIGHT_HOME/Translator/Database directory, see Share Guidelines and
Maps on page 18.
msg_content
The input data for validation.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
22
| Chapter 2
HL7 Palette
Output
The result and the summary report are listed in the Output tab. For details about the output
items, see InstreamValidationTechnicalManual.pdf which is located in
TIBCO_FORESIGHT_HOME/InStream/Doc.
Table 11 Validate HL7 Output
Output Item
Validation
Validation_sum
mary
Description
Validation_result_in_fla
tfile
Specifies the message of the validation detail results in Flat File
format.
Validation_summary_in
_flatfile
Specifies the message of the validation summary results in Flat
File format.
Severity
Error severity summary record.
Type
Error type summary record.
total_of_error
Records the total number of errors with a severity level larger
than level 2 (Error Count, Fatal Count, User1 Count, and User2
Count).
return_code
Specifies the return code.
For example, 100 means the validation ran successfully, 133
means the database directory cannot be found, and so on.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
Table 12
Validate HL7 Error Output
Item
Description
msg
Error message description.
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Parse HL7 Header 23
|
Parse HL7 Header
Activity
This activity parses the header of a set of HL7 string messages and generates their
acknowledgements.
The acknowledgement is generated as a part of the output message; it returns the
following information:
•
If the header of the input HL7 string message is valid, the first field of the MSA
segment in the acknowledgement message specifies the acknowledge status: AA.
•
If the header of the input HL7 string message is invalid, this activity will not generate
an acknowledgement message and will throw an exception. To generate an
acknowledgement message, you need to design a proper workflow. See the Error
Output, page 25 for more information about exceptions.
Configuration
Table 13 lists the configuration fields.
Table 13 Parse HL7 Header Configuration Tab
Field
Description
Name
The name to appear as the label for the activity in the process definition.
Description
Short description of the activity.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
24
| Chapter 2
HL7 Palette
Table 13 Parse HL7 Header Configuration Tab (Cont’d)
Field
Description
Separator
A list of choices for separators:
•
HL7Standard
(Default) Carriage Return is used between segments, while Carriage Return-Line
Feed is used between messages.
•
HL7CR
Carriage Return is used between segments and messages.
•
HL7LF
Carriage Return is used between segments and Line Feed is used between
messages.
•
HL7CRLF
Carriage Return-Line Feed is used between segments and messages.
Note: The separator only separates messages. It does not separate a message into lines.
Input
The input for the activity are HL7 messages. This can contain one or more HL7 messages.
Output
The output for the activity is a set of messages. There can be only one message in the set.
Table 14 Parse HL7 Header Output
Output Item
messages
Description
message
The HL7 message.
ackMsg
The auto-generated acknowledgement for the incoming message.
responseID
The value of the second field in the MSA segment of the incoming
message.
This MSA segment is present only if the incoming message is a response
message. This field is optional; the request message does not have an
MSA segment
Header
All the header field values.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Parse HL7 Header 25
|
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
Table 15
Parse HL7 Header Error Output
Item
Description
msg
Error message description.
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
26
| Chapter 2
HL7 Palette
LLP Request Response
Activity
This activity sends a request and receives a synchronous response. The request and
response can either be in the form of an HL7 string or XML data.
Synchronous response means that the response is sent on the same TCP connection. If a
connection is closed, and a response is sent on a different TCP connection, then it is called
an asynchronous response.
This activity supports the port management on TIBCO Hawk.
This activity sends its request to the LLP Receiver activity, which passes the request to the
LLP Response activity. If the Is One Way checkbox is not checked, the LLP Request
Response activity may get an empty string if the LLP Receiver activity is suspended
before the LLP Response activity returns the response to the LLP Receiver.
Configuration
Table 16 lists the configuration fields.
Table 16 LLP Request Response Configuration Tab
Field
Description
Name
The name to appear as the label for the activity in the process definition.
Description
Short description of the activity.
LLP Connection
A shared resource that defines the transport parameters to be used for sending HL7
messages.
Is OneWay
If checked, after sending a request, a response is not expected. If unchecked, after
sending a request, a response is expected.
Input
Table 17 lists the input items.
Table 17
LLP Request Response Input
Item
Description
data
The request HL7 message string to be sent out.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
LLP Request Response 27
|
Table 17
LLP Request Response Input
Item
Description
encoding
Optional. Encoding information about the message to be sent out.
separator
Optional. You can specify a special message separator here.
Output
The output for the activity is the received response HL7 message string.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
Table 18
LLP Request Response Error Output
Item
Description
msg
Error message description.
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
28
| Chapter 2
HL7 Palette
LLP Receiver
Activity
This activity receives an HL7 message on one or more ports. It supports port management
on TIBCO Hawk.
Configuration
Table 19 lists the configuration fields.
Table 19 LLP Receiver Configuration Tab
Field
Description
Name
The name to appear as the label for the activity in the process definition.
Description
Short description of the activity.
LLP Connection
A shared resource that defines the transport parameters to be used for receiving HL7
messages.
Input
There are no dynamic inputs for this activity.
Output
The output for the activity can be the incoming HL7 message string.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
Table 20
LLP Receiver Error Output
Item
Description
msg
Error message description.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
LLP Receiver 29
|
Table 20
LLP Receiver Error Output
Item
Description
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
30
| Chapter 2
HL7 Palette
LLP Response
Activity
This activity sends a synchronous response back to the initiating system on TCP over LLP.
This activity can work in combination with the LLP Receiver on page 28.
Configuration
Table 21 lists the configuration fields.
Table 21
LLP Response Configuration Tab
Field
Description
Name
The name to appear as the label for the activity in the process definition.
Description
Short description of the activity.
Reply For
Provides a choice of LLP Receivers in the process to be used.
Separator
List of allowed separators:
•
Minimal LLP - Default
•
Linefeed
•
Linefeed-linefeed
•
Carriage return-linefeed
•
Empty line using linefeed
•
Empty line using Carriage return-linefeed
•
No separator
Note: The separator only separates messages. It does not separate a message into lines.
Input
Table 22 lists the input items.
Table 22
LLP Response Input
Item
Description
data
The synchronous HL7 message string to be sent out.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
LLP Response 31
|
Table 22
LLP Response Input (Cont’d)
Item
Description
encoding
Optional. Encoding information about the message to be sent out.
separator
Optional. You can specify a special message separator here.
Output
There are no outputs for this activity.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity.
Table 23
LLP Response Error Output
Item
Description
msg
Error message description.
msgCode
The error code. It represents TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and
TIBCO Foresight errors.
See Appendix B, HL7 Error Codes for detailed information about the error codes.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
32
| Chapter 2
HL7 Palette
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 33
Chapter 3
Introduction to TIBCO Foresight EDISIM
This chapter describes how to use TIBCO Foresight EDISIM.
Topics
•
Creating XSD and MAP files, page 35
•
Validating a Message, page 40
•
Creating Mapping Files, page 41
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
34
| Chapter 3
Introduction to TIBCO Foresight EDISIM
TIBCO Foresight EDISIM GUI
TIBCO Foresight EDISIM allows you to create and edit translation maps and guidelines;
it also has the following functionalities:
•
Customize HL7 standard message sets to fit individual integration profile needs.
•
Provide an intuitive GUI interface with advanced message browsing or parsing
capabilities.
•
Generate XML Schema and Map files.
•
Validate test messages.
The translation map helps you translate messages between HL7 format and XML format.
To translate messages, the source and target guidelines are used for describing data. Use
the following TIBCO Foresight EDISIM modules to create or edit the map files and
guidelines:
Application Manager is a comprehensive user interface with access to all EDISIM
modules.
Standards Editor creates and customizes EDI, XML, and Flat File guidelines quickly
and easily.
EDISIM Validator checks EDI data for compliance to a published standard or a guideline.
For complete information on how to use TIBCO Foresight EDISIM, see TIBCO Foresight
EDISIM documentation.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Creating XSD and MAP files 35
|
Creating XSD and MAP files
TIBCO Foresight EDISIM Standards Editor allows you to generate XSD and MAP files
for translation.
This section gives an example of how to use Standards Editor to generate an XSD file and
a MAP file.
To generate XSD and MAP files, complete the following steps:
1. Start EDISIM Application Manager. Select Start > All Programs > Foresight >
EDISIM in Windows. The EDISIM Application Manager window appears.
2. Create a guideline. Click the Creating Or Editing A Guideline item from the
left-hand panel and then click the Creating A New Guideline item.
Figure 4 Creating a Guideline in EDISIM Application Manager
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
36
| Chapter 3
Introduction to TIBCO Foresight EDISIM
3. Click the Standards Editor link on the right panel. The Empty Guideline - Edisim
window appears.
4. Create a new standard. For example, create a new standard based on the HL7_26
guideline.
a. Select File > New from the Empty Guideline - Edisim window. The New
Guideline - Select Guideline dialog appears.
b. Click the User Guideline tab. Select the guideline from the User Guideline tab. In
the example, select the HL7_26 item.
Figure 5 Selecting A User Guideline
c. Click the Next button. The New Guideline - Select Transaction Sets dialog
appears.
d. Select messages you want to include in your new guideline. For example, the
ADT_A01 and ADT_A05 messages.
e. Click the Open button.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Creating XSD and MAP files 37
|
Figure 6 Selecting Transaction Sets
5. Edit the newly created guideline based on your requirements. For example, add Z
segments, remove unused segments, or adjust optionality of fields in the guideline.
6. Save the guideline. Select File > Save in the menu. The Save Guideline As dialog
appears. Type a guideline name in the Name field and then click the Save button.
7. Export the guideline as a schema.
a. Select all the messages you want to export. For example, the ADT_A01 and
ADT_A05 messages.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
38
| Chapter 3
Introduction to TIBCO Foresight EDISIM
Figure 7 Selecting Export Guidelines
b. Select File > Export > Export Current Guideline > To Schema from the menu.
The Export Standard dialog appears.
To enable the Export Current Guide function, you must save the guideline first.
c. Choose a path to save the guideline. In the Schema/Map Format panel, select the
Custom radio button and then check the Full Enveloping (BC=No, BW=Yes),
Human Readable Element IDs (BC=No, BW=No), and Include Segment Tags
checkboxes. Click the Save button to save the file. An XSD file and a MAP file
are generated.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Creating XSD and MAP files 39
|
Figure 8 Export Guideline
For more information on how to use EDISIM modules, see TIBCO Foresight EDISIM
documentation.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
40
| Chapter 3
Introduction to TIBCO Foresight EDISIM
Validating a Message
TIBCO Foresight EDISIM Validator checks the validity of data based on the standards
and guidelines.
To validate messages, follow these steps:
1. Select Start > All Programs > Foresight > EDISIM > Validator in Windows. The
validator window appears.
2. Select File > Open in the Validator menu to open an HL7 message instance. The
Select Standard dialog appears.
3. Choose a guideline to verify the message. Select a standard from the Select Standard
dialog and then click the OK button to start checking the message. For example, select
the Test6 file as a standard.
Figure 9 Validating a Message
4. When the validation is finished, click the OK button to dismiss the Analysis
Completed box.
For more information about how to use Validator, see TIBCO Foresight EDISIM
documentation.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Creating Mapping Files 41
|
Creating Mapping Files
You can use TIBCO Foresight EDISIM Translation Tool to create mapping files.
To create mapping files, follow these steps:
1. Open Translation Tool. You can do so in one of the following ways:
— Select Start > All Programs > Foresight > Translation Tool in Windows.
— Click the
button in the Standards Editor toolbar.
2. Select File > Open Source Guideline in the menu. The Open Source Guideline dialog
appears. Navigate to the directory to import the source guideline. This is the guideline
that describes the input data.
3. Select File > Open Target Guideline in the menu. The Open Target Guideline dialog
appears. Navigate to the directory to import the target guideline. This is the guideline
that describes the output data.
4. Expand the source and target nodes to edit the map. Check the checkbox in front of the
source data item from the left panel and then check the corresponding checkbox of the
target data item from the right panel. If the mapping succeeds, there is a red or green
line connecting the source and the target data.
To delete the mapping between the source data and the target data, uncheck the
checkboxes in front of the source data and the corresponding target data.
5. Set up transformation rules. Double-click the box as shown in Figure 10. The Rule
Editor dialog appears. Edit rules based on your requirements in the dialog.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
42
| Chapter 3
Introduction to TIBCO Foresight EDISIM
Figure 10 Rule Editor
6. Test the mapping file to verify your results. Click the
button in the toolbar and
then click the Test tab at the bottom of the Translation Tool window. In the Test tab,
test the mapping.
For more information on how to test data, see TIBCO Foresight Translator
documentation.
7. Select File > Save in the menu to save the map in the Translator Database Directory.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 43
Chapter 4
Getting Started
This chapter describes the basic steps required to configure and run this product and the
HL7 custom functions shipped with this product.
Topics
•
Overview, page 44
•
Starting TIBCO Designer, page 45
•
Creating a Project, page 46
•
Creating A LLP Connection Shared Resource, page 47
•
Creating A TIBCO ActiveMatrix BusinessWorks Process, page 48
•
Adding Activities to the Process, page 49
•
Testing the Process, page 50
•
Deploying A Project, page 51
•
Custom Functions, page 52
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
44
| Chapter 4
Getting Started
Overview
TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration
platform that allows you to develop and test integration projects. TIBCO ActiveMatrix
BusinessWorks includes a graphical user interface, TIBCO Designer, for defining business
processes and an engine that executes the process.
For detailed information about how to configure TIBCO BusinessWorks processes, refer
to TIBCO Designer User’s Guide and TIBCO BusinessWorks Process Design Guide.
A typical configuration and deployment procedure includes the following steps:
•
Starting TIBCO Designer on page 45
•
Creating a Project on page 46
•
Creating A LLP Connection Shared Resource on page 47
•
Creating A TIBCO ActiveMatrix BusinessWorks Process on page 48
•
Adding Activities to the Process on page 49
•
Testing the Process on page 50
•
Deploying A Project on page 51
The Java Custom Function resource allows you to create custom functions to use when
mapping data in an activity’s input tab. TIBCO ActiveMatrix BusinessWorks Plug-in for
HL7 includes a useful set of custom functions. See Custom Functions on page 52 for
details.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Starting TIBCO Designer 45
|
Starting TIBCO Designer
TIBCO Designer is used to configure TIBCO ActiveMatrix BusinessWorks Plug-in for
HL7 instances.
To start TIBCO Designer, execute one of the following platform-specific commands to
open the TIBCO Designer window:
•
On Microsoft Windows:
From the Start menu, select All Programs > TIBCO > TIBCO Designer
version_number > TIBCO Designer
or
From the command line, run TIBCO_HOME\designer\version_number\bin\designer.exe
•
On UNIX:
TIBCO_HOME/designer/version_number/bin/designer
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
46
| Chapter 4
Getting Started
Creating a Project
When starting TIBCO Designer, you must create or select a project. A project contains the
configuration files that define options used by a runtime plug-in. After a project is
configured, it is converted to a repository file and available for use by the runtime plug-in.
To create a project:
1. Start TIBCO Designer.
2. Click the New Empty Project button in the TIBCO Designer dialog.
3. Select the Multi-File Project tab (if it is not selected) in the Save Project dialog. Click
the Browse button to save the new created project in the desired location, or directly
type the path in the Project Directory field.
4. Click the OK button to save the TIBCO Designer Project and open the TIBCO
Designer window.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Creating A LLP Connection Shared Resource 47
|
Creating A LLP Connection Shared Resource
The LLP Connection shared resource is used with LLP activities. It defines how a client
and a server establish a connection.
To create a LLP Connection shared resource, follow these steps:
1. Expand the project folder created in Creating a Project, which is now located in the
Project panel.
2. Click the HL7 palette in the Palettes panel, and drag the LLP Connection icon to the
design panel on the right.
3. Configure the created LLP Connection shared resource. For more configuration
information, refer to LLP Connection on page 14.
4. Click the Apply button to save the configuration.
5. Save the project.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
48
| Chapter 4
Getting Started
Creating A TIBCO ActiveMatrix BusinessWorks Process
You can create TIBCO ActiveMatrix BusinessWorks processes to deal with certain HL7
work flows.
To do so, follow these steps:
1. Expand the project folder created in Creating a Project, which is now located in the
Project panel.
2. Expand the Process palette in the Palettes panel and drag the Process Definition
resource into the design panel on the right.
3. Configure the process. For more information, refer to TIBCO Designer User’s Guide.
4. Click Apply to save the configuration.
5. Save the project.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Adding Activities to the Process 49
|
Adding Activities to the Process
To add activities to the process, perform the following procedure:
1. Double-click a process in the Project panel. The Start and End activities should be
displayed in the design panel on the right.
2. Expand the HL7 palette in the Palettes panel.
If the HL7 palette is not one of the available palettes, choose Palettes > Activities > HL7 to make
the palette visible.
3. Drag one or more activities from the HL7 palette into the design panel, and then create
transitions between each activity on the design panel.
4. Configure each activity in the process. See Chapter 2, HL7 Palette, on page 11 for
more information.
5. Test the process in the Tester panel after adding all needed activities in the process.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
50
| Chapter 4
Getting Started
Testing the Process
After creating and configuring a process, you can test it with TIBCO Designer. This
allows you to make sure the process works correctly before you deploy it.
Refer to TIBCO BusinessWorks Process Design Guide for detailed information about
using test mode.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Deploying A Project 51
|
Deploying A Project
When you are ready to deploy your project, generate an Enterprise Archive that contains
the configuration for the process definitions you want to deploy. You can upload the
archive to TIBCO Administrator to deploy the associated application. See TIBCO
BusinessWorks Administration for more information.
The following is the basic procedure:
1. Save the project in the TIBCO Designer window.
2. Create an Enterprise Archive and with in it, create a process archive.
3. Add processes defined in the project to the process archive.
4. Click the Build Archive button under the Enterprise Archive panel to build the
archive. When you click the button, TIBCO Designer generates an Enterprise Archive
(EAR) file that you can then deploy from TIBCO Administrator.
5. Start the TIBCO Administrator and upload the EAR file for the project.
6. Deploy the application and start the process.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
52
| Chapter 4
Getting Started
Custom Functions
An important part of any HL7 integration project is the data mapping from one message
format to another. TIBCO ActiveMatrix BusinessWorks offers advanced functionality in
data mapping, including drag-and-drop and a comprehensive suite of built-in functions.
However, no matter how complete the built-in functions are, there is always a need to
customize, especially in the healthcare industry. TIBCO ActiveMatrix BusinessWorks
Plug-in for HL7 includes a useful set of custom functions.
See the TIBCO ActiveMatrix BusinessWorks documentation for detailed information on
how to write, load, and use your own custom functions.
Using HL7 Custom Functions
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 includes a set of HL7-related
custom functions, which are specified in the
bwpluginhl7_HOME/resources/HL7CustomFunctions.class file.
To use these functions,
1. Create or open a project in TIBCO Designer.
2. Load the pre-defined class file into the project using the Java Custom Function
resource.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Custom Functions 53
|
Figure 11 Custom Function
Custom Functions Usage
To see the HL7 specific custom functions:
1. Click on an Activity in the Activity Input side.
2. Click the XPath Formula Builder button.
3. Click the Functions tab in the XPath Formula Builder dialog.
4. Expand the Prefix folder. The custom HL7 functions appear. Prefix is the suggested
prefix that you specified for the Java Custom Function resource.
Available HL7 Custom Functions
Table 24 lists the HL7-related custom functions.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
54
| Chapter 4
Getting Started
Table 24 Custom Functions
Function
Description and Sample Usage
extractField
Extracts the indexed field from HL7 Message from the first segment with
a given segment name.
Sample usage:
displayableToHL7
extractField($Hl7MsgString, $segmentName,$index)
HL7 requires that all segments end with \r. This function converts
DOS/UNIX format file into HL7 ER7 format.
Sample usage: displayableToHL7($hl7MsgInDisplayFormat)
HL7ToDisplayable
Replaces \r with system line separator.
Sample usage:
HL7ToDisplayable($hl7Msg)
currentTimeStamp
Returns current timestamp in HL7 format: yyyyMMddhhmmss
currentTimeMillis
Returns current time in milliseconds
separateMsgsFromBatch
Returns individual messages in the batch by removing
FHS/BHS/BTS/FTS segments
deleteSegments
Returns HL7 message after the specified segments are removed.
Sample usage:
deleteSegment($hl7Msg, "ZSH:EVN")
Sample output: Message will have EVN and ZSH segments removed
generateNewGUID
Generates Unique ID
trimEmptyFields
Trims empty fields from an HL7 message
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 55
Chapter 5
Port Management
This chapter describes how to manage the ports of a server or a client.
Topics
•
Port Management Functions, page 56
•
Port Management on TIBCO Hawk, page 60
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
56
| Chapter 5
Port Management
Port Management Functions
Functions are provided for managing ports on TIBCO Hawk. These functions are
explained in detail in Table 25.
These functions only take effect for those ports involved in the services deployed using
TIBCO Administrator™.
Table 25 Port Management Functions
Value
Returned
Function
Description
Parameter
LLP_Suspend
Server
Suspends the port that is specified in the parameter.
If the port is active, it suspends the port and the
LLP Receiver does not listen for the port any more.
If the port does not exist or is inactive, it does
nothing and returns Failed.
Port: the port of a
server
Succeed
or
Failed
When the port of the server is successfully
suspended, if a client is trying to connect it, it will
fail.
LLP_Resume
Server
Resumes the port that is suspended. If the port is
inactive, it resumes the port and the LLP Receiver
continues to listen for this port. If the port does not
exist or is active, it does nothing and returns Failed.
Port: the port of a
server
Succeed
LLP_Suspend
Client
Suspends the port that is specified in the parameter.
If the port is active, it suspends the port and the
LLP Request Response stops sending messages to
the server. If the port does not exist or is inactive, it
does nothing and returns Failed.
Host: It must be the
value provided for
the Host in LLP
Connection in
TIBCO Designer.
Succeed
Port: It must be the
value provided for
the Port in LLP
Connection in
TIBCO Designer.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
or
Failed
Failed
or
Port Management Functions 57
|
Table 25 Port Management Functions (Cont’d)
Function
Description
Parameter
LLP_Resume
Client
Resumes the port that is suspended. If the port is
inactive, it resumes the port and the LLP Request
Response continues to send messages to the server.
If the port does not exist or is active, it does
nothing and returns Failed.
Host: It must be the
value provided for
the Host in LLP
Connection in
TIBCO Designer.
Value
Returned
Succeed
or
Failed
Port: It must be the
value provided for
the Port in LLP
Connection in
TIBCO Designer.
LLP_GetServe
rsInfo
Obtains the information related to all the ports of a
server.
No
Information
of all ports
opened on
the server
LLP_GetClien
tsInfo
Obtains the information related to all clients.
No
Information
of all clients
LLP_GetServe
rStatsInfo
Obtains the information related to a specific port of
a server.
Port: the port of a
server
Information
of the port
LLP_GetClien
tStatsInfo
Obtains the information related to a specific client.
Host: It must be the
value provided for
the Host in LLP
Connection in
TIBCO Designer.
Information
of the client
Port: It must be the
value provided for
the Port in LLP
Connection in
TIBCO Designer.
Information for Server Ports
When the function LLP_GetServersInfo or LLP_GetServerStatsInfo is invoked, the information
related to a port of a server is shown in Figure 12.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
58
| Chapter 5
Port Management
Figure 12 Information for Server Ports
The explanation for each column is as follows:
•
port — It is a port of a server that is being monitored.
•
isActive — It is the state of a port in terms of programming. The state is related to the
invoking of the function LLP_SuspendServer or LLP_ResumeServer. If LLP_SuspendServer is
invoked, the state of the port is set to false in programming. If LLP_ResumeServer is
invoked, the state of the port is set to true in programming. This state is just the state of
a port in programming, not the real state of the port in an operating system. For
example, when the state of a port is set to true in programming, the port is probably
closed in the operating system. This column is different from the state column that
shows the real state of a port in an operating system.
•
starttime — It is the time when the service instance is started.
•
state — It is the real state of a port in an operating system. If the port is really opened
in the operating system, the state is up. If the port is really closed in the operating
system, the state is down. This column is different from the isActive column that shows
the state of a port in terms of programming.
•
numMsg — It is the total number of all the messages received by the port.
•
aveSize — It is the average of the total size of all the messages received.
•
maxSize — It is the size of the message with the maximum size.
•
earliestMsgSendtimeSinceStart — It is the time when the first message is received by
the port since the service instance is started.
•
latestMsgSendtimeSinceStart — It is the time when the latest message is received by
the port since the service instance is started.
Information for Clients
When the function LLP_GetClientsInfo or LLP_GetClientStatsInfo is invoked, the information
related to a client is shown in Figure 13.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Port Management Functions 59
|
Figure 13 Information for Clients
The explanation for each column is as follows:
•
port — It is a client that is being monitored.
•
isActive — It is the state of a client in terms of programming. The state is related to
the invoking of the function LLP_SuspendClient or LLP_ResumeClient. If LLP_SuspendClient is
invoked, the state of the client is set to false in programming. If LLP_ResumeClient is
invoked, the state of the client is set to true in programming. This state is just the state
of a client in programming, not the real state of the client in an operating system. For
example, when the state of a client is set to true in programming, the client is probably
closed in the operating system. This column is different from the state column that
shows the real state of a client in an operating system.
•
starttime — It is the time when the client is started.
•
state — It is the real state of a client in an operating system. If the client is really
opened in the operating system, the state is up. If the client is really closed in the
operating system, the state is down. This column is different from the isActive column
that shows the state of a client in terms of programming.
•
numMsg — It is the total number of all the messages sent by the client.
•
aveSize — It is the average of the total size of all the messages sent.
•
maxSize — It is the size of the message with the maximum size.
•
earliestMsgSendtimeSinceStart — It is the time when the first message is sent by the
client since the client is started.
•
latestMsgSendtimeSinceStart — It is the time when the latest message is sent by the
client since the client is started.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
60
| Chapter 5
Port Management
Port Management on TIBCO Hawk
You can use the functions to manage the ports configured for the LLP Connection
resource on TIBCO Hawk. To use them, you have to perform the following steps:
1. For enabling TIBCO Hawk microagent, the value of the global variable HawkEnabled of
your project must be true in TIBCO Designer.
2. After deploying your project on TIBCO Administrator, navigate to
TIBCO_HOME\tra\domain\domain_name\application\project_name to edit the TRA file named
project_name-Process_Archive.tra. The following variable must be added in the file:
—
Engine.Log.LLPHawk=true
This variable registers all functions for port management on TIBCO Hawk, if the
value is true.
The following are the optional variables that can be added in the file:
—
Engine.Log.LLPData=true
This variable generates log message, if the value is true.
—
Engine.Log.LLPStat=true
This variable records the status information of the server ports or clients, if the
value is true.
If the Engine.Log.LLPStat variable is set to true, a program will examine the status of a port
every five seconds. For examining, the program will create a TCP connection to the
port and then if the TCP connection is successfully created, the program will
immediately attempt to close the connection. Therefore, many ports will keep in the
TIME-WAIT state for two minutes.
You can change the interval time for examining the status of a port by adding the
variable Engine.Log.LLPStatInv in the TRA file mentioned above. You can provide this
variable with a value in milliseconds. For example: Engine.Log.LLPStatInv=60000. It means
that the status of a port is examined every one minute.
3. Restart the service instance on TIBCO Administrator.
4. Start Hawk Display. Click the Get MicroAgents item to launch the MicroAgents,
Methods and Arguments dialog.
5. List all functions in Hawk. In the MicroAgents, Methods and Arguments dialog, click
the COM.TIBCO.ADAPTER,bwengine.domain_name.project_name.Process Archine:0 item to list
all the functions in which the functions for port management are included.
For more information of how to use TIBCO Hawk, see TIBCO Hawk documentation.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 61
Chapter 6
TIBCO HL7/HIPAA Messaging Solution
This chapter describes HIPAA HL7 messaging and a TIBCO HL7/HIPAA messaging
solution.
Topics
•
HIPAA and HL7 Messaging, page 62
•
Working with TIBCO BusinessConnect EDI Protocol HIPAA Edition Powered by
Instream, page 63
•
Provider and Payor Roles When Sending an EDI-X12 275 HIPAA Message, page 65
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
62
| Chapter 6
TIBCO HL7/HIPAA Messaging Solution
HIPAA and HL7 Messaging
HL7 messages are typically exchanged between enterprise applications like a Patient
Administration System and a Pathology Laboratory Information system. However, HL7
messages must sometimes be embedded in certain HIPAA EDI-X12 transactions between
enterprises like hospitals and insurance companies.
For example, when a hospital sends a claim for payment to another enterprise, like an
insurance company, the hospital and the insurance company exchange HIPAA EDI-X12
messages. HIPAA EDI-X12 messages may contain an embedded HL7 message with
additional patient information requested from the insurance company.
TIBCO HL7/HIPAA Solution
To enable the exchange of HIPAA messages with HL7 attachments between enterprises,
TIBCO offers TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and TIBCO
BusinessConnect EDI Protocol HIPAA Edition powered by Instream.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is the TIBCO implementation of
the HL7 standard. TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 is a software
package that provides a framework for a healthcare provider’s internal HL7 HIPAA
messaging.
TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream is the
TIBCO implementation of the EDI standard, and offers specialized functionality for
customers who require HIPAA compliance.
Together, TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and TIBCO
BusinessConnect EDI Protocol HIPAA Edition powered by Instream enable the exchange
of HIPAA messages and embedded HL7 messages between enterprises like hospitals and
insurance companies.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Working with TIBCO BusinessConnect EDI Protocol HIPAA Edition Powered by Instream 63
|
Working with TIBCO BusinessConnect EDI Protocol HIPAA Edition
Powered by Instream
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 and TIBCO BusinessConnect EDI
Protocol HIPAA Edition powered by Instream can be used in concert to provide the ability
to include HL7 information in EDI-X12 275 HIPAA messages exchanged between a
healthcare enterprise and an external payor enterprise.
Sample High-Level Scenario
Figure 14 shows how the message exchange occurs.
Figure 14 Message Exchange
Provider
Hospital
Information
System (HIS)
TIBCO
ActiveMatrix
BusinessWorks
Plug-in for HL7
TIBCO
BusinessConnect
EDI Protocol
HIPAA Edition
1
EDI-X12 HIPAA 837 Message
2
EDI-X12 HIPAA 277 Message
3
EDI-X12 HIPAA 275 Message (HL7 embedded)
Payor
Insurance
Company
TIBCO
ActiveMatrix
BusinessWorks
Plug-in for HL7
TIBCO
BusinessConnect
EDI Protocol
HIPAA Edition
The following steps may occur:
1. You use TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream
to send an EDI-X12 837 Health Care Claim HIPAA message to an external payor.
2. The payor uses TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by
Instream to send an EDI-X12 277 Health Care Information Status Notification HIPAA
message back to you. This is a responder request for more information.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
64
| Chapter 6
TIBCO HL7/HIPAA Messaging Solution
3. You use TIBCO BusinessConnect EDI Protocol HIPAA Edition powered by Instream
to send an EDI-X12 275 Patient Information HIPAA message back to the payor. This
is a responder response message.
The BIN segment of this 275 XML message TIBCO BusinessConnect EDI Protocol
HIPAA Edition powered by Instream contains an embedded HL7 ORU (Observation
Result/Unsolicited) message created in TIBCO ActiveMatrix BusinessWorks Plug-in
for HL7 with the additional patient information that was requested. This information
can include diagnoses, test results, observations, and treatments.
The BIN segment is carried in the response field of the private RESPONDER.RESPONSE
message in EDI HIPAA. See the TIBCO BusinessConnect EDI Protocol HIPAA
Edition Guide for more information on the RESPONDER.RESPONSE messaging class.
The embedded HL7 ORU message is obtained during EDI processing in TIBCO
ActiveMatrix BusinessWorks. Also see HL7 ORU Messages on page 71.
There are many other scenarios where it make sense to use TIBCO ActiveMatrix
BusinessWorks Plug-in for HL7 and TIBCO BusinessConnect EDI Protocol HIPAA
Edition powered by Instream together. For example, after a patient is discharged, the HL7
discharge message can trigger queries to a billing system, which can then generate a
proper 837 HIPAA message to send to the insurance company. This streamlines the
operation for claim submission, brings valuable turn-around time for the provider, and
helps increase efficiency and return on investment.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Provider and Payor Roles When Sending an EDI-X12 275 HIPAA Message 65
|
Provider and Payor Roles When Sending an EDI-X12 275 HIPAA
Message
To submit an EDI-X12 275 HIPAA message, a provider system must do the following:
•
Express patient data as an HL7 ORU message. See HL7 ORU Messages on page 71
for information on ORU messages.
•
Use the appropriate LOINC (Logical Observation Identifier Names and Codes)
modifier code.
•
Wrap the HL7 ORU message in the BIN segment of an X12N-compliant 275 claims
attachment transaction. X12N is for exchanging insurance, eligibility, and managed
care information.
Payor Role When Receiving an EDI-X12 275 HIPAA Message
To process an EDI-X12 275 HIPAA message, a payor system must be able to parse the
HL7 ORU message embedded in the 275. TIBCO ActiveMatrix BusinessWorks Plug-in
for HL7 can easily perform this task.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
66
| Chapter 6
TIBCO HL7/HIPAA Messaging Solution
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 67
Appendix A
HL7 Messages
This appendix describes some aspects of HL7 messages.
Topics
•
HL7 Message Components, page 68
•
HL7 Sample Message, page 69
•
Making HL7 Messages More Readable, page 70
•
HL7 ORU Messages, page 71
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
68
| Appendix A
HL7 Messages
HL7 Message Components
Each HL7 message type definition contains a set of lines known as segments. Each
segment groups related information, and has a three-character name and a pre-defined
format of specific fields. The fields are separated by the | (pipe) character, and may be
further divided into subcomponents with the ^ character.
Different HL7 events trigger different message types - each message type has a defined set
of segments that are joined together to provide all the required information regarding that
event. Some segments are mandatory, and must be included in the message, and other
segments are optional.
Each segment is delimited by one of the following end line characters:
•
\n
•
0x0D
Each segment contains a specific type of information. Examples:
•
MSH. Information about the sender and receiver of the message, type of message, and
time stamp.
•
PID. Demographic information. This includes patient name, id codes, and address.
•
PV1. Information on the patient’s hospital stay. This includes location, and referring
doctor.
Each segment in turn contains a sequence of fields that are composites. These fields may
or may not repeat. Composites are delimited by "|".
HL7 Message Definition Parts
In the TIBCO Foresight Instream and Translator, each message definition contains the
following parts:
•
Segment Grammar. This gives the HL7 format of the message.
•
Table Grammar. This gives the internal view of the message as seen by an enterprise
application.
•
Identity. This determines how TIBCO Foresight Instream and Translator recognizes
the message.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Sample Message 69
|
HL7 Sample Message
The following is a typical HL7 ADT^A04 message, which is sent after a patient enters the
hospital. When the patient information is entered into the Patient Administration System
(PAS), the information is sent to other enterprise systems, such as Pathology Laboratory
Information Systems or Pharmacy Systems.
MSH|^~\&|EPIC|EPICADT|SMS|SMSADT|199912271408|CHARRIS|ADT^A04|1817457|D|2.3|EVN|A04|199912271
408|||CHARRIS
PID||0493575^^^2^ID 1|454721||DOE^JOHN^^^^|DOE^JOHN^^^^|
19480203|M||B|254 E238ST^^EUCLID^OH^44123^USA||(216)731-4359|||
M|NON|400003403~1129086|999-|
NK1||CONROY^MARI^^^^|SPO||(216)731-4359||EC|||||||||||||||||||||||||||
PV1||O|168 ~219~C~PMA^^^^^^^^^||||277^ALLEN FADZL^BONNIE
^^^^|||||||||| ||2688684|||||||||||||||||||||||||
199912271408||||||002376853
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
70
| Appendix A
HL7 Messages
Making HL7 Messages More Readable
HL7 messages are in ASCII, and are difficult to interpret. However, you can use TIBCO
Foresight Instream and Translator to instantly convert an HL7 ASCII message into a tree
format. You can also use TIBCO Foresight Instream and Translator to convert an HL7
ASCII message to XML. TIBCO has defined an XML format that is easy to read. This
also allows data to work well with other components in TIBCO ActiveMatrix
BusinessWorks.
You can also use TIBCO Foresight Instream and Translator to convert the XML message
back to ASCII.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 ORU Messages 71
|
HL7 ORU Messages
A HIPAA-compliant ORU message contains the following:
•
Message header and patient information.
•
One or more observation request (OBR) segments defining observation type and
request specifics.
•
One or more observation result (OBX) segments defining, quantifying, and qualifying
the results.
•
One or more LOINC (Logical Observation Identifier Names and Codes) modifier
codes used in the OBR and/or OBX segments as universal identifiers for laboratory
and other clinical observations.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
72
| Appendix A
HL7 Messages
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 73
Appendix B
HL7 Error Codes
This appendix describes HL7 Error codes
Topics
•
HL7 Error Codes, page 74
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
74
| Appendix B
HL7 Error Codes
HL7 Error Codes
BW-HL7-100000: Undefined TIBCO Foresight message code [%1], see the description from
TIBCO Foresight documentation for details.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity or the Validate HL7 activity.
This error returns a TIBCO Foresight message code, which is not defined by TIBCO
ActiveMatrix BusinessWorks Plug-in for HL7.
Resolution: Search the message code in the TIBCO Foresight documentation for a
resolution.
BW-HL7-100001: MSH has only [%1] fields.
Role: errorRole
Category: BW_Plugin
Description: Error while parsing HL7 message header. This message returns the number
of the MSH fields.
Resolution: Check the input HL7 message header, which should have twelve fields.
BW-HL7-100002: Can't find version ID - MSH.12 is: [%1].
Role: errorRole
Category: BW_Plugin
Description: Error while parsing HL7 message header. This message returns the value of
the twelfth MSH field.
Resolution: Set a valid value to the twelfth MSH field of the input HL7 message header.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 75
|
BW-HL7-100003: Invalid or incomplete encoding characters - MSH-2 is: [%1].
Role: errorRole
Category: BW_Plugin
Description: Error while parsing HL7 message header. This message returns the value of
the second MSH field.
Resolution: Set a valid value to the second MSH field of the input HL7 message header.
BW-HL7-100004: Invalid hl7 message: [%1].
Role: errorRole
Category: BW_Plugin
Description: The input HL7 message is invalid.
Resolution: Check the input HL7 message.
BW-HL7-100005 Can't find field separator in MSH: [%1].
Role: errorRole
Category: BW_Plugin
Description: Error while parsing the HL7 message header. This message returns the
incorrect HL7 header message.
Resolution: Check the input message and use a valid separator.
BW-HL7-100006: Error while parsing hl7 header, hl7 message cannot be null.
Role: errorRole
Category: BW_Plugin
Description: Error while parsing HL7 message header. The HL7 message header is null.
Resolution: Check the input HL7 message header.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
76
| Appendix B
HL7 Error Codes
BW-HL7-200110: Validation did not run successfully. The command line syntax is incorrect.
Role: errorRole
Category: BW_Plugin
Description: There is no License file for TIBCO ActiveMatrix BusinessWorks Plug-in
for HL7.
Resolution: Check the License file.
BW-HL7-200129: $dir.ini or fsdir.ini was found but cannot be opened.
Role: errorRole
Category: BW_Plugin
Description: When running the Validate H7 activity, the $dir.ini or fsdir.ini file can be found,
but cannot be opened.
Resolution: Check if the file is broken.
BW-HL7-200130: There was a problem with initialization of the validation engine caused by a
setup problem (for example, registry setup error) or $dir.ini or fsdir.ini is missing or contains
invalid paths.
Role: errorRole
Category: BW_Plugin
Description: Error when initializing the validation engine.
Resolution: Check the following errors: setting up errors, missing the $dir.ini or fsdir.ini file,
or the $dir.ini or fsdir.ini file containing invalid paths.
BW-HL7-200131: $dir.ini or fsdir.ini cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Validate HL7 activity.
Resolution: Make sure that the $dir.ini or fsdir.ini file is in the
TIBCO_FORESIGHT_HOME/Instream/bin directory.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 77
|
BW-HL7-200132: Cannot access the "BASEROOT" specified in the $dir.ini or fsdir.ini.
Role: errorRole
Category: BW_Plugin
Description: BASEROOT is not specified correctly.
Resolution: Set a correct value to BASEROOT.
BW-HL7-200133: Cannot access the Database directory.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Validate HL7 activity.
Resolution: Check whether the TIBCO_FORESIGHT_HOME/Instream/Database directory exists.
BW-HL7-200134: Generic failure to read INI settings.
Role: errorRole
Category: BW_Plugin
Description: Error while reading the settings in the $dir.ini or fsdir.ini file.
Resolution: Check the $dir.ini or fsdir.ini file.
BW-HL7-200140: A critical error prevented Validation from running successfully.
Role: errorRole
Category: BW_Plugin
Description: It returns an unexpected critical error.
Resolution: The resolution depends on the error.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
78
| Appendix B
HL7 Error Codes
BW-HL7-200150: Cannot find or open FS_HIPAA.dat in the Bin directory.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Validate HL7 activity.
Resolution: Check if the FS_HIPAA.dat file exists or is broken.
BW-HL7-200180: The activity was cancelled by the user (when using API).
Role: errorRole
Category: BW_Plugin
Description: Error when cancelling the Validate HL7 activity.
Resolution: None.
BW-HL7-200191: A critical trading partner automation error prevented Validation from running
successfully. For more information, see *.TA1 in the same directory as the validation detail
results file.
Role: errorRole
Category: BW_Plugin
Description: A critical trading partner automation error prevents Validation from running
successfully.
Resolution: For more information, see the *.TA1 file in the same directory as the
validation detail results file.
BW-HL7-200195: Cannot find the error message file. Check the [ErrMsgFile] of your $dir.ini or
fsdir.ini file.
Role: errorRole
Category: BW_Plugin
Description: Cannot find the error message file.
Resolution: Check [ErrMsgFile] of the $dir.ini or fsdir.ini file.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 79
|
BW-HL7-200200: Configuration path error when using the -c command-line parameter.
Role: errorRole
Category: BW_Plugin
Description: The path of the $dir.ini file you input in the -c command line is invalid.
Resolution: Check the input path of the $dir.ini file.
BW-HL7-200201: The input file could not be accessed. Check filenames and paths. Put quotes
around paths that contain spaces.
Role: errorRole
Category: BW_Plugin
Description: The validator profile file or guideline cannot be accessed.
Resolution: Check file names and file paths. Put quotes around paths that contain spaces.
BW-HL7-210000: [%1] cannot be converted to Number. The summary report contains some
error values.
Role: errorRole
Category: BW_Plugin
Description: It returns the value of total error numbers.
Resolution: None.
BW-HL7-210001: Missing Guideline file because of %1 cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when the guideline file cannot be found.
Resolution: Make sure the guideline file is in the
TIBCO_FORESIGHT_HOME/Instream/Database directory.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
80
| Appendix B
HL7 Error Codes
BW-HL7-210002: Validator Profile cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when validator profile cannot be found.
Resolution: Make sure that the validator_profile is in the
TIBCO_FORESIGHT_HOME/Instream/Bin directory.
BW-HL7-300105: Open Source Schema failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the source schema.
BW-HL7-300106: Guidelines specified in the API are not the same guidelines used in the map.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check that the guidelines used in the map are the same ones with the
specified guidelines in the API.
BW-HL7-300110: Command line error or error in loading the INI file.
Role: errorRole
Category: BW_Plugin
Description: Error when inputting incorrect command line parameter or modifying the
$dir.ini
configuration file incorrectly.
Resolution: Check the input command line parameter or the modification of the $dir.ini
configuration file.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 81
|
BW-HL7-300111: One of the documents being translated must be HL7 when using TIBCO
ActiveMatrix BusinessWorks Plug-in for HL7.
Role: errorRole
Category: BW_Plugin
Description: Error when using documents excluding HL7 document.
Resolution: Make sure to use HL7 document as one of the documents.
BW-HL7-300124: Configuration invalid. If this occurred when using the API, this is often
because it cannot read the INI file. Check TRANSRoot.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check TRANSRoot.
BW-HL7-300131: The map file doesn't match the convert call.(Example: Attempting to convert
EDI to XML by using an XML-to-EDI map.)
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the map file.
BW-HL7-300140: System failure. API return code for System failure.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: The resolution depends on the system failure.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
82
| Appendix B
HL7 Error Codes
BW-HL7-300154: Converting between this type of source and target is not supported.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity. The specified operation type
is not supported.
Resolution: Use the supported operation types. See Translate HL7 on page 17 for details.
BW-HL7-300155: Open Source Guideline failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity. The source STD guideline
cannot be opened.
Resolution: Check the source guideline.
BW-HL7-300156: Open Target Schema failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity. The target schema cannot
be opened or the target schema is invalid.
Resolution: Check the target schema.
BW-HL7-300157: Open Target Guideline failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity. The target STD guideline
cannot be opened.
Resolution: Check the target STD guideline.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 83
|
BW-HL7-300158: Open map file failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity. The map file cannot be
opened.
Resolution: Check the map file.
BW-HL7-300171: Configuration invalid. If this occurred when using the API, this is often
because it cannot read the INI file. Check TRANSRoot.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check TRANSRoot.
BW-HL7-300172: Missing source guideline.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the source guideline in the specified MAP file.
BW-HL7-300173: Missing Target guideline.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the target guideline in the specified MAP file.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
84
| Appendix B
HL7 Error Codes
BW-HL7-300174: Missing Map.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Specify the MAP file in the Input tab. If the MAP file is specified, check
whether the file exists, and whether the file name is correct.
BW-HL7-300175: Missing the input data in the inputByMemory when using the API.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check whether the input data is specified for the Translate HL7 activity.
BW-HL7-300176: Cannot access input file in the inputByfFile when using the API.
Role: errorRole
Category: BW_Plugin
Description: The input file name and file path are invalid.
Resolution: Check the file name and file path.
BW-HL7-300177: The source file separators are invalid as specified by separator in the API.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Use the valid source file separators.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
HL7 Error Codes 85
|
BW-HL7-300178: The target file separators are invalid as specified by separator in the API.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Use the valid target file separators.
BW-HL7-300199: JNI Exception Occurred. The API is getting a JNI exception occurred and
can’t run Java.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: None.
BW-HL7-310000: When invoking Validate API, the output error was found: [%1].
Role: errorRole
Category: BW_Plugin
Description: Error when calling the Translator API.
Resolution: Check whether the TIBCO Foresight Translator is installed correctly or
restart TIBCO Designer.
BW-HL7-310001: Missing source guideline. [%1] cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the source guideline in the specified MAP file.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
86
| Appendix B
HL7 Error Codes
BW-HL7-310002: Missing Target guideline. %1 cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when the source guideline file in the specified MAP file cannot be
found.
Resolution: Check the target guideline in the specified MAP file.
BW-HL7-310003: Missing Map file. %1 cannot be found.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Specify the MAP file in the Input tab. If the MAP file is specified, check
whether the file exists, and whether the file name is correct.
BW-HL7-310004: Guideline name is null in the Map File.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the guideline name in the specified map file.
BW-HL7-310005: Parsing map file failed.
Role: errorRole
Category: BW_Plugin
Description: Error when running the Translate HL7 activity.
Resolution: Check the input map file.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
| 89
Glossary
A
B
ack
B2B
A return message in a B2B request/response
transaction indicating that data has been received
correctly. Typically, if the sender of the original data
does not receive an ack message back before a
predetermined time, or receives a nack, the sender
re-sends the original data. See also nack.
Business to Business. Electronic, integrated
communication between businesses, usually over the
Internet or over a VPN. See also VPN.
C
ActiveEnterprise
One of the three product families within TIBCO
Software Inc. TIBCO ActiveEnterprise focuses on
enterprise application integration. The other two
product groupings are TIBCO ActivePortal™ and
TIBCO ActiveExchange™. See www.tibco.com for
details.
Legacy applications and other applications are
integrated using software from TIBCO into a
communicating and event-driven whole.
alert
A notification to an end-user. For example, this might
include scheduled alerts delivering portal headlines to
a chosen device.
asynchronous transaction type
A request/response transaction type in which the
responder sends a response on a channel other than
the sending channel. See also synchronous
transaction type.
CA
Certificate Authority. See also Certificate Authority.
CDATA
Character data. CDATA has two very different
meanings in XML. The first meaning is used within
document type declarations, where CDATA is used
within attribute declarations to indicate that an
attribute should contain character content, and that no
enumerated set of values is provided to constrain that
content. The second meaning applies only within
documents, where CDATA marked sections
(beginning with <![CDATA[ and ending with ]]>)
label text within documents that is purely character
data, containing no elements or entities that need to be
processed. CDATA sections provide an 'escape'
mechanism supporting documents containing
characters (typically <, >, and &) that would interfere
with normal processing.
certificate
A data string that a Certificate Authority (CA) creates
after the CA verifies the identity of an entity that has
submitted a CSR (Certificate Signing Request). When
a CA signs and issues a certificate to a user, the CA’s
signature on the certificate verifies the authenticity of
the link between the user’s public key and the user’s
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
90
| Glossary
actual identity. A user can then use its certificate, as
contained in its certificates file, to identify itself
during e-commerce. The three key items in a
certificate are the CA’s signature, the user’s identity,
and the user’s public key.
A certificate is like a driver’s license in that both are
issued by a recognized authority (a CA or a
governmental agency, respectively) and both identify
the holder.
A certificate’s contents are specified by the X.509
standard, such as X.509v3.
If client-side authentication is required, an entity is
authenticated using the X.509 certificate that the
client provides to the server.
A certificate contains the following items, among
others:
— An entity’s public key. This is like a signature on a
driver's license.
— An entity’s "distinguished-name" information.
This is like personal information on a driver’s license.
Examples: Name, organizational unit, organization,
city or locality, state or province, and country code.
— The CA’s digital signature. This is like the
lamination, holographs, and other unique packaging
on a driver’s license. This "proves" to a third party
that the CA has authenticated the user’s identity.
— The CA’s "distinguished-name" information. This
is like the issuing agency’s identifying information on
a driver’s license.
— A date range. This describes the time period in
which the certificate is valid.
The data string known as a certificate can be
represented by itself in different file formats. Among
these would be .der and .pem.
A certificate is in a certificate chain. See also
certificate chain.
Certificate Authority (CA)
A trusted third party that validates identities and
issues X.509 certificates by signing the certificate
with its signature. Any client or server software that
supports certificates has a collection of trusted CA
certificates. These trusted CA certificates determine
which certificate issuers the software can "trust".
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
The root CA's certificate is unique in that it is a
self-signed certificate. It is signed by the root CA
itself. The CAs that are directly subordinate to the
root CA in the CA hierarchy have CA certificates that
were verified and signed by the root CA.
certificate chain
A list of certificates made up of a user’s X.509 digital
certificate and the certificate chain of its CA’s
certificates. The top certificate of the certificate chain
is the "root" CA certificate. Each CA’s certificate is
followed by the certificate of the CA that issued the
first CA’s certificate.
A certificate chain can be in a certificates file. See
also certificates file.
A certificate chain can also be in a key identity file.
See also key identity file.
certificates file
A file that contains a private key’s certificate chain.
Unlike a key identity, it contains no private key and is
not protected with a password. Trading partners
exchange certificates files during the setup phase of
their relationship. Each trading partner then installs
the other partner’s certificates file. For a host to verify
the validity of a trading partner’s certificate, the host
must "trust" each CA’s certificate in the certificate
chain within the trading partner’s certificates file. The
certificates file defines how each trading partner
should expect the other to identify itself in
e-commerce transactions. The supported format is
PKCS#7 "certificates only", which can have file
extensions like .p7b and .p7c. When setting up an
installation for e-commerce, the key identity file
relates to the trading host and certificates file(s) relate
to any trading partner(s) that the host has.
ChemXML™
An XML-based data exchange standard for buying,
selling, and delivering chemicals. CIDX™ (Chemical
Industry Data eXchange) developed ChemXML on a
non-profit basis for use in the chemical industry to
conduct electronic business transactions and
exchange data in company-to-company,
Glossary 91
|
company-to-marketplace, and
marketplace-to-marketplace transactions.
D
DBMS
CIDX™
Data that has been encrypted.
Data Base Management System. A complex set of
programs that controls the organization, storage, and
retrieval of data for many users. Data is organized in
fields, records, and files. A database management
system also controls the security of the database.
cleartext
digital certificate
Data that has not been encrypted.
See certificate.
client
digital signature
In the context of a B2B interaction, the client is the
initiating partner. See also server.
See signature.
See ChemXML.
ciphertext
document type declaration
CMS
Cryptographic Message Syntax. The internal format
of an S/MIME message. See also S/MIME.
container
Containers provide visual separation of categories on
the portal page, and they provide category-level
controls such as minimize and close. They also
provide links as required to category related forms for
alerts and personalization. Category containers are
defined as HTML templates.
CRM
Customer Relationship Management. A type of
software that automates a company's sales force,
marketing efforts, and customer service needs.
CSR
Certificate Signing Request. The file that you send to
a CA such as Verisign when you request a certificate.
The CSR contains your email address and certain
identifying information.
CSV
Common Separated Values. A message structure
format.
A declaration that provides a document type
definition (DTD) for an XML document. The
document type declaration may refer to an external
file (the "external subset"), include additional
declarations (the "internal subset"), or combine both.
The document type declaration also gives the root
element for the document.
DTD
Document Type Definition. A non-XML schema file
that contains a formal description of the vocabulary
and structure of the elements in an associated XML
file. DTDs serve the same function as XML schema
documents. A DTD may also provide some content
information. The DTD for an XML document is the
combination of the internal and external subsets
described by the document type declaration. See also
XML. Also see www.extensibility.com for
information on TIBCO’s XML Authority, the premier
solution for the creation, conversion, and
management of DTDs and XML schemas.
DUNS Number
A number in the Data Universal Numbering System
from Dun & Bradstreet. TIBCO BusinessConnect
uses DUNS numbers for RosettaNet and ChemXML.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
92
| Glossary
E
EAI
Enterprise Application Integration. Plans, methods,
and tools for modernizing, consolidating, and
coordinating the applications in an enterprise. EAI
includes methodologies like object-orientated
programming, distributed, cross-platform program
communication, the modification of ERP applications
to fit new objectives, enterprise-wide content and data
distribution using common databases and data
standards implemented with XML, middleware,
messaging, and other approaches. See also ERP.
ebXML
(electronic business XML) is a business protocol that
allows buyers, sellers, and intermediaries to securely
share XML or non-XML business documents and
messages reliably over the Internet. The ebXML suite
of specifications offers companies a standard method
for exchanging business messages, conducting trading
relationships, communicating data in common terms,
and defining and registering business processes.
e-paymentsPlus facilitates secure payment
transactions between a buyer and a seller.
e-paymentsPlus uses TrustAct as a messaging service.
However, unlike TrustAct, which just conveys a
business message between buyer and seller without
interpreting its contents, e-paymentsPlus defines a set
of structured messages that convey payment
information.
ERP
Enterprise Resource Planning. An integrated
information system that serves all departments within
an enterprise. An ERP system can include software
for manufacturing, order entry, accounts receivable
and payable, general ledger, purchasing, warehousing,
transportation and human resources.
exception
At the software level, anything that has gone wrong,
typically within a lower level code module. At the
business process level, an exception is anything that
requires special processing to account or adjust for,
such as correcting an invalid order.
EDI
Electronic Data Interchange. A native SAP message
format. EDI is most often used by trading partners in
the exchange of standardized documents. EDI uses
some variation of the ANSI X12 standard (USA) or
EDIFACT (UN-sponsored global standard).
element
The unit forming the basic structure of XML
documents. Elements may contain attributes in their
start tags, other elements, and textual content. See
also XML.
F
FTP
File Transfer Protocol. A client-server protocol which
allows a user on one computer to transfer files to and
from another computer over a TCP/IP network. Also
used to refer to the client program the user executes to
transfer files. See also TCP/IP.
function
See transform.
e-paymentsPlus
A service offered by SWIFT to its member financial
institutions to allow those institutions to provide
internet-based payment initiation services to their
corporate customers engaged in B2B e-commerce.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Glossary 93
|
G
GUI
message store on a host server. IMAP is newer and
has more features than the more popular POP access
protocol. See also POP.
Graphical User Interface.
J
H
HIPAA
Health Insurance Portability and Accountability Act.
Enacted in 1996 to streamline health care transactions
across enterprises and to uphold patients' privacy
rights. HIPAA standards have been established for
electronic health care transactions.
HL7
Health Level Seven. A messaging standard for
exchanging clinical and administrative data between
health care applications from various vendors,
typically within an enterprise.
JSSE
Java™ Secure Socket Extension. A Java standard that
enables SSL. As SSL is not part of Java, different
vendors offer different JSSE implementations. See
also SSL.
K
key file
See key identity file.
key identity file
HTTP
Hypertext Transfer Protocol. A client-server TCP/IP
transport protocol used on the web for exchanging
documents. By default, HTTP uses port 80. See also
TCP/IP.
HTTPS
Hypertext Transfer Protocol, Secure. A variant of
HTTP used for creating secure transactions. HTTPS
uses SSL to encrypt the HTTP transport. Messages
sent over the secure transport are not themselves
encrypted. By default, HTTPS uses port 443. See also
SSL.
A file that contains a private key and its certificate
chain. It is encrypted with a password because it
contains a private key. Trading partners create a key
identity for their own installations. When setting up
an installation for e-commerce, the key identity file
relates to the trading host and certificates file(s) relate
to any trading partner(s) that the host has. TIBCO
ActiveExchange products support Entrust Profile
(.epf) (as implemented by Entrust), and PKCS#12
(.p12 or .pfx) (as implemented by Netscape and
Microsoft and others).
key pair
A private/public key pair.
I
IMAP, IMAP4
Internet Message Access Protocol. A transport
protocol for email clients to retrieve email from a
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
94
| Glossary
M
P
MAPI
parsed
Messaging Applications Programming Interface. A
proprietary interface to client email servers.
For XML, data that has been converted to the TIBCO
IntegrationManager internal representation
(AttributeNode) and which can be accessed at the
field level by other components. See also unparsed.
MIME
Multipurpose Internet Mail Extensions. A standard
structured messaging format which allows a single
message to contain many parts, such as plain text,
web hypertext documents, graphics, audio, and fax.
MIME specifies how messages must be formatted so
that they can be exchanged between different email
systems. MIME is a very flexible format, which can
include virtually any type of file or document in an
email message. MIME uses base64 and other
encodings to encode non-text information as text to
make sure that email messages with images or other
non-text information are delivered with maximum
protection against corruption. For example, a MIME
message may have a header, body, and digital
signature. See also S/MIME.
N
nack
A return message indicating that data has not been
received correctly. See also ack.
PIP
Partner Interface Process. Part of the RosettaNet and
ChemXML business protocols.
PKI
Public Key Infrastructure. The infrastructure
necessary to successfully use public key
cryptography. This infrastructure includes certificates
and certificate authorities.
plugin
A data container with fields for specifying how data is
routed in a transform. A plugin can retrieve input data
from a file, or output it to TIBCO Rendezvous. Each
plugin also has multiple read-only fields. By entering
data in the input fields, you configure the plugin to fit
your environment. A plugin has input and output
properties that are graphically represented as ports.
Connection lines that represent data flow are drawn
between ports. The resulting transform defines part or
all of a particular business transaction. When plugins
are activated, the transform becomes functional
during the next run-time mode. See transform.
non-repudiation
Non-repudiation of service allows the sender of a
message to provide the recipient of a message proof
of the origin of the message. This protects against any
attempt by the sender to subsequently revoke the
message or its content. This is based on a sender’s
unique digital signature.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
PO
Purchase Order.
POP, POP3
Post Office Protocol. A client-to-host transport
protocol for email clients to retrieve email from a
message store. POP is more widely used than the
IMAP protocol, which has more features. See also
IMAP.
Glossary 95
|
private key
RV
The part of a key pair that is kept strictly confidential.
It is encrypted with a password. It is used for message
unencryption and for signing. A private key is kept in
a key identity file.
TIBCO Rendezvous protocol. A distributed TIBCO
messaging protocol middleware product.
public key
S
The part of a key pair that can be shared with
anybody. It is used for message encryption and for
verifying a signature.
schema
A public key is kept in a certificate.
public key cryptography
A system that offers encryption and digital signatures.
Each user has a public key and a private key. The
public key is made public while the private key
remains private. A sender encrypts a document using
the recipient’s public key. The recipient decrypts the
document using their private key. Also, a sender signs
a document using their private key. The recipient
authenticates the sender using the sender’s public key.
See also symmetric key cryptography.
See XML schema.
server
In the context of a B2B interaction, the server is the
responding partner. See also client.
SGML
Standard Generalized Markup Language. A generic
language for representing hypertext documents.
signature
R
A verifiable transformation made on a piece of data
by the private key, which can be verified by using the
public key. A digital signature binds a document to
the possessor of a particular key. A signature usually
also contains the possibly incomplete certificate chain
of the signer. See also certificate.
request/response
S/MIME
A type of message that requires a response from the
receiver. This can synchronous or asynchronous.
Secure Multipurpose Internet Mail Extensions. A way
of adding security to objects that are packaged with
MIME. A messaging format for exchanging digitally
signed and/or encrypted messages. S/MIME defines a
data encapsulation format for the provision of a
number of security services that include data integrity,
confidentiality, and authentication. S/MIME is
designed for messaging clients delivering security
services to distributed messaging applications.
S/MIME (RFC 2311) is based on the MIME standard
(RFC 1521). The following are the file types for
S/MIME messages when saved to disk: p7c, p7m,
p7s, p10. See also MIME.
RosettaNet
A business protocol that allows buyers, sellers,
aggregators, and intermediaries to conduct
transactions over the Internet. RosettaNet transactions
involve the exchange of documents, most of which
correspond to hardcopy documents traditionally used
in business. These documents are simple text files, but
they have a well-defined structure and contents due to
the use of RosettaNet PIPs (Partner Interface
Processes).
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
96
| Glossary
SMTP
symmetric key cryptography
Simple Mail Transport Protocol. A host-to-host mail
transport protocol for email. As it is a server-to-server
protocol, other protocols such as IMAP, POP, and
POP3 are used to retrieve the email from the host’s
mail server. SMTP is the standard for servers that
move email over the Internet.
A system that offers encryption. The same key is used
to encrypt and unencrypt data. A sender encrypts a
document using the symmetric key, and the recipient
decrypts the document using the same symmetric key.
See also public key cryptography.
synchronous transaction type
SOAP
Simple Object Access Protocol. An XML-based
business protocol for exchanging information in a
decentralized, distributed environment.
A request/response transaction type in which the
responder sends a response on the sending channel.
See also asynchronous transaction type.
SQL
Structured Query Language. A language for accessing
data in a database.
T
TCP/IP
SSL
Secure Sockets Layer. A protocol designed by
Netscape Communications Corporation to encrypt
data and authenticate senders. SSL is the industry
standard for sharing secured data over the web. SSL
provides encryption, client and server authentication,
and message integrity. SSL is part of all major
browsers and web servers. Installing a digital
certificate makes a browser or server’s SSL
capabilities available. SSL is layered beneath
protocols such as HTTP, SMTP, Telnet, FTP, Gopher,
and NNTP. SSL is layered above the TCP/IP
connection protocol. SSL can use digital certificates
to authenticate an encrypted socket. A client signs
random data with a private key during the setup phase
of an SSL connection to authenticate itself. Encrypted
data sent after the setup phase is not signed. SSL is
available at the 40-bit, 56-bit, and 128-bit levels. This
refers to the length of the session key that every
encrypted conversation generates. The longer the
session key is, the more difficult it is to break the
encryption code. TIBCO BusinessConnect supports
different levels of SSL, including the highest level,
which uses server and client authentication. SSL is
used by HTTPS. See also HTTPS.
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Transmission Control Protocol on top of the Internet
Protocol. Protocols to enable communication between
different types of computers and computer networks.
TCP is a connection-oriented protocol that provides
reliable communication and multiplexing. IP is a
connectionless protocol that provides packet routing.
transform/transformation function
A function allows you to represent and transform data
in a TIBCO BusinessPartner transform. All
transformation functions available in TIBCO
MessageBroker are available in TIBCO
MessageBroker software. In addition, custom
functions are provided that can be used with plugins.
This allows you to convert information into a
different data format. A transformation function takes
one or more inputs and produces a single output. For
example, a function can be used to convert a purchase
order into a tree format, and then into another format,
such as a TIBCO Rendezvous message. See plugin.
type-aware
A document that uses a schema of some sort. The
in-memory representation of 'type-aware' data uses
strings, numbers, and arrays, among others. See also
untyped.
Glossary 97
|
U
V
UCCnet
VAN
A universal foundation for industry standards-based
electronic commerce. This provides foundational
product registry services, enabling the
synchronization of item and location information
among trading partners, trade exchanges, solution
partners and national data pools. UCCnet also
facilitates interoperability among these groups by
providing companies visibility to a wide range of
information and resources.
Value-added network. A communications network in
an EDI setting that provides services beyond normal
transmission, such as automatic error detection and
correction, protocol conversion, and message storing
and forwarding.
unparsed
For XML, an XML document in the form of a giant
string or byte array. TIBCO IntegrationManager
components, unless they have special support for
parsing XML, can utilize XML only as a string byte
array. See also parsed.
VPN
Virtual Private Network. A network that is configured
within a public network. For years, common carriers
have built VPNs that appear as private national or
international networks to the customer, but physically
share backbone trunks with other customers. VPNs
enjoy the security of a private network via access
control and encryption, while taking advantage of the
economies of scale and built-in management facilities
of large public networks.
untyped
A document that does not use a schema. The
in-memory representation of 'untyped' data is an array
of name->value pairs. For XML, it is an array of
name->(string or element) pairs, and character data is
represented by some 'special' name, such as _CDATA.
See also type-aware.
URI
Uniform Resource Identifier. A resource identifier
that describes a location (URL) or name (URN) for
identifying an abstract or physical resource.
X
XDR
XML Data Reduced. An XML schema language from
Microsoft. XDR supports data typing and XML
namespaces. XDR is part of Microsoft’s BizTalk.
".xdr" is the suffix of an XDR schema document. An
XDR file defines the structure and elements in a
related XML file.
XML
URL
Uniform Resource Locator. A resource identifier that
describes its target by giving a pathway for retrieving
it. A URL may include a protocol, a host computer,
and how to find the target resource on that computer.
URN
Uniform Resource Number. A resource identifier that
uses a naming scheme to identify resources.
eXtensible Markup Language. A standardized
document formatting language that provides a set of
standards for document syntax while allowing
developers, organizations, and communities to define
their own vocabularies. XML is a standard for passing
data between Internet applications. XML lets users
label information using custom tags that describe the
structure and meaning of a file’s content. XML
documents contain data in the form of tag/value pairs.
XML gives much more control than HTML over
collecting, searching, combining, formatting, and
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
98
| Glossary
delivering content to different audiences for different
purposes. XML is a standard for passing data between
Internet applications. XML documents contain data in
the form of tag/value pairs. See also
www.extensibility.com for information on TIBCO
XML products.
XML schema
The definition of the content in an XML document.
Some features include: Data typing enables defining
data by type (character, integer, etc.); Schema reuse,
or schema inheritance, lets tags referenced in one
schema be used in other schemas; Namespaces
enables multiple schemas to be combined into one;
Global attributes assign properties to all elements;
Associating Java classes adds processing to the data;
Authoring information adds improved documentation
for schema designers.
An XML schema is an XML element
information item which, along with its descendants,
satisfies all the constraints on schemas in a
specification. An XML schema establishes a set of
rules for constraining the structure and articulating the
information set of XML document instances. See
www.extensibility.com for information on TIBCO’s
XML Authority®, the premier solution for the
creation, conversion, and management of DTDs and
XML schemas.
Unlike a DTD, an XML schema is written in XML.
Although XML schemas are more verbose than
DTDs, they can be created with any XML tool.
XSD
XML Schema Definition. ".xsd" is the suffix of an
XSD schema document. An XSD file defines the
structure and elements in a related XML file.
XSDL
XML Schema Definition Language. An XML schema
dialect. Expressed in XML document syntax, XSDL
supports an extensible data typing system,
inheritance, and namespaces. See
www.extensibility.com for information on TIBCO’s
XML Authority®, the premier solution for the
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
creation, conversion, and management of documents
in XML schema dialects, including XSDL.
XSL
Extensible Style Language. A stylesheet language for
XML. XSL uses template rules that are written using
XML to transform documents into formatting objects,
which are then presented on screen, in print, or in
other media.
XSLT
Extensible Stylesheet Language Transformations. A
language for transforming XML documents into other
XML documents. XSLT is designed for use as part of
XSL. In addition to XSLT, XSL includes an XML
vocabulary for specifying formatting. XSL specifies
the styling of an XML document by using XSLT to
describe how the document is transformed into
another XML document that uses the formatting
vocabulary.
| 101
Index
A
ack 89
ActiveEnterprise 89
activities
LLP Receiver 28
LLP Request Response 26
LLP Response 30
Parse HL7 Header 23
Translate HL7 17
Validate HL7 21
alert 89
architecture 9
asynchronous transaction type 89
aveSize 58, 59
container 91
creating a project 46
CRM 91
CSR 91
CSV 91
currentTimeMillis 54
currentTimeStamp 54
custom functions
currentTimeMillis 54
currentTimeStamp 54
deleteSegments 54
displayableToHL7 54
extractField 54
generateNewGUID 54
HL7ToDisplayable 54
separateMsgsFromBatch 54
trimEmptyFields 54
customer support xvii
B
B2B 89
BWPLUGINHL7_HOME xv
bwpluginhl7_HOME 52
C
CA 89
CDATA 89
certificate 89
Certificate Authority (CA) 90
certificate chain 90
certificates file 90
changes from the previous release of this guide xii
ciphertext 91
cleartext 91
client 91
CMS 91
D
DBMS 91
deleteSegments 54
deploying a project 51
digital certificate 91
digital signature 91
displayableToHL7 54
document type declaration 91
DTD 92
DUNS Number 92
E
EAI 92
earliestMsgSendtimeSinceStart 58, 59
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
102
| Index
EDI 92
EDI-X12 275 HIPAA message 67
element 92
Enterprise Archive, EAR 51
ERP 92
exception 93
extractField 54
I
IMAP, IMAP4 93
isActive 58, 59
J
JSSE 93
F
flat file 22
FTP 93
function 93
K
key file 94
key identity file 94
key pair 94
G
generateNewGUID 54
GUI 93
H
Health Insurance Portability and Accountability Act 2
Health Level Seven 2
healthcare messaging standards 1
HIPAA 2
HL7 2, 3
HL7 and HIPAA messaging standards 2
HL7 implementation questions 3
HL7 implied data model 6
HL7 message components 69
HL7 ORU messages 73
HL7 platte 12
HL7 protocol 4
HL7 sample message 71
HL7ToDisplayable 54
HTTP 93
HTTPS 93
L
latestMsgSendtimeSinceStart 58, 59
LLP Connection activity 14
LLP Connection resource 14
LlP Connection shared resource 47
LLP Receiver activity 28
LLP Request Response activity 26
LLP Response activity 30
LLP_GetClientsInfo 57, 59
LLP_GetClientStatsInfo 57, 59
LLP_GetServersInfo 57
LLP_GetServerStatsInfo 57
LLP_ResumeClient 57
LLP_ResumeServer 56
LLP_SuspendClient 56
LLP_SuspendServer 56
M
MAP 8
MAPI 94
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Index 103
|
maxSize 58, 59
MIME 94
N
nack 94
non-repudiation 94
numMsg 58, 59
P
Parse HL7 Header activity 23
parsed 94
PIP 94
PKI cryptography 94
plugin 95
PO 95
POP, POP3 95
port 58, 59
port management 55, 60
port manager functions
LLP_GetClientsInfo 57, 59
LLP_GetClientStatsInfo 57, 59
LLP_GetServersInfo 57
LLP_GetServerStatsInfo 57
LLP_ResumeClient 57
LLP_ResumeServer 56
LLP_SuspendClient 56
LLP_SuspendServer 56
private key 95
Process Engine 12
public key 95
public key cryptography 95
public key infrastructure cryptography 94
R
S
S/MIME 96
schema 95
separateMsgsFromBatch 54
server 95
server ports 58
SGML 96
shared resources
LLP Connection 12
signature 96
SMTP 96
SQL 96
SSL 96
starttime 58, 59
state 58, 59
STD 8
support, contacting xvii
symmetric key cryptography 96
synchronous transaction type 96
T
TCP/IP 97
technical support xvii
testing the process 50
TIBCO ActiveMatrix BusinessWorks process 48
TIBCO Designer, starting 45
TIBCO Foresight 7
TIBCO Foresight EDISIM 8
TIBCO Foresight Translator 8, 8
TIBCO Hawk 56, 60
TIBCO HL7/HIPAA solution 64
TIBCO HL7/HIPAA solutions 7
TIBCO_FORESIGHT_HOME xv
TIBCO_HOME xv
transform/transformation function 97
Translate HL7 activity 17
trimEmptyFields 54
type-aware 97
request/response 95
RV 95
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
104
| Index
U
unparsed 97
untyped 97
URI 97
URL 97
URN 97
V
Validate HL7 activity 21
VAN 98
VPN 98
X
X12N 67
XDR 98
XML 8, 98
XML schema 98
XSD 8, 98
XSDL 99
XSL 99
XSLT 99
TIBCO ActiveMatrix BusinessWorks Plug-in for HL7 User’s Guide
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement