STANDARD DATA DICTIONARY #772 -- HL7 MESSAGE TEXT FILE 6/27/25 PAGE 1
STORED IN ^HL(772, SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.6)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file contains information related to the processing of all incoming and outgoing messages.
IDENTIFIED BY: SERVER APPLICATION (#2)[R]
POINTED TO BY: 772 POINTER field (#17) of the PADE OUTBOUND MESSAGES File (#58.72)
HL7 MESSAGE field (#.04) of the EVENT HISTORY sub-field (#375.099) of the PFSS ACCOUNT File (#375)
HL7_MESSAGE_TEXT field (#.05) of the CP_HL7_LOG File (#704.002)
ACKNOWLEDGMENT TO field (#7) of the HL7 MESSAGE TEXT File (#772)
PARENT MESSAGE field (#8) of the HL7 MESSAGE TEXT File (#772)
DATE/TIME ENTERED field (#.01) of the HL7 MESSAGE ADMINISTRATION File (#773)
CROSS
REFERENCED BY: TRANSMISSION TYPE(AC), DATE/TIME PROCESSED(AD), CLIENT APPLICATION(AE), STATUS(AF), CLIENT APPLICATION(AG),
MESSAGE ID(AH), PARENT MESSAGE(AI), LOGICAL LINK(AXMITOUT1), STATUS(AXMITOUT2), DATE/TIME ENTERED(B)
INDEXED BY: FAST PURGE DT/TM (AJ), MESSAGE ID (C)
772,.01 DATE/TIME ENTERED 0;1 DATE (Required)
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: APR 16, 1998
DESCRIPTION:
The Date/Time the message was created.
CROSS-REFERENCE: 772^B
1)= S ^HL(772,"B",$E(X,1,30),DA)=""
2)= K ^HL(772,"B",$E(X,1,30),DA)
Regular 'B' cross reference.
772,2 SERVER APPLICATION 0;2 POINTER TO HL7 APPLICATION PARAMETER FILE (#771) (Required)
LAST EDITED: JUL 07, 1994
HELP-PROMPT: The server application related to this transmission.
DESCRIPTION:
The DHCP application related to this transmission.
772,2.02 FAST PURGE DT/TM 2;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:X<1 X
LAST EDITED: SEP 24, 2003
HELP-PROMPT: Enter the date and time at which the record may be purged.
FIELD INDEX: AJ (#345) MUMPS ACTION
Short Descr: Removes the record from the AI x-ref if the Fast Purge Date/Time is edited
Set Logic: Q
Kill Logic: K:$G(X1(1)) ^HLMA("AI",X1(1),772,+$G(DA))
X(1): FAST PURGE DT/TM (772,2.02) (Subscr 1) (forwards)
772,3 CLIENT APPLICATION 0;3 POINTER TO HL7 APPLICATION PARAMETER FILE (#771) (Required)
LAST EDITED: OCT 03, 1995
HELP-PROMPT: The client application related to this transmission.
DESCRIPTION:
The client application related to this transmission.
CROSS-REFERENCE: 772^AE^MUMPS
1)= N HLX0,HLXP S HLXP=$G(^HL(772,DA,"P")),HLX0=$G(^(0)) S:'$P(HLXP,"^",2)&($P(HLX0,"^",4)="O") ^HL
(772,"AC","O",X,DA)=""
2)= N HLX0 S HLX0=$G(^HL(772,DA,0)) K:$P(HLX0,"^",4)="O" ^HL(772,"AC","O",X,DA)
3)= Required to determine outgoing transmissions that need to be transmitted.
This cross reference is used in conjunction with the 'AC' cross reference on the Transmission Type
field (#4) and the 'AD' cross reference on the Date/Time Processed field (#21) to determine
outgoing transmissions for a specific application that need to be transmitted.
CROSS-REFERENCE: 772^AG^MUMPS
1)= S:$P(^HL(772,DA,0),"^",6)]"" ^HL(772,"AH",X,$P(^(0),"^",6),DA)=""
2)= K:$P(^HL(772,DA,0),"^",6)]"" ^HL(772,"AH",X,$P(^(0),"^",6),DA)
3)= Required to link initial messages with acknowledgment messages.
This cross reference is used in conjunction with the 'AH' cross reference on the Message ID field
(#6) to look up and link initial HL7 messages with reply/acknowledgement messages.
772,4 TRANSMISSION TYPE 0;4 SET (Required)
'I' FOR INCOMING;
'O' FOR OUTGOING;
LAST EDITED: NOV 30, 1994
HELP-PROMPT: The type of transmission (incoming or outgoing).
DESCRIPTION:
The type of transmission (incoming or outgoing).
CROSS-REFERENCE: 772^AC^MUMPS
1)= N HLX0,HLXP S HLXP=$G(^HL(772,DA,"P")),HLX0=$G(^(0)) S:'$P(HLXP,"^",2)&($P(HLX0,"^",3))&(X="O")
^HL(772,"AC","O",$P(HLX0,"^",3),DA)=""
2)= Q:X'="O" N HLX0 S HLX0=$G(^HL(772,DA,0)) K:$P(HLX0,"^",3) ^HL(772,"AC","O",$P(HLX0,"^",3),DA)
3)= Required to determine outgoing transmissions that need to be transmitted.
This cross reference is used in conjunction with the 'AE' cross reference on the Client Application
field (#3) and the 'AD' cross reference on the Date/Time Processed field (#21) to determine
outgoing transmissions for a specific application that need to be transmitted.
772,5 RELATED MAILMAN MESSAGE 0;5 FREE TEXT
INPUT TRANSFORM: K:$L(X)>15!($L(X)<1)!'(X?1N.N) X
LAST EDITED: MAY 12, 1993
HELP-PROMPT: The MailMan message number related to this transmission.
DESCRIPTION:
The MailMan message number related to this transmission.
772,6 MESSAGE ID 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>60!($L(X)<1) X
LAST EDITED: AUG 01, 2007
HELP-PROMPT: Answer must be 1-60 characters in length
DESCRIPTION:
The unique ID for this HL7 message.
CROSS-REFERENCE: 772^AH^MUMPS
1)= S:$P(^HL(772,DA,0),"^",3) ^HL(772,"AH",$P(^(0),"^",3),X,DA)=""
2)= K:$P(^HL(772,DA,0),"^",3) ^HL(772,"AH",$P(^(0),"^",3),X,DA)
This cross reference is used in conjunction with the 'AG' cross reference on the Non-DHCP
Application field (#3) to look up and link initial HL7 messages with reply/acknowledgement
messages.
FIELD INDEX: C (#781) REGULAR IR LOOKUP & SORTING
Short Descr: This is a regular index of new-style cross-reference on the Message ID field
Description: This cross reference allows a user to look up an HL7 message by its unique message ID.
Set Logic: S ^HL(772,"C",$E(X,1,60),DA)=""
Kill Logic: K ^HL(772,"C",$E(X,1,60),DA)
Whole Kill: K ^HL(772,"C")
X(1): MESSAGE ID (772,6) (Subscr 1) (Len 60) (forwards)
772,7 ACKNOWLEDGMENT TO 0;7 POINTER TO HL7 MESSAGE TEXT FILE (#772)
LAST EDITED: DEC 09, 1994
HELP-PROMPT: The incoming message that this message is replying to. This field is only applicable to outgoing
messages.
DESCRIPTION: The incoming message that this message is replying to. This field is only applicable to outgoing
messages.
772,8 PARENT MESSAGE 0;8 POINTER TO HL7 MESSAGE TEXT FILE (#772)
LAST EDITED: JAN 25, 1995
HELP-PROMPT: The original message to which this message is related, if applicable.
CROSS-REFERENCE: 772^AI
1)= S ^HL(772,"AI",$E(X,1,30),DA)=""
2)= K ^HL(772,"AI",$E(X,1,30),DA)
3)= This cross reference is needed by the purge utility to determine when a parent entry can be del
eted.
This cross reference is needed by the purge utility to determine when a parent entry can be
deleted. When the only entry in the cross reference is the parent (all children have been
deleted), then the parent entry can be deleted.
772,9 PRIORITY 0;9 SET (Required)
'I' FOR IMMEDIATE;
'D' FOR DEFERRED;
LAST EDITED: JAN 18, 1995
HELP-PROMPT: The mode in which this message will be delivered.
DESCRIPTION:
The delivery priority assigned to this message. Either 'I' for Immediate or 'D' for Deferred.
772,10 RELATED EVENT PROTOCOL 0;10 POINTER TO PROTOCOL FILE (#101)
LAST EDITED: SEP 09, 1994
HELP-PROMPT: The entry in the Protocol file related to this Message Text entry.
772,11 LOGICAL LINK 0;11 POINTER TO HL LOGICAL LINK FILE (#870)
LAST EDITED: FEB 20, 1997
HELP-PROMPT: The link that will be used to exchange messages with an external application.
DESCRIPTION: This is a pointer to the Logical Link file (#870). This link is used to transmit messages to an
external (client) application. This field is not filled in when messages are exchanged between
DHCP applications on the same system.
CROSS-REFERENCE: 772^AXMITOUT1^MUMPS
1)= N HLXRFST,HLXRFLL S HLXRFST=+$G(^HL(772,DA,"P")),HLXRFLL=+$P($G(^HL(772,DA,0)),"^",11) Q:(('HLX
RFST)!('HLXRFLL)) S HLXRFST=$P($G(^HL(771.6,HLXRFST,0)),"^",2) Q:(HLXRFST'="PT") S ^HL(772,"A-XMI
T-OUT",HLXRFLL,DA)=""
2)= K:$D(^HL(772,"A-XMIT-OUT",X,DA)) ^HL(772,"A-XMIT-OUT",X,DA)
This cross reference is used by the outgoing filer to find all messages with a status of 'PENDING
TRANSMISSION' (CODE=PT). The Logical Link that the message is queued for is stored in the cross
reference to synchronize delivery of messages to their Logical Links.
Resulting node: ^HL(772,"A-XMIT-OUT",HLXRFLL,DA)="" Where: HLXRFLL = Pointer to the Logical Link
DA = Pointer to the message
Notes: This cross reference is only set if the status code is 'PT'
: This cross reference is also set by the AXMITOUT2 cross reference
on the STATUS field (#20)
772,12 SECURITY 0;12 FREE TEXT
INPUT TRANSFORM: K:$L(X)>40!($L(X)<1) X
LAST EDITED: SEP 28, 1994
HELP-PROMPT: The value to use in the Security field of the Message Header segment. Answer must be 1-40
characters in length.
772,13 CONTINUATION POINTER 1;1 FREE TEXT
INPUT TRANSFORM: K:$L(X)>180!($L(X)<1) X
LAST EDITED: SEP 28, 1994
HELP-PROMPT: The value to use in the Continuation Pointer field of the Message Header segment. Answer must be
1-180 characters in length.
772,14 MESSAGE TYPE 0;14 SET (Required)
'M' FOR SINGLE MESSAGE;
'B' FOR BATCH OF MESSAGES;
'F' FOR FILE OF BATCHES;
LAST EDITED: JAN 18, 1995
HELP-PROMPT: The type of message. Single, batch or file.
DESCRIPTION: There are three types of messages as follows:
M for Single message (contains only one MSH segment) B for Batch of messages (contains multiple MSH
segments) F for File of batches (contains multiple BHS segments)
This field is automatically filled in by the Messaging System and is used to determine the
appropriate header segment to build for a message.
772,15 DON'T PURGE 2;1 SET
'1' FOR DON'T PURGE;
'0' FOR TO PURGE;
LAST EDITED: JUL 28, 1997
HELP-PROMPT: When this field is set to 1, the message wil never be purged by the HL7 "Purge Message Text File
Entries" option.
DESCRIPTION: When this field is set to 1, the message wil never be purged by the HL7 "Purge Message Text File
Entries" option. However, when this field is set to 0 or is empty, the message is allowed to be
purged by the HL7 "Purge Message Text Entries" option.
772,16 NAMESPACE 0;13 FREE TEXT
INPUT TRANSFORM: K:$L(X)>4!($L(X)<1)!'(X?1U1.3NU) X
LAST EDITED: FEB 15, 2002
HELP-PROMPT: Answer must be 1-4 characters in length, and start with 1 uppercase letter, followed by up to 3
uppercase letters and numerics.
DESCRIPTION: This field must not be filled in manually. It will be filled in automatically by the HL7 processes
that create entries in the HL7 Message Text file (#772). In most instances, applications will call
GENERATE^HLMA, GENACK^HLMA, or DIRECT^HLMA. When they do, they will pass by reference into the
last OPTIONS (in the documentation) parameter the value of the namespace. The value of the
namespace will be in the form of OPTIONS("NAMESPACE")=NAMESPACE.
Please note that the calls to the three APIs mentioned above use the variable HLP to hold the
passed in by reference array. So, in the HLMA code (and other code invoked by HLMA), the actual
variable used is HLP("NAMESPACE").
This field is populated by UPDATE^HLTF0.
772,20 STATUS P;1 POINTER TO HL7 MESSAGE STATUS FILE (#771.6) (Required)
LAST EDITED: FEB 20, 1997
HELP-PROMPT: The current status of the message.
DESCRIPTION:
The status currently assigned to this transmission.
CROSS-REFERENCE: 772^AF
1)= S ^HL(772,"AF",$E(X,1,30),DA)=""
2)= K ^HL(772,"AF",$E(X,1,30),DA)
This cross reference is used to produce the Pending and Failed Transmission reports.
CROSS-REFERENCE: 772^AXMITOUT2^MUMPS
1)= N HLXRFST,HLXRFLL S HLXRFST=+$G(^HL(772,DA,"P")),HLXRFLL=+$P($G(^HL(772,DA,0)),"^",11) Q:(('HLX
RFST)!('HLXRFLL)) S HLXRFST=$P($G(^HL(771.6,HLXRFST,0)),"^",2) Q:(HLXRFST'="PT") S ^HL(772,"A-XMI
T-OUT",HLXRFLL,DA)=""
2)= N HLXRFLL S HLXRFLL=+$P($G(^HL(772,DA,0)),"^",11) Q:'HLXRFLL K:$D(^HL(772,"A-XMIT-OUT",HLXRFLL
,DA)) ^HL(772,"A-XMIT-OUT",HLXRFLL,DA)
This cross reference is used by the outgoing filer to find all messages with a status of 'PENDING
TRANSMISSION' (CODE=PT). The Logical Link that the message is queued for is stored in the cross
reference to synchronize delivery of messages to their Logical Links.
Resulting node: ^HL(772,"A-XMIT-OUT",HLXRFLL,DA)="" Where: HLXRFLL = Pointer to the Logical Link
DA = Pointer to the message
Notes: This cross reference is only set if the status code is 'PT'
: This cross reference is also set by the AXMITOUT1 cross reference
on the LOGICAL LINK field (#11)
772,21 DATE/TIME PROCESSED P;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: OCT 02, 1995
HELP-PROMPT: The date and time this transmission was actually processed (sent or received).
DESCRIPTION:
The date and time this transmission was actually processed (sent or received).
CROSS-REFERENCE: 772^AD^MUMPS
1)= N HLX0 S HLX0=$G(^HL(772,DA,0)) K:$P(HLX0,"^",3)&($P(HLX0,"^",4)="O") ^HL(772,"AC","O",$P(HLX0,
"^",3),DA)
2)= N HLX0,HLXP S HLXP=$G(^HL(772,DA,"P")),HLX0=$G(^(0)) S:'$P(HLXP,"^",2)&($P(HLX0,"^",3))&($P(HLX
0,"^",4)="O") ^HL(772,"AC","O",$P(HLX0,"^",3),DA)=""
3)= Required to determine outgoing transmissions that need to be transmitted.
This cross reference is used in conjunction with the 'AE' cross reference on the Client Application
field (#3) and the 'AC' cross reference on the Transmission Type field (#4) to determine outgoing
transmissions for a specific application that need to be transmitted.
772,22 ERROR MESSAGE P;3 FREE TEXT
INPUT TRANSFORM: K:$L(X)>200!($L(X)<3) X
LAST EDITED: NOV 18, 1991
HELP-PROMPT: If there was an error in sending or receiving this transmission, this field will contain the 3-200
character error message.
DESCRIPTION: If there was an error in sending or receiving this transmission, this field will contain the 3-200
character error message.
772,23 ERROR TYPE P;4 POINTER TO HL7 ERROR MESSAGE FILE (#771.7)
LAST EDITED: FEB 20, 1997
HELP-PROMPT: A description of the type of error that occured.
772,26 ACK TIMEOUT P;7 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>600)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAY 05, 2000
HELP-PROMPT: Type a Number between 0 and 600, 0 Decimal Digits
DESCRIPTION: The number of seconds the Lower Layer Protocol waits for an acknowledgement from the receiving
application. This field will override the ACK TIMEOUT of the Logical Link for this message.
772,100 NO. OF CHARACTERS IN MESSAGE S;1 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>1000000)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JAN 25, 1993
HELP-PROMPT: Type a Number between 1 and 1000000, 0 Decimal Digits
DESCRIPTION: A count of the total number of characters in the mail message associated with this HL7 transmission
entry.
772,101 NO. OF EVENTS IN MESSAGE S;2 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>100000)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JAN 25, 1993
HELP-PROMPT: Type a Number between 1 and 100000, 0 Decimal Digits
DESCRIPTION: A count of the total number of events (HL7 messages) contained in the mail message associated with
this HL7 transmission entry.
772,102 TRANSMISSION TIME S;3 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: MAR 03, 1993
HELP-PROMPT: The time it took to transmit this message to the primary network addressee. A number between 0 and
999999, 0 Decimal Digits.
DESCRIPTION:
The time it took to transmit this message to the primary network addressee.
772,200 MESSAGE TEXT IN;0 WORD-PROCESSING #772.02 (NOWRAP) (IGNORE "|")
LAST EDITED: JUL 15, 1994
TECHNICAL DESCR:
LAST EDITED: APR 20, 2010
HELP-PROMPT: The text of the incoming messages for this transmission.
FILES POINTED TO FIELDS
HL LOGICAL LINK (#870) LOGICAL LINK (#11)
HL7 APPLICATION PARAMETER
(#771) SERVER APPLICATION (#2)
CLIENT APPLICATION (#3)
HL7 ERROR MESSAGE (#771.7) ERROR TYPE (#23)
HL7 MESSAGE STATUS (#771.6) STATUS (#20)
HL7 MESSAGE TEXT (#772) ACKNOWLEDGMENT TO (#7)
PARENT MESSAGE (#8)
PROTOCOL (#101) RELATED EVENT PROTOCOL (#10)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
CAPTIONED USER #0
DG NPTF TOTALS SEP 22, 1998@11:45 USER #0 HL7 MESSAGE TEXT STATISTICS
SORT TEMPLATE(S):
DG NPTF TOTALS SEP 21, 2004@09:54 USER #0
SORT BY: #DATE/TIME ENTERED;L7;C1;"PIMS EVENTS DATED "// (User is asked range)
WITHIN DATE/TIME ENTERED, SORT BY: @CLIENT APPLICATION// (CLIENT APPLICATION from NPTF to NPTFz)
WITHIN CLIENT APPLICATION, SORT BY: RELATED EVENT PROTOCOL:;C1;S1;""//
PROTOCOL FIELD: DESCRIPTION// (DESCRIPTION not null)
FORM(S)/BLOCK(S):