HLO CONVERSOIN APIS (3) ICR (4731)

Name

Value

NUMBER

4731

IA #

4731

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOMSG

NAME

HLO CONVERSOIN APIS (3)

GENERAL DESCRIPTION

These utilities provide help to applications that were
developed before HLO convert to HLO. See also IA# 4727 and IA#4728.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOMSG

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$HLNEXT(.HLMSTATE,.SEG)

This API is NOT to be used in the development of a
new messaging application.  It is provided for messaging applications that
were developed prior to HLO where stepping through a message was accomplished
by executing HLNEXT.

The new function $$HLNEXT is used to step through the segments of a message
stored in the new HLO data structures.  However, for batch messages, it does
not tranverse from one message to the next as executing HLNEXT does.

VARIABLES

TYPE

VARIABLES DESCRIPTION

HLMSTATE

Both

This array is used by the HL7 package to track the
current position in the message.  The application MUST NOT touch it.

SEG

Output

The segment is returned in this array.

$$HLNEXT

Output

The function returns 1 on success, 0 if there are no
more segments in this message.  For batch messages, a return value of 0 does
not preclude the possibility that there are additional individual messages
within the batch.