DBIA2434 ICR (2434)

Name

Value

NUMBER

2434

IA #

2434

DATE CREATED

1998/06/16

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLUTIL

NAME

DBIA2434

GENERAL DESCRIPTION

Patch HL*1.6*36 introduces 3 new entry points in
routine HLUTIL. These entry points support two new features, "Don't Purge" and
"Reprocessing" messages, which were originally requested by the CIRN project.
Patch HL*1.6*19 added a 4th API and restricted the use of all APIs to TCP/IP
connections.

STATUS

Active

DURATION

Till Otherwise Agreed

HLUTIL

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$DONTPURG

Sets the new flag field "DON'T PURGE" (#773,10) to
prevent a message being purged by the "HL PURGE TRANSMISSIONS" option.

input:

none

return value:

1   means field has been successfully set.

-1  means call has failed; nothing has been changed.

Call this function from one of the following routines:

- RTN routine, in $$REPROC^HLUTIL(IEN,RTN).

- routine in "GENERATE/PROCESS ROUTINE"(#101,771).

- routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772).

When called by these routines, HL7 assumes that the variable HLMTIENS (message
IEN of file #773) is already properly defined.  This variable should already
be defined if in a message processing context.

$$TOPURG

Clear the flag field "DON'T PURGE" (#773,10) to allow
the message to be purged by the "HL PURGE TRANSMISSIONS" option.

input:

none

return value:

0   means field has been successfully cleared

-1  means call has failed; nothing has been changed

Call this function from one of the following routines:

- RTN routine, in $$REPROC^HLUTIL(IEN,RTN).

- routine in "GENERATE/PROCESS ROUTINE"(#101,771).

- routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772).

When called by these routines, HL7 assumes that the variable HLMTIENS (message
IEN of file #773) is already properly defined.  This variable should already
be defined if in a message processing context.

$$REPROC

Call this entry point to reprocess an inbound message
in file 773.

input value:
IEN is the internal entry number of the message in file 773
RNT is the routine to execute to process the message

return value:  0  means call has been successfully completed.  -1 means call
has failed; nothing has been changed.

The IEN, which is provided to $$REPROC^HLUTIL(IEN,RTN) should be the message
IEN of file #773.

VARIABLES	TYPE	VARIABLES DESCRIPTION
IEN	Input	the internal entry number of the message in file 773
RTN	Input	routine, to be Xecuted for reprocessing the message.

$$SETPURG

This function can set the new flag field "DON'T
PURGE" (#773,10) to prevent or allow a message to be purged by the "HL PURGE
TRANSMISSIONS" option.

input:

STATUS set to 0 or 1.
1=prevents message from being purged

0=allows message to be purged

return value:

1   means field has been successfully set.

-1  means call has failed; nothing has been changed.

Call this function from one of the following routines:

- RTN routine, in $$REPROC^HLUTIL(IEN,RTN).

- routine in "GENERATE/PROCESS ROUTINE"(#101,771).

- routine in "GENERATE/PROCESS ACK ROUTINE"(#101,772).

When called by these routines, HL7 assumes that the variable HLMTIENS (message
IEN of file #773) is already properly defined.  This variable should already
be defined if in a message processing context.

VARIABLES	TYPE	VARIABLES DESCRIPTION
STATUS	Input	This variable can have a value of 1 or 0. 1 sets the message's purge flag such that the message won't be purged. 0 sets the message's purge flag such that the message will be purged.