STANDARD DATA DICTIONARY #869.3 -- HL COMMUNICATION SERVER PARAMETERS FILE 3/24/25 PAGE 1
STORED IN ^HLCS(869.3, (1 ENTRY) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.6)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
Parameter file used by the HL7 Communication Server
CROSS
REFERENCED BY: ONE(B)
869.3,.01 ONE 0;1 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>1)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 15, 1995
HELP-PROMPT: Enter the number 1 (only one entry is allowed)
DESCRIPTION:
Stub field used to create one [and only one] entry
CROSS-REFERENCE: 869.3^B
1)= S ^HLCS(869.3,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,"B",$E(X,1,30),DA)
869.3,.02 DOMAIN 0;2 POINTER TO DOMAIN FILE (#4.2)
LAST EDITED: APR 27, 1998
HELP-PROMPT: Enter the Domain Name of this environment
DESCRIPTION: The domain name for this environment must be unique to all environments running at your site. For
example, if your production domain is SITE.DOMAIN.EXT and this is your test system, you must have
an entry in your domain file that is different such as TEST.SITE.DOMAIN.EXT.
869.3,.03 DEFAULT PROCESSING ID 0;3 SET (Required)
'P' FOR production;
'T' FOR training;
LAST EDITED: DEC 07, 1999
HELP-PROMPT: Enter the default PROCESSING ID for this account.
DESCRIPTION: What type of environment is this account? The messaging system will not permit messages to be sent
from one type of environment to a different type. The third Processing ID used by HL7 is DEBUG.
This mode must be defined on the EVENT DRIVER protocol on both the sending and receiving systems.
An error will be logged when the PID for an inbound message is inappropriate for the receiving
system.
Note: Ideally, TRAINING and PRODUCTION designations are maintained in separate accounts.
Application processing routines should be aware of the PID field when processing a message.
Routines designed for a production environment will probably want to process messages differently
when TRAINING or DEBUG mode is set.
869.3,.04 INSTITUTION 0;4 POINTER TO INSTITUTION FILE (#4)
LAST EDITED: APR 28, 1998
DESCRIPTION: This entry will be used in the sending facility field of HL7 message headers unless the application
overrides this function by defining a facility in the Application Parameter file.
869.3,.05 MAIL GROUP 0;5 POINTER TO MAIL GROUP FILE (#3.8)
LAST EDITED: APR 30, 1998
HELP-PROMPT: To be used for alerts and notifications
DESCRIPTION: This mail group should contain local IRM staff responsible for monitoring the messaging system.
This group will be used for delivery of alerts or notification of significant events related to
Messaging System operations.
869.3,11 DEFAULT NUMBER INCOMING FILERS 1;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 15, 1995
HELP-PROMPT: Enter the default number of incoming filers
DESCRIPTION:
This is the default number of background filers that will be started
869.3,12 DEFAULT NUMBER OUTGOING FILERS 1;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 22, 1995
HELP-PROMPT: Enter the default number of outgoing filers
DESCRIPTION:
This is the default number of outgoing filers that will be started
869.3,20 INCOMING FILER TASK NUMBER 2;0 Multiple #869.32
869.32,.01 INCOMING FILER TASK NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999999999999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 15, 1995
HELP-PROMPT: Enter the task number of an incoming filer
DESCRIPTION:
This is the task number of an incoming filer
CROSS-REFERENCE: 869.32^B
1)= S ^HLCS(869.3,DA(1),2,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),2,"B",$E(X,1,30),DA)
869.32,.02 STOP FILER 0;2 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAY 15, 1995
HELP-PROMPT: Enter YES if this filer should be stopped
DESCRIPTION:
Flag indicating if the incoming filer associated with this entry should stop
869.32,.03 LAST KNOWN $H 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>13!($L(X)<1)!'(X?1.7N1","1.5N) X
LAST EDITED: MAY 22, 1995
HELP-PROMPT: Enter a value for $H
DESCRIPTION:
This is the last value of $H that the incoming filer associated with this entry recognized
869.3,30 OUTGOING FILER TASK NUMBER 3;0 Multiple #869.33
869.33,.01 OUTGOING FILER TASK NUMBER 0;1 NUMBER (Multiply asked)
INPUT TRANSFORM: K:+X'=X!(X>999999999999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAY 16, 1995
HELP-PROMPT: Enter the task number of an outgoing filer
DESCRIPTION:
This is the task number of an outgoing filer
CROSS-REFERENCE: 869.33^B
1)= S ^HLCS(869.3,DA(1),3,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),3,"B",$E(X,1,30),DA)
869.33,.02 STOP FILER 0;2 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: MAY 16, 1995
HELP-PROMPT: Enter YES if this filer should be stopped
DESCRIPTION:
Flag indicating if the outgoing filer associated with this entry should stop
869.33,.03 LAST KNOWN $H 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>13!($L(X)<1)!'(X?1.7N1","1.5N) X
LAST EDITED: MAY 22, 1995
HELP-PROMPT: Enter a value for $H
DESCRIPTION:
This is the last value of $H that the outgoing filer associated with this entry recognized
869.3,41 PURGE COMPLETED MESSAGES 4;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>300)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 04, 1999
HELP-PROMPT: Type a Number to represent the days kept for "Successfully Completed" messages. The default number
of days is 7.
DESCRIPTION: The number of days "Successfully Completed" messages are retained before they are purged. If no
value is entered, the default is 7 days. Used as the actual value when the "Purge Messages" option
is scheduled through TaskMan, and as the default when run interactively.
869.3,42 PURGE AWAITING ACK MESSAGES 4;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>300)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 04, 1999
HELP-PROMPT: Type a Number representing the days kept for "AWAITING APPLICATION ACKNOWLEDGEMENT" messages. The
default number of days is 30.
DESCRIPTION: The number of days "Awaiting Application Acknowledgement" messages are retained before they are
purged. If no value is entered, the default is 30 days. Used as the actual value when the "Purge
Messages" option is scheduled through TaskMan, and as the default when run interactively.
869.3,43 PURGE ALL MESSAGES 4;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>300)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: MAR 04, 1999
HELP-PROMPT: Type a Number representing the days kept for all messages regardless of status(except for ERROR
status messages). The default number of days is 90.
DESCRIPTION: The number of days that any status message are retained before they are purged(except for ERROR
status messages). If no value is entered, the default is 90 days. Used as the actual value when
the "Purge Messages" option is scheduled through TaskMan, and as the default when run
interactively.
869.3,44 PURGE ERROR STATUS MESSAGES 4;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: FEB 10, 2003
HELP-PROMPT: Type a Number to represent the days to keep error status messages messages. The default number of
days is 90.
DESCRIPTION: The number of days error status messages are retained before they are purged. 90 days is used as
the actual value when the "Purge Messages" option is scheduled through TaskMan, and as the default
when run interactively.
869.3,51 DEFAULT RETENTION 5;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: JUN 01, 1999
HELP-PROMPT: Type a Number between 0 and 999999, 0 Decimal Digits
DESCRIPTION: Used by the TCP/IP Link Manager. The maximum time, in seconds, in which the process supporting a
non-persistent TCP/IP client logical link will wait for new messages before terminating. Upon
expiration of the retention time, the process will terminate, and the logical link will become
inactive and remain inactive until further messages are queued.
The value entered here is the DEFAULT RETENTION time. This value will be used if the RETENTION
field (#400.05) in the HL LOWER LEVEL PROTOCOL PARAMETER file (#869.2) is not valued for a given
LLP.
If no value has been entered in both DEFAULT RETENTION and RETENTION fields for a given
non-persistent LLP, a default time of 15 seconds will be used as the retention time.
869.3,52 LINK MANAGER TASK NUMBER 5;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JUN 14, 1999
HELP-PROMPT: Type a Number between 1 and 999999999999999, 0 Decimal Digits
DESCRIPTION: This field is internally edited by the Link Manager. When the Link Manager starts, this field is
updated with the value of the Link Manager's task number.
869.3,53 STOP LINK MANAGER 5;3 SET
'0' FOR NO;
'1' FOR YES;
LAST EDITED: JUN 14, 1999
HELP-PROMPT: Enter YES if the Link Manager should be stopped
DESCRIPTION: Flag indicating whether the Link Manager should be stopped. This field is updated by the TCP/IP
Link Manager as well as through the TCP/IP Link Manager Start/Stop option. Use this option rather
than directly editing this field to start/stop the TCP/IP Link Manager.
869.3,54 LM LAST KNOWN $H 5;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>13!($L(X)<1)!'(X?1.7N1","1.5N) X
LAST EDITED: JUL 06, 1999
HELP-PROMPT: Answer must be 1-13 characters in length.
DESCRIPTION: This field is updated periodically by the Link Manager with the $Horolog value at the time of the
update. The Systems Link Monitor uses this information along with the LINK MANAGER TASK NUMBER to
determine whether the Link Manager is running. Therefore, the use of this field should be
restricted for internal use only and should not edited.
869.3,60 LINK MONITOR VIEWS 6;0 Multiple #869.31
LAST EDITED: MAY 30, 2000
DESCRIPTION: Use this multiple to define VIEWS that can be used in the System Link Monitor option. A VIEW is a
list of Logical Links to display in the System Link Monitor.
869.31,.01 LINK MONITOR VIEWS 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>20!($L(X)<3) X
LAST EDITED: JUN 01, 2000
HELP-PROMPT: Answer must be 3-20 characters in length
DESCRIPTION:
This multiple contains views of Logicial Links to be used with the System Link Monitor.
CROSS-REFERENCE: 869.31^B
1)= S ^HLCS(869.3,DA(1),6,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),6,"B",$E(X,1,30),DA)
869.31,1 LOGICAL LINK 1;0 POINTER Multiple #869.311 (Add New Entry without Asking)
869.311,.01 LOGICAL LINK 0;1 POINTER TO HL LOGICAL LINK FILE (#870) (Required) (Multiply asked)
INPUT TRANSFORM: S DINUM=+X
LAST EDITED: MAY 30, 2000
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 869.311^B
1)= S ^HLCS(869.3,DA(2),6,DA(1),1,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(2),6,DA(1),1,"B",$E(X,1,30),DA)
869.311,1 DISPLAY ORDER 0;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<1)!(X?.E1"."2N.N) X
LAST EDITED: MAY 30, 2000
HELP-PROMPT: Type a Number between 1 and 99, 1 Decimal Digit
DESCRIPTION:
This field determines the order to display the Logical Links in the System Link Monitor.
869.3,70 PING IP 7;0 Multiple #869.34
LAST EDITED: JAN 30, 2007
869.34,.01 PING IP 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<7) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple IP addresses may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter the IP address which is allowed to "ping," using the "Ping (TCP Only)"
option, for pinging Vista site with Vista HL7 installed. Multiple IP addresses may be entered,
separated by "," as delimiter.
It is not necessary to enter an IP address here for a link with a domain containing the partial
domain which has been entered in the "PING DOMAIN (PARTIAL)" multiple.
CROSS-REFERENCE: 869.34^B
1)= S ^HLCS(869.3,DA(1),7,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),7,"B",$E(X,1,30),DA)
869.3,80 PING DOMAIN (PARTIAL) 8;0 Multiple #869.35
LAST EDITED: JAN 30, 2007
869.35,.01 PING DOMAIN (PARTIAL) 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<7) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple partial or full domain names may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter the partial or full domain name, such as "DOMAIN.EXT" which is allowed
to "ping," using the "Ping (TCP Only)" option, for pinging Vista site with Vista HL7 installed.
Multiple partial or full domain names may be entered, separated by "," as delimiter.
CROSS-REFERENCE: 869.35^B
1)= S ^HLCS(869.3,DA(1),8,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),8,"B",$E(X,1,30),DA)
869.3,90 DON'T PING PORT 9;0 Multiple #869.36
869.36,.01 DON'T PING PORT 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<1) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple port numbers may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter the port number, for those links which are not allowed to "ping,"
using the "Ping (TCP Only)" option.
Multiple port numbers may be entered, separated by "," as delimiter.
CROSS-REFERENCE: 869.36^B
1)= S ^HLCS(869.3,DA(1),9,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),9,"B",$E(X,1,30),DA)
869.3,91 DON'T PING LINK NAME (PARTIAL) 10;0 Multiple #869.391
LAST EDITED: JAN 30, 2007
869.391,.01 DON'T PING LINK NAME (PARTIAL) 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<3) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple partial or full link names may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter the partial or full link name, for those links which are not allowed
to "ping," using the "Ping (TCP Only)" option.
Multiple partial or full link names may be entered, separated by "," as delimiter.
CROSS-REFERENCE: 869.391^B
1)= S ^HLCS(869.3,DA(1),10,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),10,"B",$E(X,1,30),DA)
869.3,92 DON'T PING IP 11;0 Multiple #869.392
869.392,.01 DON'T PING IP 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<7) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple IP addresses may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter the IP address, for those links which are not allowed to "ping," using
the "Ping (TCP Only)" option.
Multiple IP addresses may be entered, separated by "," as delimiter.
CROSS-REFERENCE: 869.392^B
1)= S ^HLCS(869.3,DA(1),11,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),11,"B",$E(X,1,30),DA)
869.3,93 DON'T PING DOMAIN (FULL) 12;0 Multiple #869.393
869.393,.01 DON'T PING DOMAIN (FULL) 0;1 FREE TEXT (Multiply asked)
INPUT TRANSFORM: K:$L(X)>240!($L(X)<7) X
LAST EDITED: JAN 30, 2007
HELP-PROMPT: Multiple full domain names may be entered, separated by "," as delimiter.
DESCRIPTION: Use this multiple to enter full domain name, for those links which are not allowed to "ping,"
using the "Ping (TCP Only)" option.
Multiple full domain names may be entered, separated by "," as delimiter.
CROSS-REFERENCE: 869.393^B
1)= S ^HLCS(869.3,DA(1),12,"B",$E(X,1,30),DA)=""
2)= K ^HLCS(869.3,DA(1),12,"B",$E(X,1,30),DA)
869.3,772 LAST IEN, FILE 772 772;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999999999999999)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: FEB 24, 2009
HELP-PROMPT: THIS FIELD CAN'T BE ALTERED.
DESCRIPTION: This field holds an IEN, which can be a whole number up to 19 digits. This field is used by HL7
process to create and store the IEN for file #772. It can't be altered. Otherwise, it may cause
serious problem to the message transaction when HL7 process is running.
UNEDITABLE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
869.3,773 LAST IEN, FILE 773 773;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999999999999999999)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: FEB 24, 2009
HELP-PROMPT: THIS FIELD CAN'T BE ALTERED.
DESCRIPTION: This field holds an IEN, which can be a whole number up to 19 digits. This field is used by HL7
process to create and store the IEN for file #773. It can't be altered. Otherwise, it may cause
serious problem to the message transaction when HL7 process is running.
UNEDITABLE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
FILES POINTED TO FIELDS
DOMAIN (#4.2) DOMAIN (#.02)
HL LOGICAL LINK (#870) LOGICAL LINK:LOGICAL LINK (#.01)
INSTITUTION (#4) INSTITUTION (#.04)
MAIL GROUP (#3.8) MAIL GROUP (#.05)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):
HL SITE PARAMETERS APR 30, 1998@10:06 USER #0
HL SITE PARAM HEAD DD #869.3
HL SITE PARAM DATA DD #869.3
HL SITE PARAM VIEWS DD #869.31
HL VIEW POPUP DD #869.31
HL VIEW MULTIPLE DD #869.311
HL SITE PARAM PAGE 2 DD #869.3