STANDARD DATA DICTIONARY #771 -- HL7 APPLICATION PARAMETER FILE 3/24/25 PAGE 1
STORED IN ^HL(771, (266 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.6)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains a list of Vista applications that are capable of sending and receiving HL7 transmissions.
IDENTIFIED BY:
"W": W " ",@("$P($P($C(59)_$S($D(^DD(771,2,0)):$P(^(0),U,3),1:0)_$E("_DIC_"Y,0),0),$C(59)_$P(^(0),U,2)_"":"",2),$C(59),
1)")
POINTED TO BY: SENDING APPLICATION field (#.06) of the ADT/HL7 TRANSMISSION File (#39.4)
REPORT VERIFIED BY COTS APP field (#9.3) of the RAD/NUC MED REPORTS File (#74)
HL7 RECEIVING APPLICATION field (#.01) of the HL7 RECEIVING APPLICATIONS sub-field (#79.02) of the RAD/NUC MED
DIVISION File (#79)
SENDING APPLICATION field (#.02) of the HL7 Message Exceptions File File (#79.3)
HL7 APPLICATION NAME field (#.01) of the RAD/NUC MED HL7 APPLICATION EXCEPTION File (#79.7)
SENDING APPLICATION field (#770.1) of the PROTOCOL File (#101)
RECEIVING APPLICATION field (#770.2) of the PROTOCOL File (#101)
HL7 APPLICATION PARAMETER field (#.02) of the ADT/HL7 EVENT REASON File (#391.72)
DHCP APPLICATION field (#8) of the HL7 NON-DHCP APPLICATION PARAMETER File (#770)
RELATED FILE 771 ENTRY field (#12) of the HL7 NON-DHCP APPLICATION PARAMETER File (#770)
APPLICATION field (#.01) of the APPLICATION sub-field (#771.113) of the HL7 FIELD File (#771.1)
SERVER APPLICATION field (#2) of the HL7 MESSAGE TEXT File (#772)
CLIENT APPLICATION field (#3) of the HL7 MESSAGE TEXT File (#772)
SENDING APPLICATION field (#13) of the HL7 MESSAGE ADMINISTRATION File (#773)
RECEIVING APPLICATION field (#14) of the HL7 MESSAGE ADMINISTRATION File (#773)
RECEIVING APPLICATION field (#1) of the DESTINATION sub-field (#774.01) of the SUBSCRIPTION CONTROL File (#774)
SENDING APPLICATIONS? field (#.01) of the SENDING APPLICATIONS? sub-field (#776.53) of the HL7 MONITOR EVENTS
PROFILE File (#776.5)
CROSS
REFERENCED BY: NAME(AC), ACTIVE/INACTIVE(AF), NAME(B)
771,.01 NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>120!($L(X)<3)!'(X'?1P.E) X I $D(X),$D(^HL(771,"B",X)) K X D E
N^DDIOL("Sorry, Application names must be unique.")
LAST EDITED: MAR 02, 2004
HELP-PROMPT: The name of the application that will send/receive HL7 messages (e.g., RADIOLOGY). Vista
application names must be namespaced and unique. Answer must be 3-120 characters in length.
DESCRIPTION: The name of the application that will send/receive HL7 messages (e.g., RADIOLOGY). Vista
application names must be namespaced and unique. Answer must be 3-120 characters in length.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 771^B
1)= S ^HL(771,"B",$E(X,1,30),DA)=""
2)= K ^HL(771,"B",$E(X,1,30),DA)
Regular 'B' cross reference.
CROSS-REFERENCE: 771^AC^MUMPS
1)= S:$P(^HL(771,DA,0),"^",2)]"" ^HL(771,"AF",X,$P(^(0),"^",2),DA)=""
2)= K:$P(^HL(771,DA,0),"^",2)]"" ^HL(771,"AF",X,$P(^(0),"^",2),DA)
This cross reference is used in conjunction with the 'AF' cross reference on the Active/Inactive
field (#2) to determine whether a specific Application is active.
771,2 ACTIVE/INACTIVE 0;2 SET
'a' FOR ACTIVE;
'i' FOR INACTIVE;
LAST EDITED: SEP 25, 1991
HELP-PROMPT: This field indicates whether the DHCP application is currently active. A DHCP application should
be inactivated when application updates are taking place.
DESCRIPTION: This field indicates whether the DHCP application is currently active. A DHCP application should
be inactivated when application updates are taking place.
The HL7 package will not accept messages from an inactive SENDING APPLICATION. An error will be
returned from the call to GENERATE^HLMA. Also, it will not hand off inbound messages to an
inactive RECEIVING APPLICATION. An error status will be logged.
CROSS-REFERENCE: 771^AF^MUMPS
1)= S ^HL(771,"AF",$P(^HL(771,DA,0),"^"),X,DA)=""
2)= K ^HL(771,"AF",$P(^HL(771,DA,0),"^"),X,DA)
This cross reference is used in conjunction with the 'AC' cross reference on the Name field (#.01)
to determine whether a specific DHCP Application is active.
771,3 FACILITY NAME 0;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>80!($L(X)<1) X
LAST EDITED: MAR 02, 2004
HELP-PROMPT: Answer must be 1-80 characters in length
DESCRIPTION: This information will be placed in the FACILITY ID field of the HL7 message header if present. This
information will override the default facility id information whenever the FACILITY ID REQUIRED
field of the subscriber protocol is set to YES.
771,4 MAIL GROUP 0;4 POINTER TO MAIL GROUP FILE (#3.8)
LAST EDITED: JUL 08, 1994
HELP-PROMPT: The mail group related to this application to which notifications will be sent should problems
arise with delivering messages.
DESCRIPTION: Vista applications may use this field to generate Mailman notifications when messaging problems are
detected. To retrieve this mailgroup, see documentation for the API, GETAPP^HLCS2.
771,5 *HL7 SEGMENT SEG;0 POINTER Multiple #771.05
LAST EDITED: JUL 07, 1999
DESCRIPTION: This is applicable to HL7 v1.5 interfaces only. Enter the HL7 segments used by the Vista
application.
771.05,.01 HL7 SEGMENT 0;1 POINTER TO HL7 SEGMENT TYPE FILE (#771.3) (Required) (Multiply asked)
LAST EDITED: FEB 19, 1993
HELP-PROMPT: The HL7 segments used by the DHCP application.
DESCRIPTION:
The HL7 segments used by the DHCP application.
CROSS-REFERENCE: 771.05^B
1)= S ^HL(771,DA(1),"SEG","B",$E(X,1,30),DA)=""
2)= K ^HL(771,DA(1),"SEG","B",$E(X,1,30),DA)
Regular 'B' cross reference.
771.05,2 FIELDS USED IN THIS SEGMENT F;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>245!($L(X)<1) X
LAST EDITED: AUG 18, 1991
HELP-PROMPT: A list of the HL7 field numbers used by the DHCP application in an HL7 segment. Each field
number is separated by a comma (e.g., 1,3,7,8,9,10). Answer must be 1-245 characters in length.
DESCRIPTION: A list of the HL7 field numbers used by the DHCP application in an HL7 segment. Each field
number is separated by a comma (e.g., 1,3,7,8,9,10).
771,6 *HL7 MESSAGE MSG;0 POINTER Multiple #771.06
LAST EDITED: JUL 07, 1999
DESCRIPTION: This is applicable only to HL7 v1.5 interfaces. Enter the HL7 messages used by the DHCP
application.
771.06,.01 HL7 MESSAGE 0;1 POINTER TO HL7 MESSAGE TYPE FILE (#771.2) (Required) (Multiply asked)
LAST EDITED: FEB 19, 1993
HELP-PROMPT: The HL7 messages used by the DHCP application.
DESCRIPTION:
The HL7 messages used by the DHCP application.
CROSS-REFERENCE: 771.06^B
1)= S ^HL(771,DA(1),"MSG","B",$E(X,1,30),DA)=""
2)= K ^HL(771,DA(1),"MSG","B",$E(X,1,30),DA)
Regular 'B' cross reference.
771.06,1 PROCESSING ROUTINE R;E1,17 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>17!($L(X)<1) X
LAST EDITED: SEP 08, 1991
HELP-PROMPT: The processing routine that will be run for the DHCP application to file the data received in the
HL7 message. Valid entries are routine name, entry point and routine name or the word NONE.
DESCRIPTION: The processing routine that will be run for the DHCP application to process the data received in
the HL7 message. Enter the routine name or an entry point and routine name or the literal NONE
(e.g., ^HL7O or EN1^HL7O).
771,7 COUNTRY CODE 0;7 POINTER TO COUNTRY CODE FILE (#779.004)
LAST EDITED: SEP 28, 1994
HELP-PROMPT: The country code applicable to this application.
DESCRIPTION:
Enter the country code associated with this application.
771,100 HL7 FIELD SEPARATOR FS;E1,2 FREE TEXT
INPUT TRANSFORM: K:$L(X)>1!($L(X)<1)!'(X?1P) X S HLEC=$G(^HL(771,DA,"EC")) I HLEC]"",HLEC[X K X
LAST EDITED: APR 18, 2000
HELP-PROMPT: The HL7 field separator used by the DHCP application. If this field is not filled in, the uparrow
(^) character is defaulted to as the field separator. Answer must be 1 character in length.
DESCRIPTION: The field separator separates two adjacent fields within a segment. It also separates the segment
ID from the first data field in the segment. The field separator can be defined differently for
each HL7 message. The fourth character in the MSH segment serves as the field separator for all
segments in the HL7 message.
If this field is left blank, the default will be the '^' character. However, most messaging
applications use the '|' as a field separator.
Note that the character used as a field separator CANNOT be reused as one of the HL7 ENCODING
CHARACTERS. If you choose the default '^' as a field separator then choose the default encoding
characters as well (~|\&). If you choose the vertical bar as a field separator, then simply replace
the vertical bar in the encoding characters with the '^', i.e., ~^\&. Due to Fileman limitations,
the '^' cannot be the first character in the encoding character string.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
771,101 HL7 ENCODING CHARACTERS EC;E1,4 FREE TEXT
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1)!'(X?1.4P) X S HLFS=$G(^HL(771,DA,"FS")) S:HLFS="" HLFS="^" I X[HLFS K X
LAST EDITED: APR 18, 2000
HELP-PROMPT: The HL7 encoding characters used by the DHCP application. If this field is not filled in, the
characters ~|\& are used as the default encoding characters. Answer must be 1-4 characters in
length.
DESCRIPTION: If this field is left blank, the default encoding characters will be set to, "~|\&". Note that if
you choose this default, the FIELD SEPARATOR must be set to "^". If you choose the vertical bar ("
|") as a field separator, enter "~^\&" as your encoding characters. This will avoid a potential
conflict with VA Fileman.
Up to four encoding characters may be defined. Each encoding character must be unique and none of
the encoding characters may be the same as the field separator character. Each encoding character
serves a specific purpose.
The first encoding character is the component separator. Some data fields may be divided into
multiple components. The component separator is used to separate adjacent components within a data
field.
The second encoding character is the repetition separator. Some data fields may be repeated
multiple times in a segment. The repetition separator character is used to separate multiple
occurrences of a field.
The third encoding character is the escape character. Data fields defined as text or formatted
text may include escape sequences. The escape character is used to separate escape sequences from
the actual text.
The fourth encoding character is the sub-component separator. Some data fields may be divided into
components, and each component may be further divided into sub-components. The sub-component
separator is used to separate adjacent sub-components within a component of a field.
Note that the character used as a field separator CANNOT be reused as one of the HL7 ENCODING
CHARACTERS. If you choose the default '^' as a field separator then choose the default encoding
characters as well (~|\&). If you choose the vertical bar as a field separator, then simply replace
the vertical bar in the encoding characters with the '^', i.e., ~^\&. Due to Fileman limitations,
the '^' cannot be the first character in the encoding character string.
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
FILES POINTED TO FIELDS
COUNTRY CODE (#779.004) COUNTRY CODE (#7)
HL7 MESSAGE TYPE (#771.2) *HL7 MESSAGE:HL7 MESSAGE (#.01)
HL7 SEGMENT TYPE (#771.3) *HL7 SEGMENT:HL7 SEGMENT (#.01)
MAIL GROUP (#3.8) MAIL GROUP (#4)
INPUT TEMPLATE(S):
HL 1.6 APPLICATION PARAM EDIT NOV 21, 1994@08:50 USER #0
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):
HL7 APP JUL 01, 1999@15:04 USER #0
HL7 APP BLK1 DD #771