HLO PARSING APIS ICR (4718)

Name

Value

NUMBER

4718

IA #

4718

DATE CREATED

2005/08/19

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOPRS

NAME

HLO PARSING APIS

GENERAL DESCRIPTION

These APIs are to be used by applications that receive
HL7 messages via HLO.  They provide the means of stepping through batches of
messages, the message segments, and fetching data values from within segments.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOPRS

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$STARTMSG(.HLMSTATE,IEN,.HDR)

This function begins the parsing of the message,
parsing the header and returning the individual values in the array HDR().

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$STARTMSG	Output	Returns 1 on success, 0 on failure.
IEN	Input	The internal entry number of the message in file 778.
HLMSTATE	Output	Required. This array is used by the HL7 package to track the progress of parsing the message. The application MUST NOT touch it.
HDR	Output	Optional. This array contains the results of parsing the message header.

$$NEXTSEG(.HLMSTATE,.SEG)

Advances parsing to the next segment within the
message.

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$NEXTSEG

Output

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.

HLMSTATE

Both

HLMSTATE is an array used internally by HLO to track
the progress of parsing.

SEG

Output

The segment is returned in this array.

$$NEXTMSG(.HLMSTATE,.MSH)

Advances to the next message within the batch, with
the MSH segment returned.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$NEXTMSG	Output	Function returns 1 on success, 0 if there are no more messages.
HLMSTATE	Both	This array is used by HLO to track the current position in the message.
MSH	Output	Returns the MSH segment, parsed into its individual values.

$$GET(.SEG,FIELD,COMP,SUBCOMP,REP)

This function gets a specified value from a segment
that was parsed by $$NEXTSEG^HLOPRS. The FIELD,COMP,SUBCOMP,REP parameters are
optional - if not specified, they default to 1.

Example: $$GET^HLOPRS(.SEG,1) will return the value of the first field, first
component, first subcomponent, in the first occurrence of field #1.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$GET	Output	This function returns a specified value from a segment.
SEG	Input	This is the array where the parsed segment was placed by $$NEXTSEG^HLOPRS.
FIELD	Input	The sequence # of the field (optional, defaults to 1). If 0 (zero) is specified, then the function returns the segment type.
COMP	Input	The number of the component (optional, defaults to 1).
SUBCOMP	Input	The number of the subcomponent (optional, defaults to 1).
REP	Input	The occurrence number (optional, defaults to 1) For a non-repeating field, the occurrence number need not be provided, because it would be 1.