Welch Allyn 2.5x - Manuals

Programmer’s Guide Introduction 3 Related documents Document Welch Allyn Connectivity Server (WACS) Welch Allyn Connectivity Server (WACS) CD-ROM (English): Welch Allyn Connectivity Server directions for useWelch Allyn Connectivity Server programmer’s guideAcuityLink Clinician Notifier directions fo...

2 5 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. This document contains specifications intended as a guide for software developers ...

Programmer’s Guide System overview 7 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 ...

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 Storage after Acuity disconnects from WACS or patient monitor Table 2. Acui...

Programmer’s Guide System overview 9 Data exported from the Acuity System to WACS The Acuity System exports the following vital-sign data: Table 4. Numeric vital-sign data exported from Acuity Systems to WACS Vital sign Units Default units Preferred HL7 tag (OBX-3) Heart rate BPM (1/min) BPM (1/min)...

3 11 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 H...

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. HL7 segment-level protocols This sect...

Programmer’s Guide HL7 standard protocols 13 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 f...

4 15 WACS outbound HL7 protocols The WACS Outbound HL7 Vital-sign Observations module uses Java TM processes to read patient data files from an Acuity System and for ward the messages to a CIS server. This chapter describes WACS protocols used in the Outbound HL7 Obser vations module. The WACS proto...

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: 1. WACS is configured to accept requests on a preconfigured TCP port (usually in the 5600-5700 range)...

Programmer’s Guide WACS outbound HL7 protocols 17 Labels and attributes of outbound segments The following table defines requirement labels for outbound segments. HL7 attributes of OBR (observation request) segments Table 7. Requirement labels for outbound segments Label Requirement Description R Re...

18 WACS outbound HL7 protocols Welch Allyn Connectivity Server OBR segment example OBR|1|||VITALS^Vital Signs^WAP|||20090127093400.000-0800 25 1 ID C 0123 00258 Result Status N 26 400 CM O 00259 Parent Result N 27 200 TQ O Y 00221 Quantity/Timing N 28 250 XCN O Y/5 00260 Result Copies To N 29 200 CM...

Programmer’s Guide WACS outbound HL7 protocols 19 HL7 attributes of PID (patient ID) segments PID segment examples Edgar A Van Goe with Primary ID 9582173 and no Amended ID:PID|1|9582173|9582173||Van Goe^Edgar^A|||||||||||||9582173 Edgar A Van Goe with Primary ID 9582173 and Amended ID 867509:PID|1|...

20 WACS outbound HL7 protocols Welch Allyn Connectivity Server HL7 attributes of OBX (observation/result) segments OBX segment example OBX|1|ST|Heart Rate^Heart Rate^WAP||80|^BPM||||||||20090127093400.000-0800 Table 10. HL7 attributes – OBX – observation/result segment SEQ LEN DT OPT RP/# TBL# ITEM#...

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 for wards an outbound patient ID segment that includes at least one of these ID fields: PID-2, PID-3, and PI...

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 i...

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 ...

24 WACS outbound HL7 protocols Welch Allyn Connectivity Server Reconfiguring WACS outbound observation settings Welch Allyn preconfigured your Welch Allyn Connectivity Ser ver (WACS) based on your facility’s specified requirements. Once your system is built and programmed, and once data is flowing f...

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 messa...

5 27 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...

28 WACS outbound HL7 messages Welch Allyn Connectivity Server Unsolicited observation messageORU^R01/ACK^R01 Segments ORU^R01 message segments Table 15. ORU^R01 unsolicited observation message Segment Description WACS segment requirement MSH Message Header R { [ PID Patient Identification R [PD1] Ad...

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 messag...

30 WACS outbound HL7 messages Welch Allyn Connectivity Server Query for results of observation messageQRY^R02/ORF^R04 This query-response model supports “Solicited Poll” and “User Initiated Query”. Segments QRY^R02 query segments Segment QRD: Query definition QRD-1: IgnoredQRD-2: Required (must be “...

Programmer’s Guide WACS outbound HL7 messages 31 ORF^R04 reply segments Table 18. ORF^R04 observational report (reply) Segment Description WACS segment requirement MSH Message Header R MSA Message Acknowledgment R QRD Query Definition R [QRF] Query Format C { [ PID Patient ID R PV1 Patient location ...

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^...

Programmer’s Guide WACS outbound HL7 messages 33 Query by parameterQBP^Q11/RSP^Z90 Segments QBP^Q11 query segments and their HL7 attributes Segment QPD: Query parameter definition QPD-1: IgnoredQPD-2: IgnoredQPD-3: Conditionally required (Patient IDs)QPD-4: Conditionally required (Patient Location)Q...

34 WACS outbound HL7 messages Welch Allyn Connectivity Server RSP^Z90 reply segments Table 21. RSP^Z90 - segment pattern response Segment Description Group control Comment MSH Message Header MSA Message Acknowledge [ERR] Error QAK Query Acknowledge QPD Query Parameter Definition RCP Response Control...

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|^~\&|Van Goe^Edgar^A||||20030624121816.101-0800||QBP^Q11|20030624121816101b|P|2.4...

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: RQRD-3: IQRD-8: List of Patient’s IDsQRD-9: RES Segment QRF: Query filter QR...

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 IDQPD-5: Required (Start/End Time and Interval)QPD-6: List of Data Requested QBP/RSP query and reply example QBP query: MSH|^~\&|Van Goe^Edgar^A...

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: RQRD-3: IQRD-9: Res Segment QRF: Query filter QRF-1: List of Pat...

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 LocationQPD-5: Start/End Time and IntervalQPD-6: List of Data Requested QBP^RSP query and reply example Get the heart rate and respiration rate ...

6 41 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: O...

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: 1. WACS initiates a connection to a facility’s CIS on a preconfigured TCP port (usually in the range of 5600-5700). 2. Once a session ...

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. Where a ...

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 numb...

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 autopopu...

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 ...

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. Data type descriptions Data type Definition Data format attributes and notes Alp...

52 Inbound ADT HL7 messages Welch Allyn Connectivity Server Examples of ADT messages WACS returns acknowledgements for accepted messages and error messages for non-accepted messages. Acceptable ADT/ACK message and acknowledgement The following is an example of an A03 message and acknowledgement in H...

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 mess...

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 ser ver IP address or the CIS server port number, please contact Welc...

7 55 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. ...

8 57 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: Specifications General WACS Phone (within the U.S.A.): 1-800-289-2501 Phone (worldwide): ...

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 even number of samples) Closest (most recent) Nu...

59 Index A ADT acceptable messages from 52data types accepted from 47erroneous messages 52HL7 messages 41how Acuity System uses information 43message formats accepted from 46WACS messaging rules 44 C CIS ADT messages 41configuring HL7 interface 5 D Data interface 6transfer and storage in Acuity Syst...