Global: ^HLB

FileMan FileNo	FileMan Filename	Package
778	HLO MESSAGES	Health Level Seven

Package	Total	Routines
Health Level Seven	25	HLOAPI1 HLOAPI3 HLOAPI7 HLOCLNT HLOCLNT2 HLOCLNT3 HLOCNRT HLOF778 HLOF778A HLOFILER HLOMSG HLOMSG1 HLOPRS HLOPURGE HLOQUE HLOSITE HLOSRVR HLOSRVR1 HLOUSR1 HLOUSR3 HLOUSR4 HLOUSR5 HLOUSR6 HLOUSR7 MSH SEGMENTS FOR BATCH
Capacity Management	1	KMPHLMRT

Package	Total	Routines
Mental Health	1	YSCLHLOP

Package	Total	FileMan Files
Health Level Seven	1	HLO MESSAGE BODY(#777)[.02]

Fields, Total: 32

Field #	Name	Loc	Type	Details
.01	MESSAGE ID	0;1	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>20!($L(X)<3) X` LAST EDITED: `MAY 04, 2005` HELP-PROMPT: `Answer must be 3-20 characters in length` CROSS-REFERENCE: `778^B` `1)= S ^HLB("B",$E(X,1,30),DA)=""` `2)= K ^HLB("B",$E(X,1,30),DA)` CROSS-REFERENCE: `778^AC^MUMPS` `1)= Q` `2)= Q` `This x-ref is maintained by the HL7 package. It is used to detect if an incoming message is a duplicate. The format is: ^HLB("AC"sending facility>__,ien)=0`
.02	MESSAGE BODY	0;2	POINTER TO HLO MESSAGE BODY FILE (#777)	**********************REQUIRED FIELD********************** HLO MESSAGE BODY(#777) LAST EDITED: `MAR 17, 2005` HELP-PROMPT: `Which record in file #777 contains the body of the message?` CROSS-REFERENCE: `778^C^MUMPS` `1)= S ^HLB("C",X,DA)=""` `2)= K ^HLB("C",X,DA)` `Used to find all the messages that point to the same entry in file 777. Only set for outgoing messages.`
.03	APPLICATION ACKNOWLEDGMENT TO	0;3	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<3) X` LAST EDITED: `MAR 17, 2005` HELP-PROMPT: `Enter the Message Control ID of the message to which this one is an acknowledgment.` DESCRIPTION: `This is the Message Control ID of the original message to which this message is an application acknowledgment.`
.04	DIRECTION	0;4	SET	**********************REQUIRED FIELD********************** 'I' FOR INCOMING; 'O' FOR OUTGOING; LAST EDITED: `NOV 16, 2004` HELP-PROMPT: `Is the message INCOMING or OUTGOING?`
.05	LINK	0;5	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>10!($L(X)<3) X` LAST EDITED: `NOV 16, 2004` HELP-PROMPT: `Enter the name of the logical link over which the message is being transmitted.`
.06	QUEUE	0;6	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>20!($L(X)<3) X` LAST EDITED: `JUL 29, 2004` HELP-PROMPT: `Is the queue on which this message was placed.`
.07	APPLICATION ACKNOWLEDGMENT BY	0;7	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<3) X` LAST EDITED: `SEP 30, 2004` HELP-PROMPT: `If this message has received an application response then enter the responses Message Control ID.`
.08	REMOTE PORT	0;8	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>65535)!(X<1)!(X?.E1"."1.N) X` LAST EDITED: `MAY 04, 2005` HELP-PROMPT: `Enter the remote port indicated in the Facility field of the message header.` DESCRIPTION: `This is the remote port # that may be found in the message header. For outgoing messages, it is in the Receiving Facility field, for incoming messages it is in tthe Sending Facility. For application acknowledgments, the` `port provided in the original message is used to return the acknowledgment.`
.09	SCHEDULED PURGE DATE/TIME	0;9	DATE	INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `AUG 19, 2004` HELP-PROMPT: `When can this message be purged?` CROSS-REFERENCE: `778^AD^MUMPS` `1)= Q` `2)= Q` `3)= DO NOT DELETE!` `This cross-reference will be used to control the purging process. It will be maintained within the HL7 package and will not be set via Fileman. The format is: ^HLB("AD",<"IN" or "OUT">,` `,` `ien>)="`
.1	APPLICATION ACK RSPNS TAG	0;10	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `JUL 27, 2004` HELP-PROMPT: `Answer must be 1-8 characters in length.` DESCRIPTION: `The sending application routine to execute when the application ack is received.` `This is part one of a two-part field which is the entry point. The second part names the routine.`
.11	APPLICATION ACK RSPNS RTN	0;11	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `MAR 14, 2007` HELP-PROMPT: `Enter the application routine that should be executed when an applicaton ack is returned.` DESCRIPTION: `Answer must be 1-8 characters in length. The sending application routine to execute when the application ack is received.` `This is part two of a two-part field which is the routine name. The first part names the entry point.` `For an returned application ack, this field documents the routine that was executed to process the application ack.`
.12	ACCEPT ACK RSPNS TAG	0;12	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `NOV 16, 2004` HELP-PROMPT: `Answer must be 1-8 characters in length.` DESCRIPTION: `The sending application's routine to execute when the transmission of the message fails, i.e., the message cannot be sent or no acceptack is received.` `This is part one of a two-part field, naming the entry point of the routine to be called. The second part names the routine.`
.13	ACCEPT ACK RESPNS RTN	0;13	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `NOV 16, 2004` HELP-PROMPT: `Answer must be 1-8 characters in length.` DESCRIPTION: `The sending application routine to execute whe the commit ack is received.` `This is part two of a two-part field, consisting of the routine name. The first part names the entry point with the M routine.`
.14	TRANSMISSION FAILURE RSPNS TAG	0;14	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `JUL 27, 2004` HELP-PROMPT: `Answer must be 1-8 characters in length.` DESCRIPTION: `The sending application's routine to execute when the transmission of the message fails, i.e., the message can not be sent or no commit ack is received.` `This is part one of a two-part field which is the entry point. The second part names the routine.`
.15	TRANSMISSION FAILURE RSPNS RTN	0;15	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>8!($L(X)<1) X` LAST EDITED: `JUL 27, 2004` HELP-PROMPT: `Answer must be 1-8 characters in length.` DESCRIPTION: `The sending application's routine to execute when the transmission of the message fails, i.e., the message can not be sent or no commit ack is received.` `This is part two of a two-part field which is the routine's name. The first part names the entry point.`
.16	TRANSMISSION DATE/TIME	0;16	DATE	INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `JUL 28, 2004` DESCRIPTION: `This is the date and time that the message was either received or sent.`
.17	ACCEPT ACK'D	0;17	SET	'1' FOR YES; LAST EDITED: `AUG 23, 2004` HELP-PROMPT: `Enter 1 if an accept ack was sent or received.`
.18	APPLICATION ACK'D	0;18	SET	'1' FOR YES; LAST EDITED: `NOV 16, 2004` DESCRIPTION: `For incoming messages, this flag indicates that an application ack was returned. For outgoing messages, this field indicates that the application ack was sent.`
.19	APPLICATION HANDOFF	0;19	SET	'1' FOR YES; LAST EDITED: `JUL 28, 2004` DESCRIPTION: `This flag indicates that this message was handed to the application. That may be for initial processing, or it may be in response to one of the other conditions that an application may register its need to respond, such` `as a failure of the remote system to accept the message.`
.2	COMPLETION STATUS	0;20	SET	'SU' FOR SUCCESSFUL; 'TF' FOR (obsolete) transmission failure; 'SE' FOR (obsolete) system error; 'AE' FOR (obsolete) application error; 'ER' FOR ERROR; LAST EDITED: `MAY 14, 2008` HELP-PROMPT: `Enter the code that indicates the final status of the message.` DESCRIPTION: `This field indicates the final status of the message. Any code but SU (SUCCESSFUL) indicates that an error occurred. No value indicates that the message has not completed.`
.21	ERROR TEXT	0;21	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<1) X` LAST EDITED: `SEP 28, 2004` HELP-PROMPT: `Answer must be 1-30 characters in length.` DESCRIPTION: `The HL7 package may use this field to document errors that prevent transmission. Errors determined by the remote system are contained in the MSA segment of the response message.`
.22	APP-SPECIFIED RETENTION	0;22	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>999)!(X<1)!(X?.E1"."1.N) X` LAST EDITED: `MAY 21, 2012` HELP-PROMPT: `How many days should the message be retained after it is processed? Enter 1 to 999.` DESCRIPTION: `This field indicates the minimum retention time in days specified by the application for the message before it is purged. When the purge is actually scheduled the site parameter will override the retention time specified` `in this field if the site parameter specifies a longer retention time.`
1	HDR SEGMENT,COMPONENTS 1-6	1;E1,250	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>250!($L(X)<8) X` LAST EDITED: `JUL 29, 2004` HELP-PROMPT: `The first 6 components of the message header segment.`
2	HDR SEGMENT,COMPONENTS 7-END	2;E1,250	FREE TEXT	**********************REQUIRED FIELD********************** INPUT TRANSFORM: `K:$L(X)>250!($L(X)<15) X` LAST EDITED: `NOV 16, 2004` HELP-PROMPT: `Enter the header segment begining with component 7`
3	MSH SEGMENTS FOR BATCH	3;0	Multiple #778.03	778.03
4.01	DATE/TIME OF ACCEPT ACK	4;1	DATE	INPUT TRANSFORM: `S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X` LAST EDITED: `SEP 28, 2004` HELP-PROMPT: `Enter the date and time of the ack.` DESCRIPTION: `This field will be used to record the accept ack.`
4.02	ACCEPT ACK MESSAGE ID	4;2	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<1) X` LAST EDITED: `SEP 28, 2004` HELP-PROMPT: `Answer must be 1-30 characters in length.`
4.03	ACCEPT ACK MSA SEGMENT	4;3	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>210!($L(X)<3) X` LAST EDITED: `SEP 28, 2004` HELP-PROMPT: `Answer must be 3-210 characters in length.`
5	TRANMISSION ATTEMPTS	TRIES;1	NUMBER	INPUT TRANSFORM: `K:+X'=X!(X>99999999)!(X<0)!(X?.E1"."1.N) X` LAST EDITED: `MAR 14, 2007` HELP-PROMPT: `How many times has HLO tried to transmit this message?` DESCRIPTION: `For outgoing messages, this field is a counter of how many times HLO attempted to send this message.`
5.01	SEQUENCE QUEUE	5;1	FREE TEXT	INPUT TRANSFORM: `K:$L(X)>30!($L(X)<3) X` LAST EDITED: `JUL 30, 2007` HELP-PROMPT: `Enter the name of the sequence queue to place the message on, 3-30 characters.` DESCRIPTION: `Applications may have difficulty insuring that messages are received by the remote application in the same order that the sending application generates the messages. If an application determines that maintaining the order` `of its messages is necessary, one method it may use it to specify that 1) Application acknowledgemnts are needed and 2) that the messages should be placed on a sequence queue. Messages that are placed on a particular` `sequence queue are not moved to the outgoing queue for transmission until the application acknolwedgment for the preceding message is received. This guarantees the order of delivery.`
5.02	MOVED TO OUT QUEUE	5;2	SET	'1' FOR YES; LAST EDITED: `JUN 25, 2007` HELP-PROMPT: `Enter YES if the message has been moved from a sequence queue to an outgoing queue.`
5.03	SEQUENCING EXCEPTION RAISED	5;3	SET	'1' FOR YES; LAST EDITED: `JUN 25, 2007` HELP-PROMPT: `Enter YES if the application ack is delayed, preventing the quence queue from moving.`

>>	Not killed explicitly
*	Changed
!	Killed
~	Newed

Name	Field # of Occurrence
>> %DT	.09+1, .16+1, 4.01+1*
>> DA	.01(XREF 1S), .01(XREF 1K), .02(XREF 1S), .02(XREF 1K)
X	.01+1!, .01(XREF 1S), .01(XREF 1K), .02(XREF 1S), .02(XREF 1K), .03+1!, .05+1!, .06+1!, .07+1!, .08+1! , .09+1!, .1+1!, .11+1!, .12+1!, .13+1!, .14+1!, .15+1!, .16+1!, .21+1!, .22+1! , 1+1!, 2+1!, 4.01+1*!, 4.02+1!, 4.03+1!, 5+1!, 5.01+1!
>> Y	.09+1, .16+1, 4.01+1

Customize PDF page

Package: Health Level Seven

Global: ^HLB

Information

Description

Directly Accessed By Routines, Total: 26

Accessed By FileMan Db Calls, Total: 1

Pointer To FileMan Files, Total: 1

Fields, Total: 32

Found Entries, Total: 3

ICR, Total: 1

External References

Global Variables Directly Accessed

Local Variables

Legend:

Name	Line Occurrences (* Changed, ! Killed)
^HLB("B"	.01(XREF 1S), .01(XREF 1K)
^HLB("C"	.02(XREF 1S), .02(XREF 1K)