| # | Name | Location | Type | Details | Index | Description |
|---|---|---|---|---|---|---|
| .01 | node(+) | 0;1 | FREE TEXT | B | This is the name of the logical link that data will be communicated on. It is this name that will be displayed in the "NODE" column of the SYSTEMS LINK MONITOR display option. It is suggested that this name be the same name as the commercial application e.g. KURZWEIL1,KURZWEIL2,COPATH, or SUNQUEST1. | |
| .02 | institution | 0;2 | POINTER | 4 | C | It may be necessary for an application to determine the appropriate link to use when the only information it has is the institution. This field is used to associate a link with that institution. There is a 1:1 correspondence between institution and logical link. An institution cannot be associated with more than one logical link. |
| .03 | mailman domain | 0;7 | POINTER | 4.2 | D | Either this field or the OTHER DOMAIN field should have a value. The domain is used to formulate the RECEIVING FACILITY field of the message header. |
| .08 | dns domain | 0;8 | FREE TEXT | The domain name as registered with DNS. | ||
| 1 | description | 3;0 | WORD-PROCESSING | This field contains a brief explanation of this link. | ||
| 2 | llp type(+) | 0;3 | POINTER | 869.1 | ALLP | Enter the type of Lower Level Protocol for this logical link. Selection of TCP implies that the MLLP protocol will be used. Each of the supported LLP's are described in detail in Appendix C of the HL7 Implementation Guide. |
| 3 | device type | 0;4 | SET OF CODES | PC:Persistent Client NC:Non-Persistent Client SS:Single-threaded Server MS:Multi-threaded Server SH:Serial HLLP SX:Serial X3.28 MM:MailMan | This field is not editable from any user option. It is used purely for display purposes in the DEVICE TYPE column of the SYSTEMS LINK MONITOR display option. | |
| 4 | state | 0;5 | FREE TEXT | This field is not editable from any user option. It is used purely for display purposes in the STATE column of the SYSTEMS LINK MONITOR display option. | ||
| 4.5 | autostart | 0;6 | SET OF CODES | 0:Disabled 1:Enabled | This field permits the link to be restarted by Taskman after a system reboot. If disabled, the link will not be restarted. | |
| 4.9 | stop processing in-queue | 0;9 | BOOLEAN | 0:NO 1:YES | Setting this field to 'Y' prevents the incoming filer from processing the incoming messages queued in this link. | |
| 5 | in queue front pointer | IN QUEUE FRONT POINTER;1 | NUMERIC | The queue structure relies on two queues, INcoming and OUTgoing. This pointer is used to point to the first message in the FIFO queue. | ||
| 6 | in queue back pointer | IN QUEUE BACK POINTER;1 | NUMERIC | The queue structure relies on two queues-INcoming and OUTgoing. This pointer points to the last message in the FIFO queue. | ||
| 7 | out queue front pointer | OUT QUEUE FRONT POINTER;1 | NUMERIC | The queue structure relies on two queues-INcoming and OUTgoing. This pointer points to the first message in the FIFO queue. | ||
| 8 | out queue back pointer | OUT QUEUE BACK POINTER;1 | NUMERIC | The queue structure relies on two queues, INcoming and OUTgoing. This pointer points to the last message in the FIFO queue. | ||
| 9 | time started | 0;10 | DATE-TIME | This field contains the Date/Time the Lower Layer Protocol was last launched for the Logical Link. Only applicable to Lower Layer Protocols, not Mailman. | ||
| 10 | time stopped | 0;11 | DATE-TIME | This field contains the Date/Time the Lower Layer Protocol was last shutdown for the Logical Link. Only applicable to Lower Layer Protocols, not Mailman. | ||
| 11 | task number | 0;12 | NUMERIC | This is the task number assigned by TaskMan when the Lower Layer Protocol is launched in the background. | ||
| 14 | shutdown llp ? | 0;15 | BOOLEAN | 0:NO 1:YES | This field is editable through the STOP HYBRID LLP option. When the Lower Layer Protocol is running, and this field is set to 'Y' the Lower Layer Protocol will shutdown and close the device. | |
| 16 | shutdown outgoing hlo messages | 0;16 | BOOLEAN | 0:NO 1:YES | This field affects only HLO messages. | |
| 18 | gross communications error | 0;19 | POINTER | 771.7 | This field contains the most recent gross communications error. It serves a two purposes. It is a flag for the SYSTEMS LINK MONITOR. In other words, if this field is defined it means a communications error has occured on the link. This is indicated by the NODE field flashing on the SYSTEMS LINK MONITOR. The error can be viewed by using the SHOW COMMUNICATION ERROR option. The error can be cleared by using the CLEAR COMMUNICATION ERROR option. If set, an error occurred while transmitting (timeout for example). This field can be viewed using the 'Show Gross LLP Error' and cleared using the 'Clear Gross LLP Error' options. | |
| 19 | in queue | 1;0 | MULTIPLE | 870.019 | This multiple contains the queue for incoming messages. | |
| 20 | out queue | 2;0 | MULTIPLE | 870.01 | This multiple contains the queue for outgoing messages. | |
| 21 | queue size | 0;21 | NUMERIC | This is the steady-state size of the queue. The queue may dynamically grow beyond this size, under certain conditions. See Users Manual, for more information. | ||
| 22 | retention time queued stub rcd | 0;22 | NUMERIC | The field represents the time in minutes for how long a stub record must remain as such before that record is changed to a unused status. The default time is 10 minutes. This field is compared to DATE/TIME STUB RCD FOUND. If the time elapsed since the DATE/TIME STUB RCD FOUND is greater than the number of minutes found in this field, then the STATUS (870.019,1) is changed to unused if it is an incoming message. If it is an outgoing message then the STATUS (870.01,1) is changed to unused. | ||
| 23 | single threaded | 0;23 | BOOLEAN | 1:YES 0:NO | HLO provides the ability to setup multiple queues of outgoing messages to be transmitted over the same HL LOGICAL LINK. However, if the remote server is single threaded, trying to open multiple connections over TCP/IP may cause problems. Therefore, if the HL LOGICAL LINK is setup to communicate with a single threaded server, this field should be set to YES. Currently, only HLO messaging honors this field. The older HL7 1.6 VistA messaging software does not support multiple outgoing queues to be transmitted over the same HL LOGICAL LINK. | |
| 24 | do not ping | 0;24 | BOOLEAN | 0:NO 1:YES | This field, if set to YES, will prevent the link from being PINGED. | |
| 100.01 | mail group | 100;1 | POINTER | 3.8 | If you are building a logical link that will use Mailman as a transport, you must define a mail group that contains the remote member, S.HL V16 SERVER@your target domain The HL7 package will place outbound messages in file 870's outque. The link must be running for messages to be handed off to Mailman. Inbound messages that are received by the server option are placed directly in file 772. | |
| 200.01 | hllp device | 200;1 | POINTER | 3.5 | This is an entry in the Device file (#3.5). It is opened when this logical link is started up and remains open until the link is shut down. Normally, Vista will initiate and the connection with this serial device. | |
| 200.02 | re-transmission attempts | 200;2 | NUMERIC | Enter the number of times to re-try sending a message. The default is 5 tries if this field is left blank. If a single message exceeds this value an Alert is sent to the HL7 mail group and the link is shutdown. | ||
| 200.021 | exceed re-transmit action | 200;10 | SET OF CODES | I:ignore R:restart S:shutdown | This field determines what to do when a message exceeds the number of retry attempts for this Logical Link. Actions are: Ignore = send alert once and keep trying to resend Restart = send alert once and shutdown link then start link Shutdown = send alert once and shutdown link | |
| 200.022 | close before re-transmission | 200;11 | BOOLEAN | 1:YES | Re-transmitting a message over the same open connection may cause a synchronization problem for some applications. Setting this field to YES will cause the TCP connection to always be closed after a READ timeout or other communication failure. Instead, a new connection will be opened before attempting to re-transmit the message. | |
| 200.03 | block size | 200;3 | NUMERIC | |||
| 200.04 | read timeout | 200;4 | NUMERIC | Enter the number of seconds the Lower Layer Protocol remains in a read state for data to come in on the link. The default is 10 seconds if this field is left blank. | ||
| 200.05 | ack timeout | 200;5 | NUMERIC | The number of seconds the Lower Layer Protocol waits for an acknowledgement from the receiving application. The default is 60. If this field is less than the READ TIMEOUT field, the READ TIMEOUT value will be used. | ||
| 200.06 | llp start block | 200;6 | NUMERIC | Enter the numeric value of the control character used by the HLLP communications protocol as a START BLOCK CHARACTER. While this character is negotiable, the HL7 implementation guide recommends the use of the 'VT' character. If this field is left blank, the default value of 11 will be used. | ||
| 200.07 | llp end block | 200;7 | NUMERIC | Enter the numeric value of the control character defined in the HLLP specification as the END BLOCK CHARACTER. The recommended value is 28. If this field is left blank, the default value will be 28 for the 'FS' character. | ||
| 200.08 | protocol id version | 200;8 | SET OF CODES | 21:2.1 22:2.2 23:2.3 | The latest specification for the HLLP communications protocol is identified by a version number, which may be different from the HL7 standard itself. | |
| 200.09 | uni-directional wait | 200;9 | NUMERIC | The number of seconds the Lower Layer Protocol waits after sending a messages. This is only used if the message doesn't want an acknowledgment. | ||
| 300.01 | x3.28 device | 300;1 | POINTER | 3.5 | X3.28 is a serial protocol like HLLP. It requires the remote system be configured as a device (bi-directional) in the Device and terminal type files. The Vista system will normally open and maintain the connection. See the HL7 Implementation Guide for details of this protocol. | |
| 300.02 | maximum message size | 300;2 | NUMERIC | See the HL7 Implementation Guide for details of the x3.28 protcol. | ||
| 300.03 | maximum block size | 300;3 | NUMERIC | See the HL7 Implementation Guide for details of the x3.28 protcol. | ||
| 300.04 | timer a | 300;4 | NUMERIC | Enter the time in seconds for the Response Timer. The default is 6 seconds if no time is entered. | ||
| 300.05 | timer b | 300;5 | NUMERIC | Enter the time in seconds for the Receive Timer. The default is 3 seconds if no time is entered. | ||
| 300.06 | timer d | 300;6 | NUMERIC | Enter the time for the Inter-Block timer. The default is 30 seconds if no time is specified. | ||
| 300.07 | timer e | 300;7 | NUMERIC | Enter the time for the Line Check Timer. The default is 180 seconds is no time is specified. | ||
| 400.01 | tcp/ip address | 400;1 | FREE TEXT | Enter the IP address of the remote site using the syntax, nn.nn.nn.nn (IPV4) or hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh (IPV6) | ||
| 400.02 | tcp/ip port | 400;2 | NUMERIC | This is the port over which the HL7 service will create a socket for message exchange. In VA, this port will be 5000 between production systems. | ||
| 400.03 | tcp/ip service type | 400;3 | SET OF CODES | C:CLIENT (SENDER) S:SINGLE LISTENER M:MULTI LISTENER | E | This field determines if the Logical Link is the client (sender) or a listener (server) of a message. Choose from: CLIENT (SENDER): Indicates that this Logical Link connects to a target system, with the current system acting as the sender. SINGLE LISTENER: Designates that the current system is a server (listener), using a single M process to do the listening. MULTI LISTENER: Designates that the current system is a server (listener), creating multiple background processes. |
| 400.04 | persistent | 400;4 | BOOLEAN | Y:YES N:NO | Enter 'YES' if this connection needs to remain open even if there are no messages to send. The connection will remain open until it is disconnected by either side via shutting-down the logical link. A setting of 'YES' is appropriate for connecting to a COTS device with a high volume of messages. | |
| 400.05 | retention | 400;5 | NUMERIC | Retention is the maximum time in seconds in which a non-persistent LLP will wait after the associated queue has been emptied. If further messages arrive in the queue before the retention time has expired, the LLP will continue to dequeue and send messages. Otherwise, the LLP will become inactive and will remain inactive until further messages are queued. | ||
| 400.06 | startup node | 400;6 | POINTER | 14.7 | This field is ONLY for VMS sites running Dual Taskman in DCL. This field is used to specify what Taskman node you want to job the Lower Level Protocol. It should only be used if you have two Taskmans running and only want the LLP to run on a particular node. It will only work if you are running the dual Taskmans in DCL context on a VMS system. | |
| 400.07 | say helo | 400;7 | BOOLEAN | Y:YES N:NO | This field is applicable only to Cache/NT sites with TCP links. If you are not a Cache/NT site, or this is not a TCP link, this field does not apply, AND will be ignored. If this TCP link is for a VA site, answer YES. If this TCP link is for a COTS system, answer NO. This is the default. | |
| 400.08 | tcp/ip port (optimized) | 400;8 | NUMERIC | The new HL7 'optimized' server will operate concurrently with the old HL7 1.6 server. To enable that, the two servers are assigned different ports to listen on. The default port for the old HL7 server is 5000, whereas the new optimized HL7 server uses port 5001. | ||
| 400.09 | tcp/ip openfail timeout | 400;9 | NUMERIC | Enter the number of seconds for the TCP/IP Openfail Timeout. The default is 30 seconds if this field is left blank. |