TIBCO Foresight Products Working with Health Level Seven (HL7) Transactions August 2017 Two-Second Advantage
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, Two-Second Advantage, TIBCO Foresight EDISIM, TIBCO Foresight HIPAA Validator Desktop, TIBCO Foresight Instream, and TIBCO Foresight Translator are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation 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. The United States Postal Service holds the copyright in the USPS City State Zip Codes. (c) United States Postal Service 2017. 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 2010-2017 TIBCO Software Inc. ALL RIGHTS RESERVED. General Contact Information TIBCO Software Inc. 3303 Hillview Avenue Palo Alto, CA 94304 USA Tel: +1 650 846 1000 Fax: +1 650 846 1005 Technical Support E-mail: support@tibco.com Web: https://support.tibco.com (Note: Entry to this site requires a username and password. If you do not have one, you can request one. You must have a valid maintenance or support contract to use this site.)
Contents Document Purpose... 3 Audience... 3 HL7 Standards... 3 HL7 in TIBCO Foresight Products... 3 Sample Data and Instream Scripts... 4 Big Picture... 5 HL7 Specific Information... 6 Working with Health Level Seven (HL7) Transactions Page 1
Working with Health Level Seven (HL7) Transactions Page 2
Document Purpose This document describes how to use HL7 transactions, also known as messages, in TIBCO Foresight products. Audience This document is for users of TIBCO Foresight HIPAA products who want to use HL7 standards and already know at least one of these TIBCO Foresight products: TIBCO Foresight HIPAA Validator Desktop TIBCO Foresight EDISIM TIBCO Foresight Instream (Windows only) TIBCO Foresight Translator. HL7 Standards Health Level Seven International (HL7) has data interchange standards for health information transactions. HL7 Version 2 Messaging Standards versions as listed below are supported by TIBCO Foresight validation products. HL7 in TIBCO Foresight Products The HL7 guidelines 2.3 2.3.1 2.4 2.5.1 2.6 are distributed with these TIBCO Foresight products: HIPAA Validator Desktop version 8.0.0 or later Instream version 8.0.0 or later validation only. You can use them with these modules of EDISIM 6.10.1 or later (copy the appropriate standard, for example HL7_26.std, from Instream s or HIPAA Validator Desktop s Database folder to EDISIM s User Files\Public Guidelines directory): Standards Editor including the ability to create rules Standards Reference HL7 does not work with EDISIM s DocBuilder, TDG, Comparator, Analyzer, or Library modules. HL7 standards and guidelines can also be used with Foresight Translator version 3.0.0 or later. Working with Health Level Seven (HL7) Transactions Page 3
Sample Data and Instream Scripts Instream HIPAA Validator Desktop Filename Directory Notes HL7_ORU_R01_Clean.txt DemoData HL7 ORU R01 file. Used by Instream s V_ORUR01_HL7_Clean script. V_ORUR01_HL7_Clean Scripts Validates HL7_ORU_R01_Clean.txt, an HL7 file. Working with Health Level Seven (HL7) Transactions Page 4
Big Picture Messages HL7 provides the following messages (referred to in the X12 community as transaction types): Patient Administration Order Entry Queries Financial Management Observation Reporting Master Files Medical Records/Information Management Scheduling (View Brief) Patient Referral Patient Care Clinical Laboratory Automation Application Management Personnel Management Claims and Reimbursement Materials Management Parts of a Message HL-7 messages: Begin with a Start Message (MSH) segment, which contains information such as from, to, date, time, etc. Contain no End Message segment. The end of a message is signaled when another Start Message (or Start Batch or Start File) segment is seen, or upon end-of-file. Start of message One or more messages may be grouped into a Batch, which is explained below. Start of next message Parts of a Batch One or more messages may be grouped into a batch. A batch: begins with a Start Batch Segment (BHS) is followed by one or more messages ends with an End Batch Segment (BTS). One or more batches may be grouped into a file. A file: begins with a Start File Segment (FHS) ends with an End File Segment (FTS). Working with Health Level Seven (HL7) Transactions Page 5
HL7 Specific Information Users who are familiar with EDISIM, Instream, HIPAA Validator Desktop, and Foresight Translator from working with X12 EDI will find the following differences when working with the HL7 standard. Terminology General terminology differences between X12 data and HL7 data are as follows: X12 Interchange Functional Group Transaction Set Loop Segment Sub-Composite Members Element Code Set HL7 File Batch Message Segment Group Segment Field Sub-Components Fields Table Requirements Coding The following Requirements characters are used in the Requirements field in HL7 messages: Character X12 Meaning HL7 Meaning M Mandatory Required O Optional Optional C Conditional Conditional X (none) Not Used B (none) Backward Compatibility W (none) Withdrawn Working with Health Level Seven (HL7) Transactions Page 6
Sub-Composites Composites in HL7 transactions may contain sub-composites. Composite Sub-composite Codes There will be a new Responsible Agency Code of H in the fourth field if the.ini record to identify HL7 standards. Enveloping Enveloping differences between X12 data and HL7 data are as follows: The HL7 segment Defined as Is like this segment in X12 FSH BSH MSH File Header Segment (includes delimiter overrides) Batch Header Segment (includes delimiter overrides) Message Header Segment (includes delimiter overrides) ISA (optional) GS (optional) ST (none) Message Trailer Segment SE BST Batch Trailer Segment GE (optional, but required if BSH is used) FST File Trailer Segment IEA (optional, but required if FSH is used) HL7 Identifier in Validation Detail File GEN record 17021 within the validation detail file indicates the data is HL7. The 1 in front of the GEN record number is the line number in the data file. Working with Health Level Seven (HL7) Transactions Page 7