Welch Allyn Connectivity Server Programmer’s guide Software version 2.
ii Welch Allyn Connectivity Server © 2013 Welch Allyn. All rights are reserved. To support the intended use of the product described in this publication, the purchaser of the product is permitted to copy this publication, for internal distribution only, from the media provided by Welch Allyn. No other use, reproduction, or distribution of this publication, or any part of it, is permitted without written permission from Welch Allyn.
iii Contents 1 - Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Intended use. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Warning and note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Related documents. . . . . . . .
iv Contents Welch Allyn Connectivity Server 7 - XML interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 8 - Contacts and specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Contact information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 1 Introduction Intended use The Welch Allyn Connectivity Server (WACS) is an option to the Welch Allyn Acuity® Central Monitoring System. WACS consists of a server platform on which one or more of the following software options are installed: • The Web Server option makes Adobe® Portable Document Format (PDF) printout files available from the Acuity System to certain Web browsers.
2 Introduction Welch Allyn Connectivity Server Conventions The CE Mark and Notified Body Registration Number signify that the product meets all essential requirements of European Medical Device Directive 93/42/EEC. WARNING Indicates conditions or practices that could lead to illness, injury, or death. Warning and note WARNING HL7 configuration must be performed only by qualified personnel who are familiar with the HL7 Standard and with local implementation of the WACS HL7 Interface.
Programmer’s Guide Introduction Related documents Document Welch Allyn Connectivity Server (WACS) Welch Allyn Connectivity Server (WACS) CD-ROM (English): Welch Allyn Connectivity Server directions for use Welch Allyn Connectivity Server programmer’s guide AcuityLink Clinician Notifier directions for use Acuity and Mobile Acuity LT Central Monitoring System Directions for use Acuity and Mobile Acuity LT Central Monitoring Systems directions for use and in-service guide CD-ROM (multilanguage): Acuity and
4 Introduction Welch Allyn Connectivity Server
5 2 System overview Welcome! The Acuity Central Monitoring System is a real-time patient monitoring system that collects and displays vital-sign information for multiple patients over the Welch Allyn FlexNet™ network.
6 System overview Welch Allyn Connectivity Server Data interface provided by the Welch Allyn Connectivity Server (WACS) The WACS option to the Acuity Central Monitoring System is able to provide these data interface options: • HL7 (Health Level 7) Interface option • Third-Party Data Stream Interface option (XML format) Either WACS data interface option can include one or both of these distinct modules. • Inbound HL7 ADT Data module: Admit/discharge/transfer (ADT) data from your CIS or HIS to WACS.
Programmer’s Guide System overview Data transfer and storage within the Acuity System network The Acuity System stores patient data for variable amounts of time, depending upon Acuity System license configuration. Data export from patient monitors to the Acuity System Welch Allyn portable patient monitors store vital-sign data and send it to the Acuity System in the following ways: Table 1.
8 System overview Welch Allyn Connectivity Server Data storage at the Acuity System The Acuity System stores data for a period determined by the Full Disclosure license configuration. Storage during Acuity connection to WACS Table 2. Acuity System data storage configurations and Acuity System data export to WACS Acuity System data storage configuration WACS capability for data receipta Zero hours Continuous 24 hours Query for most recent 24 hours 96 hours Query for most recent 96 hours a.
Programmer’s Guide System overview Data exported from the Acuity System to WACS The Acuity System exports the following vital-sign data: Table 4.
10 System overview Welch Allyn Connectivity Server
11 3 HL7 standard protocols This chapter describes basic HL7 data structure as outlined in the Health Level Seven Messaging Standard. Information in this chapter is organized as follows: Health Level Seven Standard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 HL7 low-level protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12 HL7 segment-level protocols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12 HL7 standard protocols Welch Allyn Connectivity Server HL7 low-level protocol This section describes the low-level format of HL7 packet frames. Packet frames HL7 frames that are exchanged between the server and the client describe both sent and received data. Table 5.
Programmer’s Guide HL7 standard protocols Time/date in HL7 segments When importing vital-sign data into an electronic patient-charting application, use the timestamp associated with the OBR for the vital-signs record in the chart. Format Date and time in the HL7 segments are represented in this format: YYYYMMDDHHMMSS.mmm±TZTZ • Displayed time is local. • Hours are in the range 0-23.
14 HL7 standard protocols Welch Allyn Connectivity Server
15 4 WACS outbound HL7 protocols The WACS Outbound HL7 Vital-sign Observations module uses JavaTM processes to read patient data files from an Acuity System and forward the messages to a CIS server. This chapter describes WACS protocols used in the Outbound HL7 Observations module. The WACS protocols closely follow the data structure outlined in the Health Level Seven Version 2.4 Messaging Standard.
16 WACS outbound HL7 protocols Welch Allyn Connectivity Server Overview: Outbound HL7 Vital-sign Observations module Patient vital-sign observations are transferred to the CIS server in this manner: Acuity System network SQL database 10.250.100.201:5600 Initiate connection to WACS IP + port Patient data WACS HL7 outbound message Clinical information system (CIS) Outbound HL7 patient data messaging 1.
Programmer’s Guide WACS outbound HL7 protocols 17 Labels and attributes of outbound segments The following table defines requirement labels for outbound segments. Table 7.
18 WACS outbound HL7 protocols Welch Allyn Connectivity Server Table 8.
Programmer’s Guide WACS outbound HL7 protocols 19 HL7 attributes of PID (patient ID) segments Table 9.
20 WACS outbound HL7 protocols Welch Allyn Connectivity Server HL7 attributes of OBX (observation/result) segments Table 10.
Programmer’s Guide WACS outbound HL7 protocols 21 Outbound patient identification fields Patient ID information is confirmed at the Acuity Central Station in the Patient ID Setup window. WACS forwards an outbound patient ID segment that includes at least one of these ID fields: PID-2, PID-3, and PID-18. By default, all of the fields are populated. Export multiple ID fields from WACS, such as name and ID number. This enables detection of obvious identification errors.
22 WACS outbound HL7 protocols Welch Allyn Connectivity Server Outbound vital-sign tags and filters WACS generates the vital-sign tags and filters described in this section. By default, missing tags or tag errors cause the HL7 interface to reject the request or query. If part of a message or reply is valid, WACS ignores or rejects the erroneous portion and returns only the valid reply. This setting is configurable in the WACS HL7 Manager pages (see the Welch Allyn Connectivity Server directions for use).
Programmer’s Guide WACS outbound HL7 protocols 23 Vital-sign numerics filters One of the following vital-sign numerics filters must be configured for the WACS server: Table 14. WACS vital-sign filters Filter Function Median For an odd number of sample points, WACS sorts the data in descending order and returns the middle (median) data point. For example, for the values 56, 72, 96, 82 and 78, the returned value is 78.
24 WACS outbound HL7 protocols Welch Allyn Connectivity Server Reconfiguring WACS outbound observation settings Welch Allyn preconfigured your Welch Allyn Connectivity Server (WACS) based on your facility’s specified requirements. Once your system is built and programmed, and once data is flowing from the WACS server to the CIS, you can adjust and customize WACS default settings.
Programmer’s Guide WACS outbound HL7 protocols 25 Accessing the WACS program HL7 Manager pages For detailed instructions on accessing and using the WACS HL7 Manager pages, see the Welch Allyn Connectivity Server (WACS) directions for use. That document also provides message examples that show message formats before and after HL7 setting adjustments are made. Only WACS users who have been designated with a WACS biomedical engineer role can access the WACS HL7 pages.
26 WACS outbound HL7 protocols Welch Allyn Connectivity Server
27 5 WACS outbound HL7 messages This chapter provides this information: • Description of outbound WACS observation segments and acknowledgement segments and examples of observation messages and acknowledgement messages • Descriptions of outbound WACS query segments and reply segments and examples of query messages and reply messages Certain message formats can vary based on settings made in the WACS program HL7 Manager pages.
28 WACS outbound HL7 messages Welch Allyn Connectivity Server Unsolicited observation message ORU^R01/ACK^R01 Segments ORU^R01 message segments Table 15.
Programmer’s Guide WACS outbound HL7 messages 29 ACK^R01 acknowledgement segments Each ORU message must be acknowledged with a corresponding ACK^R01 acknowledgment message. If no acknowledgement is received, the ORU message is retransmitted at a configurable interval (default=30 seconds). The message is retransmitted until it has been sent a configurable number of times (default=5) or until an acknowledgement is received. Table 16.
30 WACS outbound HL7 messages Welch Allyn Connectivity Server Query for results of observation message QRY^R02/ORF^R04 This query-response model supports “Solicited Poll” and “User Initiated Query”. Segments QRY^R02 query segments Table 17.
Programmer’s Guide WACS outbound HL7 messages ORF^R04 reply segments Table 18.
32 WACS outbound HL7 messages Welch Allyn Connectivity Server QRY/ORF query and reply example Get the heart rate and respiration rate of Patient ID GA003560 from 2003/06/24 11:50:00 to 2003/06/24 11:50:02 interval of 1 sec. QRY^R02 query: MSH|^~\&|Van Goe^Edgar^A||||20030624121618.151-0800||QRY^R02|200306241216181517|P|2.4 QRD|20030624121618.
Programmer’s Guide WACS outbound HL7 messages Query by parameter QBP^Q11/RSP^Z90 Segments QBP^Q11 query segments and their HL7 attributes Table 19. QBP^Q11—query by parameter message Segment Description WACS segment requirement MSH Message Header R Query Parameter Definition Segment R [...
34 WACS outbound HL7 messages Welch Allyn Connectivity Server RSP^Z90 reply segments Table 21.
Programmer’s Guide WACS outbound HL7 messages 35 QBP/RSP query and reply example Get Heart Rate and RR/BR of Patient ID GA003560 from 2003/06/24 11:50:00 to 2003/06/ 24 11:50:02 interval of 1 sec. QBP^Q11 query: MSH|^~\&|VanGoe^Edgar^A||||20030624121816.101-0800||QBP^Q11|20030624121816101b|P|2.4 QPD|||GA003560||^&1^^20030624115000-0800^20030624115002-0800|Heart Rate~RR/BR RCP RSP^Z90 reply: MSH|^~\&|WAP^WAP||||20030624121817.248-0800||RSP^Z90|20030624121817250c|P|2.
36 WACS outbound HL7 messages Welch Allyn Connectivity Server Query by ID This section covers these two formats for Query by ID: • QRY/ORF • QBP/RSP QRY/ORF format QRY^R02 query segments Segment QRD: Query definition QRD-2: R QRD-3: I QRD-8: List of Patient’s IDs QRD-9: RES Segment QRF: Query filter QRF-4: List of Data Requested QRF-9: Start/End Time and Interval QRY/ORF query and reply example Get the heart rate and respiration rate of Patient ID GA003560 from 2003/06/24 11:50:00 to 2003/06/24 11:5
Programmer’s Guide WACS outbound HL7 messages 37 QBP/RSP format QBP^Q11 query segments Segment QPD: Query parameter definition QPD-3: List of Patient’s ID QPD-5: Required (Start/End Time and Interval) QPD-6: List of Data Requested QBP/RSP query and reply example QBP query: MSH|^~\&|VanGoe^Edgar^A||||20030624121816.101-0800||QBP^Q11|20030624121816101b|P|2.4 QPD|||GA003560||^&1^^20030624115000-0800^20030624115002-0800|HR~RR RCP RSP reply: MSH|^~\&|WAP^WAP||||20030624121817.
38 WACS outbound HL7 messages Welch Allyn Connectivity Server Query by location This section covers these two formats for Query by location: • QRY/ORF • QBP/RSP QRY/QRF format QRY^R02 query segments Segment QRD: Query definition QRD-2: R QRD-3: I QRD-9: Res Segment QRF: Query filter QRF-1: List of Patient’s Unit - point of care QRF-4: List of Data Requested QRF-5: List of Patient’s Room - Room + Bed QRF-9: Required (Start/End Time and Interval) QRY/ORF query and reply example Get the heart rate and
Programmer’s Guide WACS outbound HL7 messages 39 QBP/RSP format QBP^Q11 segment definition Segment QPD: Query parameter definition QPD-4: List of Patient’s Location QPD-5: Start/End Time and Interval QPD-6: List of Data Requested QBP^RSP query and reply example Get the heart rate and respiration rate of Patient in Unit MEDICAL Room 1310A from 20030624115000 to 20030624115002 interval of 1 sec. QBP query: MSH|^~\&|VanGoe^Edgar^A||||20030624121816.101-0800||QBP^Q11|20030624121816101b|P|2.
40 WACS outbound HL7 messages Welch Allyn Connectivity Server
41 6 Inbound ADT HL7 messages If your facility includes the WACS Inbound HLT ADT Data module, patient information fields in Acuity System patient identification windows can autopopulate with admit/ discharge/transfer (ADT) data from your CIS. The information in this chapter is organized as follows: Overview: Inbound HL7 ADT Data module . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42 How an Acuity System uses ADT information . . . . . . . . . . . . . . . . . . . . . . . . . .
42 Inbound ADT HL7 messages Welch Allyn Connectivity Server Overview: Inbound HL7 ADT Data module ADT information is transferred to the WACS server in this sequence: Patient identification process 1. At Acuity System, open Patient ID Setup window. 2. Insert patient ID number. 3. Press Enter on keyboard. Acuity queries Patient Name server and then the WACS SQL database for demographics including patient name and patient location. 4. Respond to patient confirmation prompt.
Programmer’s Guide Inbound ADT HL7 messages 43 How an Acuity System uses ADT information When a facility’s CIS sends a patient’s ADT information to WACS, the Acuity System uses the ADT information to autopopulate identification fields in the patient’s Acuity System patient ID setup windows.
44 Inbound ADT HL7 messages Welch Allyn Connectivity Server Sequence of events when ID number is entered This is the sequence of events that occurs within Acuity Systems that include the WACS option with the Inbound HL7 ADT module. 1. In a patient ID setup window, the user enters the patient ID number or an amended patient ID number and presses the Return or Enter key. 2.
Programmer’s Guide Inbound ADT HL7 messages 45 Rules regarding Acuity System patient IDs These rules apply within the Acuity System: • A patient ID number, an amended ID number or both may be entered. • Letter case is ignored when ID numbers are compared to the PSND and WACS databases. • An autopopulate search can match a currently monitored Acuity System patient or a patient discharged from the Acuity System for a period of 24-96 hours (depending upon the system’s Full Disclosure configuration).
46 Inbound ADT HL7 messages Welch Allyn Connectivity Server ADT messages accepted and stored by WACS WACS accepts the message types and formats described in this section. Accepted message types WACS receives and stores these types of messages. Welch Allyn suggests that you consider configuring your CIS/HIS ADT server to block messages other than these.
Programmer’s Guide Inbound ADT HL7 messages 47 Data types The HL7 Standard allows for different data formats for each of the following data types. This section documents general attributes of each data format. Table 23.
48 Inbound ADT HL7 messages Welch Allyn Connectivity Server Table 23.
Programmer’s Guide Inbound ADT HL7 messages Table 23. Data type descriptions Data type Definition Data format attributes and notes AD Address ^ < other designation (ST)> ^ ^ ^ ^ ^ ^ PN Person name ^ ^ ^ ^ ^
50 Inbound ADT HL7 messages Welch Allyn Connectivity Server Table 23.
Programmer’s Guide Inbound ADT HL7 messages Table 23.
52 Inbound ADT HL7 messages Welch Allyn Connectivity Server Examples of ADT messages WACS returns acknowledgements for accepted messages and error messages for nonaccepted messages. Acceptable ADT/ACK message and acknowledgement The following is an example of an A03 message and acknowledgement in HL7 version 2.3 formats. ADT^A03 message: HL7Log Responder got message: MSH|^~\&|REG|RMH||RMH|20090114193305.00000600||ADT^A03|2271605|P|2.3EVN|03|20090114 193305.
Programmer’s Guide Inbound ADT HL7 messages 53 Unacceptable ADT messages and WACS error messages WACS returns error messages to the CIS/HIS ADT server in response to these messages: • Message types other than A01, A03, A04, A05, A08, A011 or A13, and your system has not been programmed to block messages other than these. • HL7 messages containing noncompliant format. In these cases, WACS rejects the entire content of the message.
54 Inbound ADT HL7 messages Welch Allyn Connectivity Server Reconfiguration of ADT services If your WACS system receives inbound ADT messages from your CIS, and you need to reconfigure certain ADT service settings, such as the CIS server IP address or the CIS server port number, please contact Welch Allyn Technical Services (see “Contact information” on page 57).
55 7 XML interface The optional Third-Party Data Stream Interface option provides a means of moving patient identification and patient numeric data between the Acuity Central Station and a facility’s information system. To receive XML messages from WACS, a CIS/HIS opens a TCP/IP socket and listens. When the Welch Allyn Connectivity Server detects an event, it connects to the socket and sends a message. The interface provides the following parameters: Table 24.
56 XML interface For example: Set MRN-0001 Lethal Asystole EVENT-001 June 4, 2006 14:25:03 Jon L.
57 8 Contacts and specifications Contact information If you encounter a problem that cannot be corrected by ordinary operating procedures described in this manual, please contact Welch Allyn Technical Services: Phone (within the U.S.A.): 1-800-289-2501 Phone (worldwide): +1 503-530-7500, ask for Technical Service Fax: +1 503-526-4970 email: solutions@welchallyn.com Internet: http://www.welchallyn.com/support/default.htm Specifications General WACS Table 25. WACS 2.
58 Contacts and specifications Welch Allyn Connectivity Server WACS HL7 Interface option Outbound messaging Table 27. Configuration variables under HL7 tab HL7 Manager page Default setting Alternate settings Numeric data filter Median (can be mean for Closest (most recent) even number of samples) Numeric data filter for NIBP Closest (most recent) Median (can be mean for even number of samples) HL7 versions supported 2.4 2.31, 2.
59 Index A ADT acceptable messages from 52 data types accepted from 47 erroneous messages 52 HL7 messages 41 how Acuity System uses information 43 message formats accepted from 46 WACS messaging rules 44 entry sequence 44 where entered in system 43 Inbound HL7 ADT Data module 41 Interface, data 6 M CIS ADT messages 41 configuring HL7 interface 5 Message ADT error, sent by WACS 52 ORU/ACK example 29 QBP^RSP example 39 QBP/RSP example 35, 37 QRY/ORF example 32, 36, 38 time/date example 13 types and forma
60 Index W WACS Help 57 troubleshooting 57 warning 2 Welch Allyn, Technical Service 57 X XML interface 55 Welch Allyn Connectivity Server
