HL7 MESSAGE PARSING APIs (PRE-HLO) (continued) ICR (4744)

Name

Value

NUMBER

4744

IA #

4744

DATE CREATED

2005/08/29

CUSTODIAL PACKAGE

HEALTH LEVEL SEVEN

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

HLOPRS

NAME

HL7 MESSAGE PARSING APIs (PRE-HLO) (continued)

GENERAL DESCRIPTION

This integration agreement completes the description of
the HL7 message parsing APIs that begins with DBIA #4742.

STATUS

Active

DURATION

Till Otherwise Agreed

HLOPRS

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GET(.SEGMENT,SEQ,COMP,SUBCOMP,REP)

This function gets a value from a segment that was
obtained by calling $$NEXTSEG.  The SEQ, COMP, SUBCOMP, and REP parameters are
optional. If not specified, they default to the value1. For example,
$$GET^HLPRS(.SEGMENT,1) will return the value of the first field, first
component, first subcomponent, in the first occurrence.  Since many fields
consist of a single simple value, this is a useful feature.  $$GET^HLOPRS(0)
may be used to return the segment type.

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$GET	Output	Function returns the value on success, "" on failure or if the specified part is not valued.
SEGMENT	Input	(required, pass by reference) The segment was placed in this array by $$NEXTSEG.
SEQ	Input	The sequence number of the field, defaults to 1.
COMP	Input	The number of the component, defaults to 1.
SUBCOMP	Input	The number of the subcomponent, defaults to 1.
REP	Input	The occurrence number. For a non-repeating field, the occurrence number need not be provided, because it is always 1.

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	SUBSCRIBING DETAILS
INTEGRATED BILLING	The IB package is granted authority to use these new APIs for the PFSS project.
REGISTRATION	The DG package is granted authority to use these new APIs for the PFSS project.