STANDARD DATA DICTIONARY #779.2 -- HLO APPLICATION REGISTRY FILE 3/24/25 PAGE 1
STORED IN ^HLD(779.2, (20 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.6)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file is used to register sending and receiving applications for HL7 messaging. For receiving applications, the process of
registration consists of registering what messages the application is prepared to receive.
For both sending and receiving applications, it is necessary to specify what package the application belongs to. For sending
applications, that is the only field that applies, other than the name of the sending application.
An application can be either a sender or a receiver of messages, or both. In order for an application to receive messages, it must
specify an action (M tag^routine) for each type of message that it is capable of receiving, or a default action that applies when
no messsage-specific action is defined.
PRIMARY KEY: A (#62)
Uniqueness Index: C (#84)
File, Field: 1) APPLICATION NAME (779.2,.01)
CROSS
REFERENCED BY: APPLICATION NAME(B)
INDEXED BY: APPLICATION NAME (C)
779.2,.01 APPLICATION NAME 0;1 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>60!($L(X)<3)!'(X'?1P.E) X
LAST EDITED: NOV 10, 2008
HELP-PROMPT: Answer must be 3-60 characters in length. It must be unique and should be name-spaced.
CROSS-REFERENCE: 779.2^B
1)= S ^HLD(779.2,"B",$E(X,1,60),DA)=""
2)= K ^HLD(779.2,"B",$E(X,1,60),DA)
FIELD INDEX: C (#84) REGULAR IR LOOKUP & SORTING
Unique for: Key A (#62), File #779.2
Short Descr: Uniqueness Index for Key 'A' of File #779.2
Set Logic: S ^HLD(779.2,"C",X,DA)=""
Kill Logic: K ^HLD(779.2,"C",X,DA)
Whole Kill: K ^HLD(779.2,"C")
X(1): APPLICATION NAME (779.2,.01) (Subscr 1)
779.2,.02 RESPONSE LINK (OPTIONAL) 0;2 FREE TEXT
INPUT TRANSFORM: K:'$$CHKLINK^HLOTLNK(X) X
LAST EDITED: NOV 16, 2004
HELP-PROMPT: If the return link cannot be identified via the Sending Facility (i.e., sent via an IE), what link
should the application ack be sent through?
DESCRIPTION: This field applies only if: 1) The receiving application is expected to return application
acknowledgments. 2) The initial message is received indirectly through the IE, and the receiving
application in turn does not want to send the application acknowledgment directly back to the
sending facility identified in the message header.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
779.2,.03 DEFAULT PRIVATE IN-QUEUE 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<3) X
LAST EDITED: MAR 17, 2005
HELP-PROMPT: You may create an optional default private in-queue by entering a unique name up to 20 characters
in length. Queues specified for specific message types take precedence.
779.2,.04 BATCH ACTION TAG 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: AUG 14, 2004
HELP-PROMPT: If the application utilizes batch messages, the action to perform upon receipt of the message
should be entered in the BATCH ACTION TAG and BATCH ACTION ROUTINE fields as ^.
779.2,.05 BATCH ACTION ROUTINE 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<3) X
LAST EDITED: AUG 14, 2004
HELP-PROMPT: If the application utilizes batch messages, the action to perform upon receipt of the message
should be entered in the BATCH ACTION TAG and BATCH ACTION ROUTINE fields as ^.
779.2,.06 DEFAULT ACTION TAG 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: AUG 15, 2004
HELP-PROMPT: You can enter the action to perform upon receipt of a message where no other action applies by
entering the DEFAULT ACTION TAG and DEFAULT ACTION ROUTINE fields as ^.
779.2,.07 DEFAULT ACTION ROUTINE 0;7 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<3) X
LAST EDITED: AUG 14, 2004
HELP-PROMPT: You can enter the action to perform upon receipt of a message where no other action applies by
entering the DEFAULT ACTION TAG and DEFAULT ACTION ROUTINE fields as ^.
779.2,.08 BATCH PRIVATE IN-QUEUE 0;8 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<3) X
LAST EDITED: MAR 17, 2005
HELP-PROMPT: You may establish a private queue for your batch messages by entering a unique name (name-spaced)
up to 20 characters long.
779.2,.09 APPLICATION SPECIFIC LISTENER 0;9 POINTER TO HL LOGICAL LINK FILE (#870)
INPUT TRANSFORM: S DIC("S")="I $P($G(^HLCS(870,Y,400)),""^"",3)'="""",""SM""[$P(^HLCS(870,Y,400),""^"",3)" D ^DIC K
DIC S DIC=$G(DIE),X=+Y K:Y<0 X
LAST EDITED: NOV 20, 2006
HELP-PROMPT: If your application requires its own listener (HIGHLY DISCOURAGED), enter it here.
DESCRIPTION: Applications are highly discouraged from establishing their own listeners. The use of the
multi-listeners provide concurrent processing of many connections over the same port, so a
dedicated listener will not provide an application with a performance boost, while it will cause
the site additional work to maintain. So before establishing a dedicated listener, the application
developer should verify the need.
SCREEN: S DIC("S")="I $P($G(^HLCS(870,Y,400)),""^"",3)'="""",""SM""[$P(^HLCS(870,Y,400),""^"",3)"
EXPLANATION: The link entered must be a listener.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
779.2,.1 SEQUENCE EXCEPTION TAG 0;10 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JUL 05, 2007
HELP-PROMPT: What is the tag to invoke the sequencing exception routine at?
779.2,.11 SEQUENCE EXCEPTION ROUTINE 0;11 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: JUL 05, 2007
HELP-PROMPT: What routine should be invoked when a sequencing exception is encountered?
779.2,.12 SEQUENCING TIMEOUT 0;12 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>9999)!(X<5)!(X?.E1"."1.N) X
LAST EDITED: JUL 26, 2007
HELP-PROMPT: Enter how long to wait for an applicaiton ack used in sequencing before rasing an exception. Enter
between 5 (minutes) and 9999 (minutes).
779.2,.13 MINIMUM RETENTION TIME 0;13 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1.N) X
LAST EDITED: MAR 26, 2012
HELP-PROMPT: How many days should the application's messages be retained after they are processed? Enter a
whole number, 1 to 999.
DESCRIPTION: This field may be used by the application to set the minimum number of days that its messages
should be retained after being processed.
This value applies to the application's messages as a whole, but may be overridden if the
application specifies a value for specific message types.
The site parameter, if set to a longer time, will override the application parameter, whereas a
shorter value will be ignored.
EXECUTABLE HELP: D EN^DDIOL("The retention time may be specified for a specific message type."),EN^DDIOL("If so, it
will override the retention time specified here.")
779.2,1 MESSAGE TYPE ACTIONS 1;0 Multiple #779.21
DESCRIPTION:
IDENTIFIED BY: HL7 EVENT(#.02)[R], HL7 VERSION(#.06)
PRIMARY KEY: A (#63)
Uniqueness Index: C (#89)
File, Field: 1) HL7 MESSAGE TYPE (779.21,.01) 2) HL7 EVENT (779.21,.02)
INDEXED BY: HL7 MESSAGE TYPE & HL7 EVENT (C), HL7 MESSAGE TYPE & HL7 EVENT & HL7 VERSION (D)
779.21,.01 HL7 MESSAGE TYPE 0;1 FREE TEXT (Multiply asked) (Key field)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: DEC 02, 2011
HELP-PROMPT: Enter the 3 character HL7 Message Type.
DESCRIPTION: An application should use this multiple to define the action that the receiving application needs
to perform upon receipt of a specific type of HL7 message, identified by the HL7 MESSAGE TYPE and
HL7 EVENT fields.
CROSS-REFERENCE: 779.21^B
1)= S ^HLD(779.2,DA(1),1,"B",$E(X,1,30),DA)=""
2)= K ^HLD(779.2,DA(1),1,"B",$E(X,1,30),DA)
RECORD INDEXES: C (#89), D (#704)
779.21,.02 HL7 EVENT 0;2 FREE TEXT (Required) (Key field)
INPUT TRANSFORM: K:$L(X)>3!($L(X)<3) X
LAST EDITED: DEC 02, 2011
HELP-PROMPT: Enter the 3 character HL7 event type.
RECORD INDEXES: C (#89), D (#704)
779.21,.03 PRIVATE IN-QUEUE 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<3) X
LAST EDITED: SEP 19, 2005
HELP-PROMPT: You may create a private in-queue for message of this type by entering a unique name up to 20
characters long.
779.21,.04 ACTION TAG 0;4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>8!($L(X)<1) X
LAST EDITED: AUG 15, 2004
HELP-PROMPT: You must enter the action to perform upon receipt of this type by entering the ACTION TAG and
ACTION ROUTINE fields as ^. The tag is optional.
779.21,.05 ACTION ROUTINE 0;5 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>8!($L(X)<3) X
LAST EDITED: SEP 19, 2005
HELP-PROMPT: You must enter the action to perform upon receipt of this type by entering the ACTION TAG and
ACTION ROUTINE fields as ^.
779.21,.06 HL7 VERSION 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>20!($L(X)<1) X
LAST EDITED: DEC 02, 2011
HELP-PROMPT: Leave blank UNLESS this action applies only to a specific version of the message! Enter the
version exactly as it will appear in the message header.
RECORD INDEXES: D (#704)
779.21,.07 INACTIVE 0;7 SET
'1' FOR INACTIVE;
LAST EDITED: JUN 21, 2006
HELP-PROMPT: Enter '1' to stop the application from generating messages of this type.
DESCRIPTION: This flag is made available to the application, but it is up to the application to honor it. In
otherwords, its up to the application to check the flag and decide whether or not to generate
messages of this type.
779.21,.08 MINIMUM RETENTION TIME 0;8 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<1)!(X?.E1"."1.N) X
LAST EDITED: MAR 26, 2012
HELP-PROMPT: Enter the number of days to retain messages of this type after they are processed. Enter a whole
number, 1 to 999.
DESCRIPTION: This field may be set by the application to specify how many days this type of message should be
retained before purging.
EXECUTABLE HELP:D EN^DDIOL("The retention time specified here will override the value specified for the"),EN^DDIOL(
"overall application.")
779.2,2 Package File Link 2;1 POINTER TO PACKAGE FILE (#9.4) (Required)
LAST EDITED: SEP 19, 2005
HELP-PROMPT: Enter the package responsible for these messages.
DESCRIPTION: This field holds a pointer to the Package File for the Package responsible for these messages.
FILES POINTED TO FIELDS
HL LOGICAL LINK (#870) APPLICATION SPECIFIC LISTENER (#.09)
PACKAGE (#9.4) Package File Link (#2)
Subfile #779.21
Record Indexes:
C (#89) RECORD MUMPS IR LOOKUP & SORTING
Unique for: Key A (#63), File #779.21
Short Descr: action by message type& event,with version not specified
Description: This index is used to find the application action by message type and event in cases where the application has
chosen NOT to also specify the action according to the HL7 version.
Set Logic: S:$P(^HLD(779.2,DA(1),1,DA,0),"^",6)="" ^HLD(779.2,DA(1),1,"C",X(1),X(2),DA)=""
Kill Logic: K ^HLD(779.2,DA(1),1,"C",X(1),X(2),DA)
Whole Kill: K ^HLD(779.2,DA(1),1,"C")
X(1): HL7 MESSAGE TYPE (779.21,.01) (Subscr 1)
X(2): HL7 EVENT (779.21,.02) (Subscr 2) (forwards)
D (#704) RECORD MUMPS IR LOOKUP & SORTING
Short Descr: lookup message type including version
Set Logic: S ^HLD(779.2,DA(1),1,"D",X(1),X(2),X(3),DA)="" K ^HLD(779.2,DA(1),1,"C",X2(1),X2(2),DA)
Kill Logic: K ^HLD(779.2,DA(1),1,"D",X(1),X(2),X(3),DA) S:((X1(1)=X2(1))&(X1(2)=X2(2))&(X2(3)="")) ^HLD(779.2,DA(1),1,"C",
X2(1),X2(2),DA)=""
Whole Kill: K ^HLD(779.2,DA(1),1,"D")
X(1): HL7 MESSAGE TYPE (779.21,.01) (Subscr 1) (Len 30) (forwards)
X(2): HL7 EVENT (779.21,.02) (Subscr 2) (Len 30) (forwards)
X(3): HL7 VERSION (779.21,.06) (Subscr 3) (Len 30) (forwards)
INPUT TEMPLATE(S):
HLO DEACTIVATE OUT MSG MAR 20, 2009@12:26 USER #0
HLO EDIT RECEIVING APPLICATIONMAR 27, 2009@12:41 USER #0
HLO EDIT SENDING APPLICATION MAR 27, 2009@12:43 USER #0
HLO RETENTION TIME FEB 22, 2012@12:18 USER #0
HLOAPREG JUL 09, 2007@10:29 USER #0
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):