Files > HL7 MESSAGE ADMINISTRATION

name
HL7 MESSAGE ADMINISTRATION
number
773
location
^HLMA(
description
This file is used to create and maintain unique message IDs. It also contains a date/time when each ID was created.
Fields
#NameLocationTypeDetailsIndexDescription
.001number11
.01date/time entered(+)0;1POINTER772B
2message id0;2FREE TEXTThis is an unique identifier associated with a message.
2.02fast purge dt/tm2;2DATE-TIME
3transmission type(+)0;3SET OF CODESI:INCOMING
O:OUTGOING
The type of transmission (incoming or outgoing).
4priority0;4SET OF CODESI:IMMEDIATE
D:DEFERRED
The delivery priority assigned to this outgoing message.
5header type0;5SET OF CODESM:SINGLE MESSAGE
B:BATCH OF MESSAGES
F:FILE OF BATCHES
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.
6initial message0;6POINTER773AFThis is the first message of a transaction. All messages pointing to the initial message are part of the transaction.
7logical link0;7POINTER870This is a pointer to the Logical Link file (#870). This link is used to transmit messages to an external receiving application. This field is not filled in when messages are exchanged between DHCP applications on the same system.
8subscriber protocol0;8POINTER101The Protocol related to this message.
9security0;9FREE TEXTThe value to use in the Security field of the Message Header segment.
10don't purge2;1SET OF CODES1:DON'T PURGE
0:TO PURGE
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.
11continuation pointer1;1FREE TEXTThe value to use in the Continuation Pointer field of the Message Header segment.
12acknowledgement to0;10POINTER773This field points to the message that the MSA segment in the current message is acknowledging.
13sending application0;11POINTER771The application that is sending the message.
14receiving application0;12POINTER771The application that is receiving this message.
15message type0;13POINTER771.2This is the Message type from the HL7 standard.
16event type0;14POINTER779.001This is the Event Type from the HL7 standard.
17logical link - in queue0;17POINTER870
20status(+)P;1POINTER771.6AGThe status currently assigned to this message.
21status update date/timeP;2DATE-TIMEThe date and time the Status field was last updated for this message.
22error messageP;3FREE TEXTIf there was an error in sending or receiving this message, this field will contain the error message.
23error typeP;4POINTER771.7A description of the type of error that occured.
24transmission attemptsP;5NUMERICThis field contains the number of transmission attempts for this outgoing message.
25open attemptsP;6NUMERICThis field contains the number of attempts to open a TCP connections for this outgoing message.
26ack timeoutP;7NUMERICThe 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.
50message sizeCOMPUTEDThis computed field returns the number of character in a message. It includes the message header and body.
90.01hlp-subscriber protocol90;1FREE TEXTThis field holds the SUBSCRIBER PROTOCOL that was on the 1st piece of the HLP("SUBSCRIBER"[,#]) subscriber entry. (If the HLP("SUBSCRIBER") entry was used to reset the MSH segment fields, this field will be null.) Additional Comments on ^HLMA(ien,90) Node ----------------------------------------- When the MSH segment fields are successfully reset using either HLP("SUBSCRIBER") or HLP("SUBSCRIBER",#), the entire HLP("SUBSCRIBER") or HLP("SUBSCRIBER",#) array entry is stored on the ^HLMA(#,90) node. There are eight pieces in the HLP("SUBSCRIBER"[,#]) array, and there are eight fields on the ^HLMA(ien,90) node. The eight pieces of HLP("SUBSCRIBER"[,#]) and the eight ^HLMA(ien,90) fields exactly correspond to each other. Note: When ^HLMA(ien,90) is created, it is set equal to the entire value of the HLP("SUBSCRIBER"[,#]) array entry. The fields on the ^HLMA(ien,90) node are not set separately! (So, if the application developer creates an invalid HLP("SUBSCRIBER"[,#]) array, with invalid data stored in one or more of the eight pieces, the ^HLMA(ien,90) node will similarly hold invalid data.)
90.02hlp-sending application90;2FREE TEXTThis field holds the SENDING APPLICATION that was on the 2nd piece of the HLP("SUBSCRIBER"[,#]) subscriber entry. (See the 'Additional Comments on ^HLMA(ien,90) Node' section in the description for field # 90.01.)
90.03hlp-sending facility90;3FREE TEXTThis field holds the SENDING FACILITY that was on the 3rd piece of the HLP("SUBSCRIBER"[,#]) subscriber entry. (See the 'Additional Comments on ^HLMA(ien,90) Node' section in the description for field # 90.01.)
90.04hlp-receiving application90;4FREE TEXTThis field holds the RECEIVING APPLICATION that was on the 4th piece of the HLP("SUBSCRIBER"[,#]) subscriber entry. (See the 'Additional Comments on ^HLMA(ien,90) Node' section in the description for field # 90.01.)
90.05hlp-receiving facility90;5FREE TEXTThis field holds the RECEIVING FACILITY that was on the 5th piece of the HLP("SUBSCRIBER"[,#]) subscriber entry. (See the 'Additional Comments on ^HLMA(ien,90) Node' section in the description for field # 90.01.)
90.06hlp-subroutine90;6FREE TEXTSee the description for the HLP-ROUTINE field (#90.07).
90.07hlp-routine90;7FREE TEXTApplication developers may pass a reference to M code in the HLP("SUBSCRIBER"[,#]) subscriber entry. When this is done, the subroutine being referenced is stored in the HLP-SUBROUTINE field (#90.06), and the routine is stored in this field.
90.08hlp-debug90;8FREE TEXTThe application developer can control what type of debugging data is stored when MSH segment fields are reset by the HLP("SUBSCRIBER"[,#]) entry. This field holds the data on the eighth piece of the HLP("SUBSCRIBER"[,#]) entry, which also specifies which debugging data should be stored. Types Debug Data: ----------------- There are three types of debug data: - Node ^HLMA(ien,90) data. (See global map of this file for fields.) - Node ^HLMA(ien,91) data. (See global map of this file for fields.) - ^XTMP("HLCSHDR3 ien") data. (See patch documentation for explanation.) Syntax: ------- The syntax for the eight piece of the HLP("SUBSCRIBER"[,#]) array entry, (which is also the value for this field), is: [1]-[1]-[1] The [brackets] above indicate optionality; any of the three dash-delimited pieces may be null. Examples: 1-1-1 -> ^HLMA(ien,90), ^HLMA(ien,91) and ^XTMP data captured. 1--1 -> ^HLMA(ien,90 and ^XTMP data captured. --1 -> Only ^XTMP data captured.
91.01original snd app91;1FREE TEXTThe value of the SENDING APPLICATION is calculated from the event driver protocol. If this value is overwritten by a HLP("SUBSCRIBER"[,#]) entry, the value before overwrite is stored in this field. Note: Fields 91.03, 91.05, and 91.07 similarly hold the pre-overwrite values for their respective fields.
91.02original snd app-source91;2SET OF CODESA:ARRAY
M:M CODE
MSH segment fields can be overwritten by free-text values on pieces 2 through 5 of the HLP("SUBSCRIBER"[,#]) node, or by M code referenced in this node. If the HLP-ORIGINAL SND APP field (#91.01) is overwritten by free-text data, this field will hold an "A" (for array.) If overwritten by M code this field will hold "M".
91.03original snd fac91;3FREE TEXTThe value of the SENDING FACILITY is calculated from the event driver protocol. If this value is overwritten by a HLP("SUBSCRIBER"[,#]) entry, the value before overwrite is stored in this field.
91.04original snd fac-source91;4SET OF CODESA:ARRAY
M:M CODE
MSH segment fields can be overwritten by free-text values on pieces 2 through 5 of the HLP("SUBSCRIBER"[,#]) node, or by M code referenced in this node. If the HLP-ORIGINAL SND FAC field (#91.03) is overwritten by free-text data, this field will hold an "A" (for array.) If overwritten by M code this field will hold "M".
91.05original rec app91;5FREE TEXTThe value of the RECEIVING APPLICATION is calculated from the subscriber protocol. If this value is overwritten by a HLP("SUBSCRIBER"[,#]) entry, the value before overwrite is stored in this field.
91.06original rec app-source91;6SET OF CODESA:ARRAY
M:M CODE
MSH segment fields can be overwritten by free-text values on pieces 2 through 5 of the HLP("SUBSCRIBER"[,#]) node, or by M code referenced in this node. If the HLP-ORIGINAL REC APP field (#91.05) is overwritten by free-text data, this field will hold an "A" (for array.) If overwritten by M code this field will hold "M".
91.07original rec fac91;7FREE TEXTThe value of the RECEIVING FACILITY is calculated from the subscriber protocol. If this value is overwritten by a HLP("SUBSCRIBER"[,#]) entry, the value before overwrite is stored in this field.
91.08original rec fac-source91;8SET OF CODESA:ARRAY
M:M CODE
MSH segment fields can be overwritten by free-text values on pieces 2 through 5 of the HLP("SUBSCRIBER"[,#]) node, or by M code referenced in this node. If the HLP-ORIGINAL REC FAC field (#91.07) is overwritten by free-text data, this field will hold an "A" (for array.) If overwritten by M code this field will hold "M".
100last date/time updatedS;1DATE-TIMEAFFor outgoing message: 1. Date/time of its commit ACK received. 2. Date/time of its application ACK message received (overwriting #1). And for incoming message: 1. Date/time of the message received. 2. Date/time of the message has been processed by the application (overwriting #1).
102time start to sendS;2DATE-TIMEThis is the date/time the transmission of this outgoing message began.
103time sentS;3DATE-TIMEThis is the date/time the transmission of this outgoing message finished.
104time of commit/app ackS;4DATE-TIMEThis is the date/time this message received the commit ACK, or application ACK of original mode or direct connect transmission (API: DIRECT^HLMA).
105time of application ackS;5DATE-TIMEThis is the date/time this message received the application ACK.
106time start processingS;6DATE-TIMEThis is the date/time the application began processing this message.
107time processedS;7DATE-TIMEThis is the date/time the application finished processing this message.
200mshMSH;0WORD-PROCESSING

Referenced by 3 types

  1. HL7 Message Exceptions File (79.3) -- hl7 message
  2. CP_HL7_LOG (704.002) -- hl7_message_administration
  3. HL7 MESSAGE ADMINISTRATION (773) -- initial message, acknowledgement to