Print Page as PDF
HL7 APIs ICR (3099)

HL7 APIs    ICR (3099)

Name Value
NUMBER 3099
IA # 3099
DATE CREATED 2000/04/24
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLCSUTL
NAME HL7 APIs
GENERAL DESCRIPTION
HL7 APIs for the routine HLCSUTL.  These are available
after patch HL*1.6*64.
STATUS Active
ID HLCSUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$FLD(.HLNODE, field)
This function will return the value for the field in
a HL7 message segment.
input value:  HLNODE = HLNODE from the HLNEXT call, passed by reference
field = number, field position in segment
note:    HL("FS") must be defined

return value:  value for the field in this segment
VARIABLES TYPE VARIABLES DESCRIPTION
HLNODE Input
This variable contains a message segment. It is
defined when processing a HL7 message and executing HLNEXT.
field Input
A number that defines the position in the segment for
the value you want.
$$MSG(msg id, return ref)
This function puts the complete HL7 message,
including header, into the close reference, return ref. This is only for TCP
tcp messages.

input:     msg id = message identifier
return ref = closed local or global reference

output:  return 1 for success and 0 if message doesn't exist

The message is returned with blank line between each segment, example:

ref(1)=MSH^~|\&VOICERAD^^RADIOLOGY^^20000110145151-0800^^ORU~R01^1231^T^2.2
ref(2)= ref(3)=PID^^^100~10~M11^^JONES~JOHN^^19421111^M^^^^^^^^^^123456789
ref(4)=

VARIABLES TYPE VARIABLES DESCRIPTION
msg id Input
The message identifier that uniquely identifies the
message.
return ref Input
A closed local or global reference to put the HL7
message.