Home

92338-vG XGate IOM

1. Version Date Description E 4 April 2008 New parameters added to 5 9 1 General parameters on page 18 and to 5 10 3 TCP Server Parameters on page 19 18 June 2009 e Updates in 5 6 I O Setup on page 13 Added following chapters 6 Serial Interface on page 26 5 10 6 HTTP Client Parameters on page 21 e B 5 Advanced Troubleshooting on page 36 Appendix F Protocol Limitations on page 47 Added new parameters to chapters 5 10 3 TCP Server Parameters on page 19 5 10 4 UDP Parameters on page 20 and 5 10 5 Serial Communication Parameters RS232 Ascii on page 20 20 December 2010 Added Unite CM throughout Added VoWiFi in figure 1 on page 1 Added Unite CM in chapter 1 1 Requirements on page 2 22 December 2010 Ver G 33 Installation and Operation Manual XGate Appendix A XGate and IT Security The following ports on the XGate are open Port 20 21 22 25 53 80 113 123 3217 10101 10132 10133 10134 10135 The IP ports that opens for the Ascii Input Module are chosen and set up in the System Application or unit File Transfer Protocol FTP File Transfer Protocol FTP Secure Shell SSH Simple Mail Transfer Protocol SMTP Domain Name Server DNS Web traffic Authentication Network Time Protocol NTP Unite traffic Remote connection TCP and RS232 conversion Applet communication Event Assignment Applet communication Duty Assignment
2. Each language can be exported as an XML file To create a new language or update an existing click a language link above to download the file If a new language should be created change the language indication in the language tag Translate Update the text within translation and helptext tags and save the file Import the XML file Import language file Enable translation mode C Apply In Translation mode all text will be exchanged with the identification in the language file This can be used to identify where a text is displayed in the GUI Figure 9 The Language page The file that needs to be translated is an XML file generated from the XGate To save the file for translation or editing purposes click the language link in the window and save the file In the language file there are numerous tags but only two tags and one attribute that needs to be translated 22 December 2010 Ver G 10 Installation and Operation Manual XGate TD 92338GB e language id English the id attribute is the text that appears in the drop down list translation name of menus buttons tabs etc e lt helptext gt on line help text Below is an example of a language file just showing two buttons with helptext for simplicity lt xml version 1 0 encoding I50 8859 1 gt translations language id English type complete gt app id XGATE text id BUTTON APPLY LANGUAGE TO SESSION
3. Through this document the following HL7 v2 example message with the MSH EVN PID PV1 IN1 and IN2 segments encapsulated in a MLLP session will be used e MSH Message Header e EVN Event type e PID Patient Identification e PV Patient visit e IN1 Insurance e I N2 Insurance additional information VT MSH N amp HIS ADT MODULE ASCOM XGATE 20060109024819 ADT AO8 120060109024311170 P 2 2 AL SU EVN A08 200601090243 CR PID 2490298 Langstrump amp amp Langstrump Mr amp Nilsson Pippi Viktual ia Rullgardina Krusmynta Efraemsdotter Ms Langkous amp amp Langkous amp Dhr amp Nilsson Pippi Vic tualia Rolgordijna Kruizemunta Efralmsdochter Juffrouw 19630122 M Villa Villekulla Br kmakargatan 7 Vimmerby SE 9999 0046123456789 PV1 O First aid Room 5 Bed P3 NM aL ELEM LLL ELI CR IN1 1 7022 C2Z Zorgverzekering Postbus 99999 Tilburg 9999 AB JI076 5243xxx lH LL IPITI LLEEEEEEELILITLI900080820 CR7 IN2 ILLE LEE IITE LT T I 3 H CR lt FS gt lt CR gt IN lt CR gt XGate Event Handler Configuration This section describes how an HL7 v2 message is transmitted from the Hospital Information System HIS to the XGate system HIS ASCII The Hospital Information System HIS connects to XGate ASCII through a TCP IP socket The IP address to connect to is the IP address of the XGate box An HL7 application message is s
4. Applet communication Access Rights Applet communication Action Handler TD 92338GB Transport protocol TCP TCP TCP TCP UDP TCP TCP UDP UDP TCP TCP TCP TCP TCP Setup gt Input Interfaces gt Ascii Any port number can be chosen as long as it is not used by another application or unit 22 December 2010 Ver G 34 Installation and Operation Manual XGate TD 92338GB Appendix B Troubleshooting B 1 Applet problems If it is not possible to open Java applet windows ensure that JVM 4 2 1 or later is installed on your computer The Java program is found at www Java com B 2 How to remove Java status bar Event Element alarm type v Comparison Integer Comparison Type Equals o fy Value x o f ancal Java Applet Window Figure 29 Example when the buttons are covered by the Java applet window In the Java applet Windows buttons can be covered by a status bar This is dependent of the client side browser setup To remove the status bar statements have to be added in the java policy file which is found in the Java directory that was created when the Java program was installed on your computer 1 Find the Java directory for example C Program Files Java jre1 5 0_06 lib security 2 Open the latest Java version that is used In the folder security you will find the java policy file Open the file with for example Notepad e Add following text last in the file gra
5. 9600 bits s Mode Select mode Default 8 Data bits Even parity Flow control Used for handshaking control Default None Default Call ID Number to call if not specified in the external equipment Default 000 Message to display if not specified in the external equipment Default BLANK Priority if not specified in the external equipment Default 7 Normal Beep code if not specified in the external equipment Default 2 beeps How long to wait before transmission to external equipment Default 30 milliseconds If status characters ACK NAK shall be sent on protocol level to external equipment Default Yes Start character for the message Default 3C Hex End character for the message Default 3E Hex Record separator character for the message Default 2F Hex Character for positive acknowledge of the message on protocol level Default A 41 Hex Character for negative acknowledge of the message on protocol level Default N 4E Hex Makes it possible to convert display message characters 29 Installation and Operation Manual XGate TD 92338GB 6 2 3 TAP Protocol Default display message Default message priority Default beep code Default urgency Transmission delay x10 ms Advanced Enable checksum validation Advanced Delay time before logontimeout occurs Advanced Delay time before blocktimeout occurs Advanced Numbers of allowed times
6. The Line protocol does not propagate Infopage but it must be valid if submitted 48 Installation and Operation Manual XGate F 3 TAP Protocol F 3 1 Functionality TD 92338GB e lt ESC gt PG1 lt CR gt Default logon string First field of the data block is assumed to contain the paging address The address is treated as a decimal address valid digits is 0 9 Any leading spaces will be ignored Field s after the first field is assumed to contain the paging text If the datablock is containing more than 2 fields fields 3 4 5 will be concatenated to the paging text to be sent the separating CR s will be treated as a part of the paging text The paging text is set as Body in the Unite paging The Subject will be empty Thereis no restriction on how many blocks that can be sent during one logon session F 3 2 Limitations The following limitations apply Using US or ETB as blockterminators Sending SUB as controlcharacter Maximum session timeout Timeout between blocks Messages longer than 128 characters Message sequences Software flow control of the serialport Characters in the paging text below 0x20 except for carriage return 22 December 2010 Ver G Not supported Not supported Not implemented however an inactivity timeout will occur after 8 seconds when waiting for logonstring and 4 seconds when waiting for blockdata after a lt STX gt has been rece
7. all text will be exchanged with the identification in the language file This can be used to identify where a text is displayed in the GUI Figure 11 A language file to be deleted 22 December 2010 Ver G 11 Installation and Operation Manual XGate TD 92338GB 5 5 3 GUI Updates When a new version of the XGate is released there might be changes in the GUI that need to be translated 1 Import your old translated file to the new XGate software version New text and buttons in the GUI will be shown in English since this is the default language It will now include the additions 2 Click the language file link and save it 3 Open the file and all tags that are not translated are marked with the comment lt The text identifier below couldn t be translated gt 4 Translate the new text and import the translated file again 5 5 4 Translation Mode All texts buttons menus etc are identified with labels for example MENU XGate With the translation mode function it is possible to view the label for each button menu etc This can be helpful when translating the language file Check the Enable translation mode box in the Translate page Click Apply and all the labels on the pages are shown see example below TEXT TRANSLATION TITLE TEXT TRANSLATION LANGUAGE TEXT english TEXT TRANSLATION EXPORT TEXT Import language file LBrewse TEXT TRANSLATION CHECKBOX CAPTION BUTTON_SAVE OPTION_DESIGN_
8. Information Standard debug is set by default but this can be extended and show more details Send Test Message IP Statistics Disk Status Module Fault List 22 December 2010 Ver G 36 Installation and Operation Manual XGate Appendix C ASCII table TD 92338GB ASCII stands for American Standard Code for Information Interchange The ASCII table is like a dictionary for translating numbers into characters The table below shows the translation of decimal numbers into characters Dec Char Dec Char Dec Char Dec Char 0 NUL null 32 Space 64 96 j 1 SOH start of heading 33 65 A 97 a 2 STX start of text 34 u 66 B 98 b 3 ETX end of text 35 67 ic 99 C 4 EOT end of transmission 36 68 D 100 d 5 ENQ enquire 37 96 69 E 101 e 6 ACK acknowledge 38 amp 70 F 102 f 7 BEL bell 39 j 71 G 103 g 8 BS backspace 40 72 H 104 h 9 TAB horizontal tab 41 73 105 i 10 LF NL line feed new line 42 74 J 106 j 11 VT vertical tab 43 75 K 107 k 12 FF NP form feed new page 44 76 L 108 13 CR carriage return 45 77 M 109 m 14 SO shift out 46 78 N 110 n 15 SI shift in 47 79 O 111 o 16 DLE data link escape 48 0 80 P 112 p 17 DC1 device control 1 49 1 81 Q 113 q 18 DC2 device control 2 50 2 82 R 114 r 19 DC3 device control 3 51 3 83 S 115 S 20 DC4 device control 4 52 4 84 T 116 t 21 NAK negative acknowledge 53 5 85 U 117 u 22 SYN synchronous idle 54 6 86 V 118 V 23
9. Translation Table Appendix E XML Message seseseesesosesossososossososossesososossososossesosossesosossesososossososossososossss Esl Example XML miessage c be RE RR RE E REESE 45 E 1 1 Define XML Segment Data oo eseecsssessessecseeseessecscssesssecsccseesecucsneesecceeeneeaseceeeneenees 45 E12 consideratio ue NU Ned 46 Appendix F Protocol Limitations eeeeeee eene ene eene eene ene etos tn seen sensa enne etn tnotna 47 FA ESPA 4424 Laeti p dene ERREUR EE a eed FLI Functionality rotor dienes t e tpe te Pe e ua iei EX 2 UGA GION Steer ete ER EROR RR I RUN DERNIERE F 2 Ascom Line Protocol E 23k VEuicti nallty u tte ti i e a ee t P e 22 December 2010 Ver G Installation and Operation Manual XGate TD 92338GB F 2 2 EltrilEatlODS aeter CU ERE EXER DNE iret Fos WIA RP PIOLOCOM S erosut prre EE VE DENEN Cn Oe MAE A AD IE NU UU UM F 3 1 Functionality E 3 25 bililitati OD So ec er er ER eo EESE eit iei ener 22 December 2010 Ver G Installation and Operation Manual XGate TD 92338GB 1 Introduction The XGate is a Unite module based on the ELISE hardware It receives input from other Unite modules or from external equipment The main functionality of the XGate is to handle different types of protocol It will convert events to actions in our systems and also to provide an assignment interface to offer the ability for users to dynamically assign recipients to events The XGate will be used to
10. i RE EUER ARRA ed 12 5 5 4 Translation Mode 2 ttr tte tette eed i e Ere cad 12 5 6 OP SetU Dunt e e e E Neat 13 5 6 1 Outp ts and Inputs re eta teet atten 13 5 6 2 Denne QUU ee deett E eR aee RR UR e HP seen 14 5 6 3 Defirie In pUtS de e RE eo t NE entes 15 Bid Data MONITOR 2 Nee tte RD ui note IRR 16 SR ELISE SetU 17 5 9 Action Handler Parameter Settings sese entente ntes 18 5 9 1 General ParaMeter Sis s c etin E e GU cte bd 18 5 9 2 Priority Indication Mapping oe terere ite needs 18 SLO JASCILIDEGEFaCO iE ett ie ere e EU eei 19 5 10 1 Syntax for Ascii code Translation eese tenentes 19 5 102 RecelVing appliGatior onte RE eee aana 19 5 10 3 TCP Server Parameters ree I ere Re ERE INEST Gs 19 22 December 2010 Ver G Installation and Operation Manual XGate 9233868 S102 UDP Parameters x t ER ERR ER E A HE eio 20 5 10 5 Serial Communication Parameters RS232 Ascii ssssseeee 20 5 410 6 HTP Client Parameters scettr e eins 21 SIL SMTP Output mtr tae epe RR ERN e i RD UR RR e aan 21 5 12 Unite User Server Parameter Settings serene 22 5 13 Event Handler e HERREN ERE ERE erp Reg 22 5 13 Overview of Programming tt edi e dnd 22 5 13 2 VIBWIEOES 2 E tcen ue elated ene eee IE I de 22 5 13 3 Database Administration eite e a PORE Ets 23 5 13 4 Configuration OT EVENTS secet dene eee eee ete dod iune 23 6 Serial Interfa
11. ktranslation gt apply lt translation gt lt helptext gt Click this button to apply the selected language to this session lt helptext gt lt text gt text id MENU XGATE BASIC SETUP lt translation gt Basic Setup lt translation gt lt helptext gt Links to administration tools for basic XGate settings lt helptext gt lt text gt lt app gt lt language gt lt translations gt Figure 10 An example of a translation file When the file is translated it must be imported to the database Click Browse to locate the translated file and click the Import button The name of the translated language the language id attribute will appear as a link in the Existing Language list and can be down loaded for editing purposes The XGate GUI only supports the Latin 1 character set 5 5 2 Delete a Language A language file can be deleted from the XGate by clicking the Delete symbol It is not possible to remove the default language Translation Existing languages Svenska 2 English Each language can be exported as an XML file To create a new language or update an existing click a language link above to download the file If new language should be created change the language indication in the language tag Translate Update the text within translation and heiptext tags and save the file Import the XML file Import language file Enable translation mode O Apply in Translation mode
12. later became the Personal Communications Industry Association PCIA TAP was also known as IXO and PET TAP is widely used in the U S and throughout Europe For limitations in the three protocols refer to Appendix F 6 1 Cables for the ESPA the Ascom Line and the TAP protocol 3 RS232 3 External RJ45 D SUB equipment Figure 26 Connection to external equipment A cable with RJ45 and D SUB connectors is required to be able to receive pagings from external equipment Default the cable should be connected to the RS232 3 port on the XGate RJ45 D SUB not used 1 1 DCD TX 2 2 RX RX 3 3 TX CTRLIN 4 4 DTR CTRL OUT 5 5 GND not used 6 6 DSR GND 7 7 RTS not used 8 8 CTS 9 not used Figure 27 Cable wiring for the Ascom Line protocol and the ESPA protocol 22 December 2010 Ver G 26 Installation and Operation Manual XGate 6 2 Serial Protocol Settings 1 3 6 2 1 1 TD 92338GB In the XGate Basic Administration page select Serial protocols in the left menu The Serial Interface configuration page opens Serial protocols Receiving application Edit ESPA EE Line Protocol EE NOT USED EE NOT USED NOT USED NOT USED NOT USED NOT USED NOT USED NOT USED Figure 28 Serial protocol settings Click Edit to change Receiving application setting Destination Address default Unite address to where received data should be sent Click on a link for the protocol y
13. parts by clicking on each of the boxes in the figure that shows the event flow Configuration Example In the External Actions Extract and send data there is an example of a complete configuration that can be used as a template There are four event elements of alarm type and location that have been created More steps where the data is sent is found in the example in the Extract an send data External Action Extract and send data Element Assignments ile Define Expression lt in Message Body separator 1 1 gt Destination local Alarm type 2 Define Expression in Message Body separator 2 2 gt Destination local Location 3 Translation Location table Selected local Location Destination local Location description Default value Unknown location local Location complete 4 Translation Alarm type table Selected local Alarm type Destination local Alarm type description Default value Figure 25 An example configuration in Extract and send data showing the four first steps in an external action 1 The expression lt in Message Body separator 1 1 gt where the Body before the is the part of the incoming message The destination local Alarm Type which means that it will look for Alarm Type in the message 2 The expression lt in Message Body separator 2 2 gt where the Body after the is the part of the incoming message The destination lo
14. syntax A decimal number is written between a backslash and a semicolon which will then be translated into its character For example syntax M EOT V6 ACK X28 FS etc An ASCII table for numbers and characters is found in the Appendix C ASCII table on page 37 1 Click ASCII in the left menu to configure the connection to external systems Ascii Interface Receiving application Edit TCP iPhone NOT USED NOT USED NOT USED NOT USED NOT USED Serial ports NOT USED NOT USED NOT USED HTTP client NOT USED Figure 19 The Ascii Input Module for parameter settings Configuration is only necessary in those input channels connections that are going to be used 2 Click Activate in each of the parameter setting to save changes These are the parameters that can be configured 5 10 2 Receiving application Click Edit to change following setting Destination Address default Unite address where received data should be sent to 5 10 3 TCP Server Parameters Click one of the three available These following parameters that can be set up Name 22 December 2010 Ver G 19 Installation and Operation Manual XGate TD 92338GB TCP port Input Start Stop character string Is entered with a syntax code see 5 10 1 Syntax for Ascii code Translation on page 19 Output Start Stop character string Is entered with a syntax code see 5 10 1 Syntax for Ascii code Translation on page 19 End of Session a
15. to logon Advanced Numbers of allowed checksumfailures Advanced 22 December 2010 Ver G 1 The following settings can be selected changed Settings Description Enabled Yes No selection Default No Name Description of the channel Serial port Port selection 1 2 3 Default None All three ports can be configured here Note that only one at the time can be used Bit rate Select bit rate Default 9600 bits s Mode Select mode Default 8 Data bits Even parity Flow control Used for handshaking control Default None Default Call ID Number to call if not specified in the external equipment Default 000 Message to display if not specified in the external equipment Default BLANK Priority if not specified in the external equipment Default 7 Normal Beep code if not specified in the external equipment Default 2 beeps If set to High Stand by mode in receiver is broken through Default Normal How long to wait before transmission to receiver Default 30 milliseconds Set to No if for example external equipment uses an algorithm that differ from the 7 bit value used in TAP Default Yes How long to wait before disconnecting the external equipment Valid values 0 127 where 0 means Not enabled Default 8 seconds How long this module shall wait before hanging up Valid values 0 127 where 0 means Not enabled Default 4 seconds How many logon attempt from external equipment shall b
16. 10 Ver G Installation and Operation Manual XGate 22 December 2010 Ver G 5 2 5 3 TD 92338GB Change Language The default language in the XGate GUI is English The text that appear in the GUI are stored in a database Several languages can be stored in the database but it is not possible to edit or remove the default language Additional languages can be imported as described in 5 5 1 Translation of the GUI on page 10 Language The default language for this module is currently English English w Apply Setlanguage Figure 6 The default language is English 1 Select language from the drop down list If your language is not in the drop down list import the language see 5 5 1 Translation of the GUI on page 10 2 Click Apply or Set language 3 Restart applet s if opened for the new language to take effect Backup Restore In the XGate Home page it is possible to backup and restore the database It can for example be used when information is to be copied from one XGate to another XGate or to restore the database in the XGate The format of the backup restore file is xxx tar gz There is also a backup restore in the System Setup web page ooxooxxx xxx admin That is to be used when an XGate module should be replaced with another XGate module in case of hardware failure and to update the database The difference is that it is also possible to backup restore configuration in the ELISE though this will
17. 12490298 L ngst rump amp amp LAngstrump amp Mr amp Nilsson Pippi Viktualia Rullgardina Krusuunta Efraemsdotter Ms Langkous Langkous Dhr Nilsson Pippi Victualia Rolqordijna Kruizemunta Efralwmsdochter Juffrouw 19630122 M I Villa Villekullla Br kmakargatan 7 Vismerhby SE 9999 0046123456789 HL IN CR PV1 Ol First aid Room Body lt gt lt gt lt USP gt Figure 32 Paging message to the Event Handler 5 Bed 2 j cn ss nnnnnn npEEEELE EE EE ETOP EET EET EEE EE ELI E HELL TE I ESCRO 1N1 1 7022 CZ Zorgverzekering Postbus 99999 Tilburg 9999 aB 076 5243xxx ILIAC IIPAN ATIINA EE TEIL I111900080820 CRPIN2 ELE LE EE ELE LL BELL BE LL TE LL EET LE ISI R lt cR gt Event Handler Action Handler Based on a translation table that is defined by the customer the Event Handler will extract the needed information from the paging body text and send that as event elements to the Action Handl er 22 December 2010 Ver G 40 Installation and Operation Manual XGate TD 92338GB i nt elecents 5 Value 90298 EH Translation table ostiwzate event Evene elemancstSi Nae lm GT EN PID 3115 3 0 1 01 sens i GIVEN 5 2 1 01 ut XGate event Event elemenzs 5 Value Pippi a NAME Pia 5 PY 4 i cut XGate event Event Granma ts NAME FAMILY pvi i 2 0 i cut XGate event Event elenents 5 Value Lingstr rump i cut XGate event Event elementa 5 N
18. ETB end of trans block 55 7 87 W 119 Ww 24 CAN cancel 56 8 88 X 120 x 25 EM end of medium 57 9 89 Y 121 y 26 SUB substitute 58 90 Z 122 Z 27 ESC escape 59 91 123 28 FS file separator 60 lt 92 124 29 GS group separator 61 93 125 30 RS record separator 62 gt 94 126 31 US unit separator 63 95 127 DEL 22 December 2010 Ver G 37 Installation and Operation Manual XGate TD 92338GB Appendix D Extracting Information from HL7 v2 Messages D 1 The appendix describes how to configure the XGate Event Handler for extracting information from HL7 version 2 messages into event elements for XGate event assignment The HL7 version 3 is an XML based protocol See Appendix E XML Message for more information HL7 Classic Style Message Definition The HL7 protocol transfers simple messages in which all data is transferred as ASCII data A message is terminated with the characters as defined in the Minimum Lower Level Protocol MLLP Each segment begins with a three character literal value that identifies it within a message A segment is always terminated with an ASCII Carriage Return character Segments may be defined as required or optional and may be permitted to repeat The first segment is a message header MSH It contains the delimiter characters to be used in the message A amp and other information Each segment consists of several Data fields Data fields are separated with a verti
19. MODE TEXT TRANSLATION SAVE TEXT Figure 12 Design mode of the Translation page Clear the Enable translation mode box and press BUTTON SAVE to return to standard view 22 December 2010 Ver G 12 Installation and Operation Manual XGate 5 6 TD 92338GB 1 0 Setup Inputs and outputs are defined in the I O Setup page found in the left menu under Other Settings The activation of an input can be set to on opening or on closing and the initial state for the output can be set to low or high 1 0 Setup Outputs ID Output Name Module Address Output Inactive Initial State 1 Internal Output 1 127 0 0 4 Internal 1 High open collector Reset 2 Internal Output 2 127 0 0 1 Internal 2 High open collector v Inputs ID Input Name Module Address Input Activation Arainn 1 Internal Input 1 127001 Internal 1 On Opening v I 1 2 Internal Input 2 127 0 0 1 Internal 2 On Opening E 3 TestAM input 127001 om h On Opening x Cancel Figure 13 I O Setup page For the outputs the state is set to the opposite of the initial state when activated For example if output 2 is set to low in initial state the output will automatically be set to high when activated Every time a new output or input is defined an automatic ID is created The ID is a running number which can manually be changed into another number or a text if wanted When an output or input has been deleted the
20. Normal Low Figure 18 Parameters are set when more than one XGate is used and for priority indication 5 9 1 General parameters Click Edit to configure the following general parameters Assignment Handler IP address Enter the IP address of the Action Handler that shall handle event assignments Identity A unique name for the Action Handler should be entered when more than one XGate is used e Individual group number response Set to Yes if an action sent to an address that is diverted to two or more members shall wait for responses from all members before deciding the action to be a failure Report status Set to Yes if status for all actions sent from the Action Handler shall be reported back to the Event Handler 5 9 2 Priority Indication mapping In each of the priorities you can set up how the indication should be repeated The parameters are Interval time Number of indications Reminder session Reminder attention 22 December 2010 Ver G 18 Installation and Operation Manual XGate TD 92338GB 5 10 Ascii Interface The Ascii interface makes it possible to e interpret alarm and messages from different systems receive messages via serial ports e enable access to external servers over HTTP 5 10 1 Syntax for Ascii code Translation To enter control characters the Start Stop string in the TCP Server parameter can be used The Serial Communication parameter is entered with Ascii code
21. TD 92338GB Installation and Operation Manual XGate 22 December 2010 Ver G Installation and Operation Manual XGate TD 92338GB Contents ueni 1 1E REQUIFCMENTS o L 2 T PE Requirements isese E RE COE o RUD e d eb 2 11 2 Unite Modules Requirements eee aeg ettet 2 Mhuclrup 3 AL Description Of LED inidi amp ators 2 ettet terti te EEE 3 2 2 oIntermalnputs and OUTPUTS seses RD Ei 3 2 3 Error Relay eee RH Ham ect 4 VE MEET 4 241 Unlicensed Mode suce ettet UI RR RR Dre 4 2 5 SoftWare Upgrade edet diac i odes de tede dfe 4 3 PLANNING eed 5 4 XGate User Interface scccsscccscssssssscsssscessssescsssssessssessssessssssssessssessssessesessesseseseess 6 4 1 Download HTML files oe en ec RE E ERE ERR E ed 6 4 2 Upload HIML Til8 ctii or tren eee erre tavern e NE ONREG 6 4 3 Finksin tne home page i cree e Ao p 7 cEsonidlcunnpmtmc E 8 Bl BASIC E 8 5 2 Change Langlage uc terne Aree DH re EUR po oe UH Rn 9 5 3 Back p ReStOre semet metet du e ee e tee nb ttt 9 DA Advaliced s ede EROR 10 5 5 Translatio Di ete ER EB RIEN SER NR IR M eei 10 5 5 17 Translatiorrof theGU te RR D e ee 10 5 5 2 Delete a Language ue en eren eb ea EE RR 11 5 5 3 GUI UDOates
22. Test AM input 127 0 0 1 01 1 On Opening Y x 4 Prod line 2 problem 127 0 0 1 12 3 On Opening oC 5 Prodine20K 127001 2 e j Oncesm w x Figure 15 Define new inputs 1 Click Define new input mer 2 le Prod line 5 problem lal On Opening x i C Internal 2 Enter a unique Input Name 3 Enter IP address of the module connected to the A bus Normally localhost but if the A bus is connected to another Unite module its IP address is set here 4 Enter module s module address on the A bus or select Internal depending on if the input is connected via A bus module or directly to the XGate hardware If you want to trigger on both opening and closing or using different Activation time you can define multiple inputs for the same physical input This can for example be used if you at a door by using a microswitch want an activation on both opening and closing the door 5 Enter Input number Note If you have selected the internal checkbox in the previous step enter the number of the internal input 1 or 2 6 Select Activation condition 7 Enter Activation Time in seconds 1 999 By default a notification will be sent immediately but if you enter an activation time the input has to be active for the set time before a notification is sent 8 Click Save 22 December 2010 Ver G 15 Installation and Operation Manual XGate TD 92338GB 5 7 Data Monitor This is used to monitor data rec
23. The XGate will have full functionality for 2 hours in unlicensed mode When the time for unlicensed mode runs out XGate needs to be restarted either physically or from the XGate Administration web page How to set the XGate in unlicensed mode is described in the Installation Guide ELISE2 TD 92232GB Software Upgrade To upgrade the XGate with a new software version by installing a software image do as follow Note To be able to keep all the settings that has been done including the Event Handler you will have to make two backups of the database one system backup and one XGate backup 1 Make a system backup and an XGate backup of the database see chapter 5 3 Backup Restore on page 9 2 Install the software image for information see Installation Guide ELISE2 TD 92232GB 3 Restore the system backup and then the XGate backup see 5 3 Backup Restore on page 9 To upgrade the XGate with a new application software see Installation Guide ELISE2 TD 92232GB This way of installing a new software should not effect the settings that has been done but a backup is always recommended if something should happen during installation Installation and Operation Manual XGate 3 Planning TD 92338GB Before implementation of actions and events in the XGate User Interface it is necessary to plan and identify actions and events etc that is going to be set up in the Graphical User Interface If Duty Assignment is going to be used yo
24. XGate will not remember that the previous ID number is free to be used again The numbering will just continue on the number after the last created one 5 6 1 Outputs and Inputs Before an input or output can be used in the configuration it has to be defined with a name and Module Address The module address consists of IP address and if Alarm Module and or Output Module are used the module address on the A bus XGate outputs The XGate hardware has two outputs of open collector type that can be used in the Alarm Handling These outputs are predefined at delivery The initial state can be set to high or low XGate inputs The XGate hardware has two inputs that can be used These inputs are predefined at delivery The states that can be detected are open and close 22 December 2010 Ver G 13 Installation and Operation Manual XGate TD 92338GB Output Module outputs The number of outputs that can be used in XGate can be extended by using an Output Module OM connected to the A bus The output on the OM is defined by a name the IP address of the module connected to the A bus the OM s module address on the A bus and the output number The initial state can be set to high or low Alarm Module inputs The number of inputs that can be used can be extended by using an Alarm Module AM connected to the A bus The input on the AM is defined by a name the IP address of the module connected to the A bus the AM s module address on t
25. ame techn it aic XGate event Event elements 5 Value Fi Figure 33 Event Handler translation table Acknowledgements In HL7 two types of acknowledgements exist Accept and Application acknowledgement The MSH segment of the received HL7 message defines which type of acknowledgment the sending party expects This EH configuration is build to only send accept on both types of acknowledgements This EH configuration will not send error or reject for those two types of acknowledgements A customer who would like this functionality needs to extend the configuration himself Depending on the values of Fields 15 and 16 of the MSH segment an acknowledgement type is expected The EH configuration will always send Accept acknowledgement with value CA commit accept when MSH field 15 has a value of AL always or SU success completion e Application acknowledgement with value AA application accept when MSH field 16 has a value of AL always or SU success completion When MSH fields 15 and 16 both are omitted only an application acknowledgement with value AA will be send 22 December 2010 Ver G 41 Installation and Operation Manual XGate TD 92338GB MSA with field 1 2 CA MSA with field 1 AA Figure 34 Two different acknowledgments The Commit Accept acknowledgement will be send as soon as the Event Handler starts to process the HL7 message The application acknowledgement will be send a
26. an be changed It will activate the Extract and send data by default if nothing is done e Activations conditions can be set on activation It will activate Extract and send data by default if nothing is done External Actions This is where to create event element assignments Open the folders External Action Extract and send data Click Assignments to create event element assignments e Define alarm type and location There are four predefined examples Alarm Type Alarm Type description Location Location description Conversion tables This is where to create and edit translation tables 22 December 2010 Ver G 25 Installation and Operation Manual XGate TD 92338GB 6 Serial Interface The serial interface included in XGate makes it possible to receive input from external equipment The serial interface supports the ESPA 4 4 4 protocol and two ESPA dialects the Ascom dialect teleCOURIER and Ericsson dialect with some limitations The serial interface also supports the TAP 1 8 protocol and a simplified protocol called the Ascom Line protocol A detailed description of the two ESPA dialects and the Ascom Line protocol can be found in the document Protocol Serial Data Interface S942SI TD 92088GB TAP Telocator Alphanumeric Protocol is a paging protocol used to transmit up to a thousand 7 bit characters to an alphanumeric pager Developed in the early 1980s by the Telocator Paging Association which
27. andler In the Event Handler there are four different links where events and triggers are set up for Event Elements an overview of the programming to view Event Handler logs and where to administrate the databases of the Event Handler More information about the configuration of the Event Handler is found in the document Programming Guide Event Handler TD 92329GB Event Handler Configuration Assignment of Event Elements Overview Display an overview of the Event Handler programming Log Display the Event Handler log Database administration Administration of the Event Handler configuration and block databases Figure 22 The links to the Event Handler 5 13 1 Overview of Programming This shows an overview of the Event Handler programming which can be a help during programming 5 13 2 View Logs All changes in the configuration of the Event Handler are written to the log It is also possible to write information to the log for example when a trigger is activated For more information about the log file and its content see the chapter Event Log File in the Programming Guide Event Handler TD 92329GB 22 December 2010 Ver G 22 Installation and Operation Manual XGate TD 92338GB 5 13 3 Database Administration The database administration is used to synchronize the Event Elements that have been created in the Event Assignment User Interface 1 Click Database administration and go to Load factory Block database lo
28. area 22 December 2010 Ver G 6 Installation and Operation Manual XGate TD 92338GB 4 3 Links in the home page To enter the pages User ID and Password is required The users are admin sysadmin or a defined user The defined user log in with its own User ID and password that is set up by the administrator The Duty Assignment is a direct link to the Duty Assignment where the layout for destinations is set up and addresses are set up for actions See User Manual XGate TD 92364GB Administration The Access Rights is a direct link to the Access Right Administration page where access rights to the GUls are set up See User Manual XGate TD 92364GB The Action Configuration is a direct link to the Action Configuration page where actions for the events are configured See User Manual XGate TD 92364GB e The Event Assignment is a direct link to the Event Assignment page where Event Elements are defined and assigned Events are administrated e The Advanced is a direct link to the XGate configuration and administration page it is only possible to log in as admin or sysadmin All links can also be reached from this page See also 5 Configuration on page 8 22 December 2010 Ver G 7 Installation and Operation Manual XGate TD 92338GB 5 Configuration The XGate User Interface is divided into two parts a Basic Setup and an Advanced Setup The Basic Setup is for configuration and assignments The Adva
29. cal Location which means that it will look for Location in the message 3 This is where the translation Location table has been setup to translate the Location 4 This is where the translation Alarm Type table has been setup to translate the Alarm Type The example in the Extract and send data also got four event elements defined to the Alarm Type and the Location followed by a Sent Block where this is by default sent to the Event Assignment and a Response handling where triggers can be setup A configuration example of an incoming input message containing alarm type could look like location 03 12345 where the alarm type is 03 and the location is 12345 A translation table has been set up to convert 03 to be sent out as a fire alarm and the location 12345 to be sent out as Main building floor 1 22 December 2010 Ver G 24 Installation and Operation Manual XGate TD 92338GB Event Triggers This is where conditions are defined on incoming events and where to activate predefined actions There are different way of doing this condition can be set up in Match Condition or in Activation Several conditions can be set up for the Event that occur Open the folders Event Triggers Input messages If no configuration is done it will trigger on all incoming messages e Match Conditions if there exists more than one trigger and they should differ from each other the state and condition of the trigger c
30. cal bar character Individual data fields are found in the message by their position within their associated segments A data field can consist of more than one component A component may have sub components Fields may be repeated l segment Figure 30 A HL7 message Delimiters ASCII e VT 11 0x0B FS 28 0x1C e CR 13 0x0D HL7 Define by Suggested value Comment Message MLLP start lt VT gt Defined in TCP connection stop lt FS gt lt CR gt parameters for the HL7 MLLP TCP connection in the ASCII Input Module Segment HL7 stop lt CR gt Defined static in Event Handler configuration Field 15t char after MSH bar Defined by HL7 message segment ID received by Event Handler Repetition 3 char after MSH tilde Defined by HL7 message segment ID received by Event Handler Component 2 char after MSH A circumflex Defined by HL7 message segment ID received by Event Handler 22 December 2010 Ver G 38 Installation and Operation Manual XGate D 2 D 3 TD 92338GB Sub 5th char after MSH amp ampersand Defined by HL7 message component segment ID received by Event Handler Escape 4 char after the backslash To escape the above MSH segment ID defined message element delimiters when used in fields represented by string text data types Defined by HL7 message received by Event Handler Example HL7 v2 x
31. cated in the bottom of the page Load factory Block database B Click to load the Block database that is included in the software delivery Figure 23 To load Block database for synchronization of Events 2 Click Load a dialogue window opens Click Yes to synchronize 3 Go back to the Advanced Setup and Event Handler see 5 13 4 Configuration of Events 5 13 4 Configuration of Events This is used to make assignment of Event Elements 1 Click Configuration Home g 4Event Handler configuration i B Event Triggers _ Input message EI Input activity 4L Response Triggers 4 External Actions EJ Extract and send data Send Block SE Response Handling 4 Delay Actions J Action Groups i Assignments Event Response Trigger Trigger Translation Tables 99 99 Alarm type table Location table Local Elements a Persistent Elements Actions amp External Interfaces Action Groups i Configuration Overview External Delay Action Action Elements Translation Tables Figure 24 The Event Handler Configuration For simple configuration setup it is only necessary to make configurations in External Actions gt Extract and send data gt Assignments and Translation Tables gt Location table 22 December 2010 Ver G 23 Installation and Operation Manual XGate TD 92338GB It is possible to get explanation and instruction of the Event Handler
32. ce RR X 26 6 1 Cables for the ESPA the Ascom Line and the TAP protocol ssssss 26 6 2 Serial Protocol Settings e netta pe OU EEUU staat 27 6 2 T ESPA PEIOTOCOL oce tetto tit Te ER E ERI DD he es 27 6 2 2 Ascom Line Protocol eee E RR E GN RENE EAR OM 29 6 243 TAP PrOtOCOL uisu SWRIBU ORNARI 30 7 Related Documents eee eee eese esee ee eene eene tn setas tns tn staat es sees e ts ess eene es stas ena sena 32 8 Document History Lees e eese cesse nete eene eene einen seta eene etas en astantes eene etse en seta sens saa eo aae 33 Appendix A XGate and IT Security eese eee eere eren eren eee eene etae ena sess ates e tenen 34 Appendix B Troubleshooting eeeeee eere eene eene n etienne eene tenta setas ense nates etn etoe 35 Bidit Applet problemis s eR RB d EQ PR RNRQUS 35 B 2 How to remove Java status bar sss nre 35 Bed FTP Pall Utes em p a E TRU ge ND SR RUS B 4 Synchronization problems or e Dee qe I e eoa lestie egy B 5 Advanced Troubleshooting Appendix Cs ASCIl table me Appendix D Extracting Information from HL7 v2 Messages csscssssessesseseeserees 38 D 1 HL7 Classic Style Message Definition seen tenente tenennes 38 Di2 Example HEV V2 3 e te RR DOR ie ette 39 D 3 XGateVEvent Handler Configuration DA Configure XGalec e to RB RR EE ERRORS D 5 Load the HL7 v2
33. e applications Check the log files on the XGate Administration web page for more information 2 2 Internal Inputs and Outputs The XGate has two open collector outputs J16 see figure 2 above that can be used by the Fault Handler in the ESS Unite CM see the Installation and Operation Manual Enhanced System Services ESS TD 92253GB Installation and Operation Manual Unite CM ELISE2 TD 92718GB or Installation and Operation Manual Unite CM ELISE3 TD 92735GB The 22 December 2010 Ver G 3 Installation and Operation Manual XGate 22 December 2010 Ver G 2 3 2 4 TD 92338GB inputs are used for system supervision For connections and a more detailed description of the outputs and the inputs see the Installation Guide ELISE2 TD 92232GB Error Relay The error relay output J14 in figure 2 on page 3 can be used to indicate if the XGate is operating When the XGate starts the error relay operates When the XGate is shutting down or rebooting the error relay releases Whether the error relay output opens or closes on actual relay status depends on how the jumper J15 is set For connections of the error relay and error relay output configuration see the Installation Guide ELISE2 TD 92232GB Licences The XGate is delivered with the licences already programmed For available licences see Data Sheet XGate TD 92339GB 2 4 1 Unlicensed Mode 2 5 When needed the XGate can be started in unlicensed mode
34. e permitted Valid values 1 127 Default 3 tries How many checksum failures from external equipment shall be permitted Valid values 1 127 Default 3 tries 30 Installation and Operation Manual XGate Numbers of allowed timeouts ASCII conversion table 2 Click Activate 22 December 2010 Ver G TD 92338GB How many timeouts shall be permitted Valid values 1 127 Default 3 timeouts Makes it possible to convert display message characters 31 Installation and Operation Manual XGate 7 Related Documents nstallat nstallat nstallat nstallati Data Sheet Unite CM ELISE2 ion and Operation Manual Unite CM ELISE2 Data Sheet Unite CM ELISE3 ion and Operation Manual Unite CM ELISE3 ion Guide ELISE2 Data Sheet XGate Data Sheet Enhanced System Services ESS on and Operation Manual Enhanced System Services ESS Programming Guide Event Handler System Description Unite System Planning Unite User Manual XGate Administration User Manual Duty Assignment Protocol Serial Data Interface S9428Sl 22 December 2010 Ver G TD 92338GB TD 92339GB TD 92250GB TD 92253GB TD 92719GB TD 92718GB TD 92739GB TD 92735GB TD 92232GB TD 92329GB TD 92243GB TD 92258GB TD 92364GB TD 92374GB TD 92088GB 32 Installation and Operation Manual XGate 8 Document History TD 92338GB For details in the latest version see change bars in the document
35. ed The destination text defines what data is extracted from the segment and how the event element will be named They are defined as e Source text HL7 segment ID as defined by the standard for example PID e Destination text lt description gt lt number of values ELEMENT TO EXTRACT Where e number of values number of ELEMENT TO EXTRACT occurrences that follows in this definition 22 December 2010 Ver G 43 Installation and Operation Manual XGate TD 92338GB ELEMENT TO EXTRACT lt ELEMENT NAME gt lt FIELD gt lt REPETITION gt COMPONENT SUBCOMPONENT Where e ELEMENT NAME Name of the Event element that is sent to the Action handler e FIELD Field number that includes the data start count from segment ID e REPETITION Repetition number of the field that includes the data EH will take first occurrence if no repetition exists COMPONENT Component number of the field that includes the data e SUBCOMPONENT Subcomponent number of the component that includes the data EH will take COMPONENT if no subcomponent exists Example Note A zero 0 is used if only one 1 value exist in the segment PID Patient Identification 3 ID 4 0 0 0 1NAME GIVEN 6 1 2 0INAME FAMILY 6 1 1 1 Would extract the following 3 elements from the PID segment from example message e Element name ID with value 2490298 Element name NAME GIVEN with value Pippi Element name NAME FAMILY w
36. eived by the ASCII input see 5 10 Ascii Interface on page 19 Data Monitor HL7 MLLP Y Show raw data O Show parsed data Raw Data No raw data received Figure 16 HL MLLP was selected with no result on raw data Select Input Select Show raw data or Show parsed data Click Get Data Information of received data will be shown in the field below It is possible make a TCP connection to the port 10129 on an XGate In real time you can get the same data that has been presented on this page by sending some commands on the TCP connection Commands to use type raw message all type what type of data to get raw will look on what is coming in to the module message will look at the content of the message all will look in both raw and message source realtime cache realtime is in the beginning empty but will be filled up as data is received cache stored data channel name what input to look at start gets data and shows what next to do if some steps are missing stop stop get data list lists the available channels help shows a list of available commands The way to write is to enter the command all lines ends with carrige return Space is used to separate the command from the data 22 December 2010 Ver G 16 Installation and Operation Manual XGate TD 92338GB 5 8 ELISE Setup The Basic Administration is a direct link to the System Setup page where parameters are
37. ent over this connection The message is encapsulated between the input start and input stop characters see figure 35 on page 42 The ADT is a software module in HIS 22 December 2010 Ver G 39 Installation and Operation Manual XGate TD 92338GB VT MSH XN amp HIS ADT MODULE ASCOM XGATE 200 3111 EVN PID Rull Efra 70 IPI2 21 I IALISUI A08 200601090243 CR 2490298 L ngstrump amp amp L ngstrump amp Mr amp N gardina Krusmunta emsdotter Ms Langkous amp amp Langkous amp Dh Rolgordijna Kruizemunta Efrafmsdochter Juf Villekullla Br kmakargatan 7 Vimmerby SE 9999 100461234567891 1 1 1 11 INI E CR PVl O First aid Room S Bed rT nn nmennTenn p umant nwIDEPEEEE TE babes CRD IN1 11 17022 CZ ZorgverzekeringlPostbus 9999 5243xxxlI I ELLE EIPETLEL LEE LEE PEE 111111900080 IN2 HELLE ELEEL EET LET EE LE ET ELI T3 R lt eR gt lt FS gt lt CR gt Figure 31 The connection between ADT ASCII ASCII Event Handler The ASCII application will send a UNITE paging message to the Event Handler The body of the paging message includes the encapsulated message Note The paging body text can only contain up to 5000 characters UNITE message lt USP type message class paging id XXXXXXXX gt lt gt lt gt lt Body gt MsH 4 HIS ADT_MODULE ASCOM XGATE 20060109024819 ADT A08 20060109024311170 P 2 21 ALI SUI I EVN A0B 200601090243 CR PID
38. ervices ESS Software version 2 00 or later Unite Connectivity Manager Unite CM Software version 1 00 or later 22 December 2010 Ver G 2 Installation and Operation Manual XGate TD 92338GB 2 Installation For mounting and connection of cables see the Installation Guide ELISE2 TD 92232GB 2 1 Description of LED indicators There are a number of LEDs on the ELISE hardware that indicate the status of the software see figure 2 on page 3 These status indications are software dependent and are described in this chapter For information regarding indications by other LEDs see the Installation Guide ELISE2 TD 92232GB Q1 Ez Sw2 2 ON BERSRRER hw fe a Q Dp sw3 i pu BEBRRHHR Pm ES E 6 Q y pese Tr i 164 J2 7 i N o pne S dS i i D j IC24 OQ HE ae oe ae d 7 nt aie i on Jix gs Loh ES x6 hz4 o mp 9 SOS x AL S m p x hou em TX un 6 E 120 1 oooo oO p ss S Figure 2 Location of the LEDs indicating the status of the XGate LED LED Status Indication LED2 ON Paging waiting in queue to A bus OFF No pagings in queue LED5 ON XGate applications are up and running OFF Problems when starting th
39. he A bus and the input number The states that can be detected are open and close For more information refer to the hardware Installation Guide ELISE2 TD 92232GB 5 6 2 Define Outputs 1 Click Define new output Outputs ID Output Name Module Address Output Inactive Initial State 1 Internal Outpt 127 0 0 1 Intemal 1 2 127 0 0 1 Internal 2 3 Siren 127 0 0 1 LL E Low x Internal Figure 14 Define new outputs 2 Enter a unique Output Name 3 Enter IP address of the module connected to the A bus Normally loopback to localhost but if the A bus is connected to another Unite module its IP address is set here 4 Enter module s whose output should be activated module address on the A bus or select Internal depending on if the output is connected via A bus module or directly to the XGate hardware 5 Enter Output number Note If you have selected the internal checkbox in the previous step enter the number of the internal output 1 or 2 6 Select Initial State and click Save 1 Every module that is connected to the A bus has a two digit hexadecimal address that is set with a DIP switch 22 December 2010 Ver G 14 Installation and Operation Manual XGate TD 92338GB 5 6 3 Define Inputs Inputs ID Input Name Module Address Input Activation igna 1 Internal Input 1 127 0 0 1 Internal 1 On Opening 2 nemallnut2 127001 Intemal 2 On Opening v 3
40. he text and the number to call is received as an option in the receiving portable device The call digits are dialled when the user selects the option Max 40 characters Note Overrides Message Ref ID TTL Leave empty if data identifier 9 is used for message reference Defines if status information for ongoing pagings shall be sent back to external equipment Set to No if external equipment have problems in handling status information Default Yes Defines the time before lost communication with external equipment will be considered as a fault and sent as a Status log If set to 0 no supervision is done Max 3600 seconds Default 0 Makes it possible to convert display message characters 28 Installation and Operation Manual XGate TD 92338GB 2 Click Activate Default display message Default message priority Default beep code Transmission delay x10 ms Status to ext equipment Start character End character Record separator character ACK character NAK character ASCII conversion table Click Activate 22 December 2010 Ver G 6 2 2 Ascom Line Protocol 1 The following settings can be selected changed Settings Description Enabled Yes No selection Default No Name Description of the channel Serial port Port selection 1 2 3 Default None All three ports can be configured here Note that only one at the time can be used Bit rate Select bit rate Default
41. integrate into Nurse Call Systems Patient Monitoring Systems Laboratory Information Systems Hospital Information Systems Radiology Information System Building Management Systems and Security Management Systems A serial interface is included to enable input from external equipment using standard serial protocols The serial interface supports the ESPA 4 4 4 protocol the Ascom Line protocol and the TAP protocol The Ascom Line protocol is designed to be simple enough to be controlled manually using a terminal program connected to the serial port This document describes the installation and configuration of the XGate that is done before actions and events etc are implemented in the XGate User Interface Information about administration of the User Interface and an overview picture of the XGate Runtime is found in the User Manual Administration XGate TD 92364GB Remote connection i System 900 External w EN M Systems ToU XGate a E 5 Externa equipment teleCARE M Figure 1 XGate connected to Unite system external systems and external equipment 22 December 2010 Ver G 1 Installation and Operation Manual XGate TD 92338GB 1 1 Requirements 1 1 1 PC Requirements Microsoft Internet Explorer 6 0 or later JVM 4 2 1 or later 1 1 2 Unite Modules Requirements When the XGate function Duty Assignment is planned to be used the following versions of the Unite module must be used Enhanced System S
42. ion 2 to load the sample database BR WN HG Click Translation Tables to open the Event Handler Configuration page Event Handler Configuration i Activate configuration Save configuration Check configuration View Element help EI Event Handler configuration C Event Triggers Translation Table HL7 MESSAGE DEFINITION Response Triggers C External Actions Delay Acton ChengeNeme Dele Action Groups ranslation Tables L HL7 MESSAGE DEFINI HL7 SEGMENT FIELD Create Edit Translations in table L HL7 TABLE 0155 Local Elements EE Text to translate After Translation j External Interfaces a Get data i 1 Configuration Overview gl Esse Ei Existing Translations Destination Text EVN Event typeltIHL7 EVENT TYPECODE 2 0 1 0 MSH Message header lif you want this configuration NOT to function then you should remove this translation Patient identification SIPATIENT_ID 4 0 1 OIPATIENT_NAME_PREFIX6 0 5 0 PID PATIENT_NAME_GIVEN 60 2 0IPATIENT_NAME_FAMILY 6 0 1 1 PATIENT NAME SPOUSE 6 1 1 6 Delete All Figure 36 HL7 Translation Table v2 For more information on how to create edit a translation table see Programming Guide Event Handler TD 92329GB For information on Source text from HL7 see an applicable HL7 document Define HL7 v2 Segment Data The source text is used to indicate from which HL7 segment data needs to be extract
43. ith value Langstrump Note Do NOT remove or change the MSH entry in the translation table It is mandatory for the Event Handler configuration to work properly 22 December 2010 Ver G 44 Installation and Operation Manual XGate TD 92338GB Appendix E XML Message E 1 The appendix describes how to define segment from XML messages XGate includes a protocol template that can be used as an example for XML messages received from external Systems XML messages are written as tag value tag Example XML message The following example XML message is used to explain the XML protocol template delivered with XGate Message lt Type gt PSPA lt Type gt lt PSPA gt lt Patient gt lt Id gt 1234567890 lt Id gt lt Name gt lt Prefix gt Miss lt Prefix gt lt Given gt Pippi lt Given gt lt Family gt Langkous lt Family gt lt Name gt lt Location gt lt Ward gt Name First aid Name Ward Room lt Name gt R1 lt Name gt lt Room gt lt Bed gt lt Name gt S4 lt Name gt lt Bed gt lt Location gt lt Patient gt lt PSPA gt lt Message gt E 1 1 Define XML Segment Data The translation table is defined as The source text must be an incrementing number indicating an index to each element that needs to be extracted from the XML message The destination text defines which tag values are extracted from the XML document Source text incrementing n
44. ived After 3 successive timeouts an automatic disconnect sequence will be initiated These values can be changed through parameters There will be no timeout between blocks After a logon has been received and after each pagingblock the Serial Interface is put into sleep mode Three actions can wake it up A logoff request a new logon request or a new pagingblock Will be accepted but truncated Not used by the Serial Interface Not supported Will be converted to something above Ox7F by adding the 8 th bit 49
45. mber 2010 Ver G 46 Installation and Operation Manual XGate TD 92338GB Appendix F Protocol Limitations F 1 This appendix describes a number of protocol specific limitations and deviations The serial interface included in XGate is a successor to the system 900 module S9428l Serial Interface and the supported ESPA and Ascom Line protocols are described in the document Protocol Serial Data Interface S942SI TD 92088GB To be able to fully understand the limitations it is recommended to have this document available ESPA 4 4 4 F 1 1 Functionality The protocol consists of blocks which consist of records which consist of data F 1 2 Limitations Protocol Blocks The original ESPA 4 4 4 specification has 4 different blocks and an additional 5 th block for equipment manufacturer specified functionality The 5 th block is not used by Ascom and Ericsson dialect instead two additional blocks 7 and 9 are specified for the dialects Request for license Block 7 Ascom and Ericsson dialect This block is not supported since license handling differs from how it was done in 942SI The block is NAK ed if received Request for module key number Block 9 Ascom and Ericsson dialect This block is not supported since license handling differs from how it was done in 942SI The block is NAK ed if received Protocol Records Call type Speech call Record 4 2 Speech paging is not supported This record is handled as a standard
46. ment Administration of duty assignments Administration Access Rights Administration of access rights in the XGate module Action Configuration Configuration of available events and which actions to take Event Assignment Conditions to be fulfilled indicating that an event has occurred Advanced Configuration of the XGate module ascom Figure 4 The default start page of an XGate The XGate s home page is an HTML page which makes it possible for the customers to change the appearance to be more customized pictures and text can be added and changed The appearance of the home page will look like in the figure above if the default home page is used 4 1 Download HTML files The FTP session must be in the active mode to be able to log in to FTP areas In for example Internet Explorer got to gt Tools gt Internet Options gt Advanced gt and ensure that the check box Use Passive FTP is not marked 1 Log on to XGate with an FTP client for example Internet Explorer Fill in the XGate host name in the address field ftp booxxoox xxx Log on with ftpuser The default password is changemetoo 2 Download copy all files including GIFs and CSS to a folder on your hard disc 4 2 Upload HTML files Upload paste all updated HTML files including GlFs and CSS to the XGate FTP area 1 Log on to XGate as in point one when you downloaded HTML files 2 Upload paste the files into the FTP
47. mode TTL seconds Manual Ack type Manual Ack TTL minutes Message Ref ID TTL minutes Interactive Message Option Text for Callback number Return Status Information Supervision time for communication seconds ASCII conversion table 22 December 2010 Ver G TD 92338GB Beep code if not specified in the external equipment Default 2 beeps Select how the paging shall be acknowledged if not specified by the external equipment Default No Ack Urgency if not specified in the external equipment Default Normal How long to wait before transmission to external equipment Default 30 milliseconds How to handle identical pagings Default Not accepted If running number shall be sent or not Default No Determines when to start timeout mode i e remove paging from queue Default after Call Terminated call status Determines the time for timeout mode i e during this time the paging remains in the queue after the Timeout mode has started Default 5 seconds Dependent on if the external equipment supports negative acknowledge Default Positive and Negative manual acknowledge How long a paging with manual acknowledge remains in the queue after transmission of Call Terminated call status Default 5 minutes How long a Message Reference ID remains in queue Only valid for Ascom dialect Default 5 minutes Defines text that will be added to call digits sent from external equipment T
48. nced Setup is for database administration and configuration with help of the Event Handler For the Input Data Conversions and the Event Handler in the Advanced Setup the Programming Guide Event Handler TD 92329GB is needed as a complement to this Installation and Operation Manual 5 1 Basic XGate Basic Basic Setup Set Language PECENE User Administration Access Rights Set up access rights for the Unite User Teams Action Handling Action Configuration Set up of actions for the event that occurred Define what to transmit and success and failure conditions Assignments Event Assignment Set up which Event Elements that correspond to a certain Event Duty Assignment Set up addressees for the actions Input Data Conversions Translation Tables Figure 5 An overview of the Basic Setup page This document describes how to change the language and how to backup and restore the database The administration of the User Interfaces that is found under Basic Setup see figure 5 is described in the User Manual Administration XGate TD 92364GB There are two types of users for the Basic Setup Technicians first time set up commissioning sysadmin Full access right Administrators admin Full access right There is another type of user that the administrator set up e Normal users These users can have access right to all Graphical User Interfaces except the advanced configurations 22 December 20
49. not backup the information of the Event Handler To backup or restore the database go to Backup Restore in the left menu of the Home page Backup Restore Backup parameters Restore parameters Eoee Figure 7 Backup restore of the settings in the XGate GUI Backup 1 Click Backup 2 In the dialogue window click Save and enter the file name and file path Restore 1 Click Browse to locate the tar gz file 2 Click Restore Installation and Operation Manual XGate 5 4 Advanced TD 92338GB This part is only used by technicians during configuration and database administration I Advanced Translate GUI VO Setup Data Monitor Basic Administration XGate Advanced Setup Event Handler Configuration Overview Log Database administration Assignment of Event Elements Display an overview of the Event Handler programming Display the Event Handler log Administration of the Event Handler configuration and block databases Figure 8 An overview of the Advanced Setup page In the Advanced User Interface it is possible to configure and administrate the XGate by using the Event Handler add translations set up inputs and outputs and go to the ELISE Setup for the XGate 5 5 Translation 5 5 1 Translation of the GUI To translate the GUI go to the Translate GUI page found in the left menu on the XGate Home page Translation Existing languages English
50. nt Hide Java Applet Window banner permission java awt AWTPermission showWindowWithoutWarningBanner y B 3 FTP failures If you get an error message when trying to log in to the XGate module after entering the IP address into the address bar in Internet Explorer ensure that the FTP session is in active mode See 4 1 Download HTML files on page 6 B 4 Synchronization problems e fthere is no Event Element received in the Event Assignment page after clicking Add check that the Event Elements have been synchronized in the Action Configuration page e fthere are no Event Elements to make assignment of in the Event Handler check that synchronization is done in the Database administration gt Load factory Block database 22 December 2010 Ver G 35 Installation and Operation Manual XGate TD 92338GB See User Manual Administration XGate TD 92364GB for information about how to synchronize the defined Event Elements B 5 Advanced Troubleshooting The XGate Basic Administration page requires administrator or system administrator rights includes advanced troubleshooting Snapshots of selected logs or a complete log can be viewed 1 In the XGate Basic Administration page click the Troubleshoot button The Troubleshoot page opens 2 In the left menu on the Troubleshoot page you can view logs and find detailed information about the system see below View Info Log View Error Log View Complete Log System
51. orrespond to the time set in other Unite modules and the HTTP timeout in Event Handler Additional http header Header that will be added when connecting to the HTTP server 5 11 SMTP Output Interface To be able to send E mail it is necessary to set up the address for the mail server There is no receiver functionality it is only possible to send E mails from the XGate T 2 3 Click SMTP in the left menu SMTP output Mail server E 1 72 20 9 162 Em Factory cancel activate Figure 20 The SMTP output parameter setting Enter the IP address relay of the mail server and click Activate to save the settings Reboot the module See Installation Guide ELISE2 TD 92232GB Note The company mail server must be set up to allow relaying to be able to send messages from the Ascom Messaging System to E mails Contact your local IT department 22 December 2010 Ver G 21 Installation and Operation Manual XGate TD 92338GB 5 12 Unite User Server Parameter Settings When using the defined users in an ESS Unite CM the IP address is set to define which ESS Unite CM that is set up as a User Server 1 Click User Server in the left menu for parameter settings User Server User Server IP address E Activate Figure 21 The IP address is set for the module that is used as a User Server 2 Enter the IP address of the User Server and click Activate to save the settings 5 13 Event H
52. ou want to use ESPA Line protocol or TAP Continue in 6 2 1 ESPA Protocol 6 2 2 Ascom Line Protocol or 6 2 3 TAP Protocol ESPA Protocol The following settings can be selected changed Settings Enabled Name Serial port Bit rate Mode Flow control ESPA dialect Control station selection Address of external equipment Address of this module Default Call ID Default display message Default message priority 22 December 2010 Ver G Description Yes No selection Default No Description of the channel Port selection 1 2 3 Default None Select bit rate Default 9600 bits s Select mode Default 8 Data bits Even parity Used for handshaking control Default None Select dialect with or without an extra Carriage Return CR Default TeleCourier extensions i e Ascom dialect Determines which module shall act as control station Default External equipment Enter address 0 9 Default 1 Enter address 0 9 Default 2 Number to call if not specified in the external equipment Default 000 Message to display if not specified in the external equipment Default BLANK Priority if not specified in the external equipment Default 7 Normal 27 Installation and Operation Manual XGate Default beep code Default method for ack Default urgency Transmission delay x10 ms Identical pagings treatment Running no to external equipment Timeout mode Timeout
53. paging Record 4 3 Call type Remote ack of old paging in mobile unit Record 4 5 Ascom dialect This record is NAK ed since it is not supported by UNITE Call type Erase of old paging Record 4 6 Ascom dialect If neither ID Record 9 or Running Number Record D is included in the message the message is NAK ed In 9425SI it was ACK ed but didn t function Call type Cordless phone undefined type Record 4 7 Ascom dialect Sent as standard paging Record 4 3 Call type Cordless phone internal type Record 4 8 Ascom dialect Sent as standard paging Record 4 3 Call type Cordless phone external type Record 4 9 Ascom dialect Sent as standard paging Record 4 3 22 December 2010 Ver G 47 Installation and Operation Manual XGate TD 92338GB Number of transmissions Record 5 standard ESPA Mailbox number Record A Ericsson dialect Infopage Record C Ascom dialect Advanced parameters Bleep each transmission Flow control XON XOFF F 2 Ascom Line Protocol F 2 1 Functionality This record is accepted but ignored since it is not supported by UNITE The parameter can be set in the advanced GUI under system 900 Default number of transmissions and is then valid for all messages independent of the record value Here it is also possible to determine number of transmissions based on the paging priority advanced This record is accepted but ignored since it is not sup
54. ported by UNITE This record is accepted but ignored since it is not supported by UNITE This parameter was available in 942SI The parameter is not available in XGate instead the parameter can be set in advanced GUI under system 900 Beep at each Tx Not supported since there are some issues with the control characters If the block check character becomes any of the two control characters XON or XOFF the flow control fails therefore flow control is no longer supported A line protocol message consists of the following records and separators Addr Message Beepcode PagFunc NoOfTransm Prio Infopage All characters are writeable by hand using an ordinary terminal program such as hyper terminal etc Not all records delivers default message to F 2 2 Limitations needs to be given for instance is a valid message that default paging address The following limitations apply PagFunc NoOfTransm InfoPage 22 December 2010 Ver G The Line protocol only supports call type 3 plain paging and 4 alarm All others are handled as plain paging The Line protocol does not propagate no of transmissions but it must be valid if submitted The parameter can be set in the advanced GUI under system 900 Default number of transmissions and is then valid for all messages independent of the record value Here it is also possible to determine number of transmissions based on the paging priority advanced
55. s delimiter disabled as default Restart data capture on receiving Start Word Decides if the data capture shall restart when a start character word is encountered Maximum Clients Amount of clients that can be connected at the same time Close connections initiated by this module Decides if the connection shall be closed or stay open until the server shuts down after data has been sent Set to No if a reply is expected Responses to unknown connection Decides what to do when replying to no longer existing connections Create new will use the supplied IP address and port Use existing will use an existing connection to that IP address and port If no such connection exists a new connection will be created Character encoding of external data Defines how external data shall be interpreted Internal data format Defines how data is formatted when sent to Unite Message to Unite when new connection is established The message defined here is sent before any data is recieved on the new connection Message to Unite when connection is disconnected The message defined here is sent after all other data has been sent Message from Unite to disconnect connection When the message defined here is received it will close the connection 5 10 4 UDP Parameters Click one of the three available to set UDP connections The following parameters can be set up Name UDP port Character encoding of external data Defines how external da
56. s soon as the event elements are sent to the Action Handler D 4 Configure XGate ASCII Input Interface The ASCII input interface is configured for Minimum Lower Level Protocol MLLP session control over a TCP connection on port 2575 HL7 port registered at www iana org 1 In the XGate Basic Administration page select ASCII to edit the configuration 2 If a HL7 port already is configured in TCP Server Parameters click HL7 MLLP or similar to verify your settings Otherwise click NOT USED TCP Connection Parameters The following changes have been made Name d HLZMLLP TCP Port 3 2575 Input Start character string d m Input Stop character string Output Start character string J m Output Stop character string d 2813 End of Session as delimiter d Disabled Maximum Clients EE 1 Figure 35 TCP Connection Parameters 3 Enter the parameters according to figure 35 22 December 2010 Ver G 42 Installation and Operation Manual XGate TD 92338GB D 5 LoadtheHL7 v2 Translation Table The translation table is the link between a HL7 style message and the XGate Event Handler A default translation table is included in the XGate The translation table is defined modified by the customer This instruction describes how to load the HL7 default translation table Click Advanced and log in to the XGate configuration page In the Advanced setup view Click Database administration Click Load HL7 vers
57. set up for the system If Ascii Input and SMTP Output Interfaces are used they must be configured here When more than one XGate is used and the same Event Assignment Handler is used for assignment of all XGates parameters are set up to define which Assignment Handler that shall handle event assignments and duty assignments When using defined users in the ESS Unite CM the IP address is set to the module that is used as a User Server It is also possible to view logs for troubleshooting find out current software versions and get related documents in pdf versions Goto Basic Administration in the left menu to enter the page Normai Mode XGate Figure 17 System Setup page for XGate For information of the parameters click question mark button 22 December 2010 Ver G 17 Installation and Operation Manual XGate TD 92338GB 5 9 Action Handler Parameter Settings The parameter settings for the Action Handler are set up when more than one XGate is used and to define which module that shall handle event assignments this is done in the General parameter setting Parameters can also be defined on how messages should be indicated by its priority this is done in the parameter settings for Priority Indication mapping To save the parameter settings click Activate 1 Click Action Handler in the left menu for parameter settings Action Handler General EN Edit Priority lt gt Indication mapping X Alarm High
58. ta shall be interpreted Internal data format Defines how data is formatted when sent to Unite 5 10 5 Serial Communication Parameters RS232 Ascii Click one of the three available to set Serial communications The following parameters can be set up Name Serial port Input Start Stop character string Is entered with a syntax code see5 10 1 Syntax for Ascii code Translation on page 19 Output Start Stop character string Is entered with a syntax code see5 10 1 Syntax for Ascii code Translation on page 19 22 December 2010 Ver G 20 Installation and Operation Manual XGate TD 92338GB Baud rate Data Bits Stop Bits Parity RTS Restart data capture on receiving Start Word Defines if the data capture shall restart when a start character word is encountered Character encoding of external data Defines how external data shall be interpreted Internal data format Defines how data is formatted when sent to Unite 5 10 6 HTTP Client Parameters Click on an HTTP client connection to set the parameters always use the first in the list The following parameters can be set up Name Descriptive name for the HTTP server Only used in the XGate GUI User name Defines the name for authentication Should correspond to the user name for the HTTP server User password Defines the password for authentication Should correspond to the password for the HTTP server Request timeout seconds The time set here must c
59. u also have to consider about user teams location layout and access rights For best result follow the step by step guide B WN e 8 Identify external Events that shall result in an action Which actions are needed Which information are needed in the actions Define escalation chain and success failure conditions Root 7i Patient call message 4 On success On failure Figure 3 Example of an escalation chain with success failure conditions If Duty Assignment is going to be used create location layout and related information Define required conversion tables If Duty Assignment is going to be used Users and User Teams have to be defined This is done in the ESS Unite CM see Installation and Operation Manual Enhanced System Services ESS TD 92253GB Installation and Operation Manual Unite CM ELISE2 TD 92718GB or Installation and Operation Manual Unite CM ELISE3 TD 92735GB If Duty Assignment is going to be used define Access Rights for the User Teams When this is done the administration of the XGate User Interface can be started See User Manual XGate Administration TD 92364GB on how to configure and administrate the XGate User Interface 22 December 2010 Ver G 5 Installation and Operation Manual XGate TD 92338GB 4 XGate User Interface To open the XGate User Interface enter the XGate s IP address in the web browser address field http booxooxooocxxx XGate Duty Assign
60. umber starting at 1 e Destination text lt ELEMENT_NAME gt lt Xpath expression gt Where ELEMENT NAME Name of the Event element that is sent to the Action handler e a mandatory delimiter that is needed by the event handler configuration 22 December 2010 Ver G 45 Installation and Operation Manual XGate TD 92338GB e Xpath expression an expression that defines which tag values to include in the element value The example translation table d PATIENT NAME Message PSPA Patient Name 2 PATIENT LOCATION Message PSPA Patient Location 3 XML EVENT TYPECODE Message Type Would result in the following event elements e out XGate event Event elements 1 Name PATIENT NAME e out XGate event Event elements 1 Value Miss Pippi Langkous e out XGate event Event elements 2 Name PATIENT LOCATION e out XGate event Event elements 2 Value First aid R1 S4 e out XGate event Event elements 3 Name XML EVENT TYPECODE e out XGate event Event elements 3 Value PSPA Note The left row of the translation table must be incrementing starting at 1 It is mandatory for the Event Handler configuration to work properly The XML syntax in received data must be correct for the template to work If the received data includes non XML data it must first be removed E 1 2 Consideration e XGate supports the XML Path Language XPath 1 0 from Nov 16 1999 see www w3 org TR xpath for a specification 22 Dece

92338-vG XGate IOM

Contents

Download Pdf Manuals

Related Search

Related Contents