Print Page as PDF
HL7 APIs ICR (3098)

HL7 APIs    ICR (3098)

Name Value
NUMBER 3098
IA # 3098
DATE CREATED 2000/04/24
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
CUSTODIAL ISC San Francisco
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLUTIL
NAME HL7 APIs
GENERAL DESCRIPTION
APIs for HL7 package.  These APIs are available after
patch HL*1.6*64.
STATUS Active
KEYWORDS HL7
ID HLUTIL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$MSGSTAT(msg id)
This function will return the message status for the
given message id.
input value:  X = message id

return value: status^status updated^error msg.^error type pointer^queue
position or # of retries^# open failed^ack timeout

status:
0 = message doesn't exist
1 = waiting in queue
1.5 = opening connection
1.7 = awaiting response, # of retries
2 = awaiting application ack
3 = successfully completed
4 = error
8 = being generated
9 = awaiting processing

VARIABLES TYPE VARIABLES DESCRIPTION
msg id Input
The message identifier that uniquely identifies the
message.
$$MSGACT(msg id, action)
Take an action on an outgoing HL7 message.  Only
works on messages going out on a TCP Logical Link.
Actions: 1 = cancel, 2 = requeue.
Returns: 1 = sucess, 0 = failed
VARIABLES TYPE VARIABLES DESCRIPTION
msg id Input
The message identifier that uniquely identifies the
message in file 773, HL7 MESSAGE ADMINISTRATION file.
action Input
The action to perform on the message. 1 = cancel, 2 =
requeue.
$$CHKLL(institution)
This function checks the setup of the Logical Link
identified by the institution name or number.  This will only work with TCP
Logical Links.  Returns: 1 = Link is setup correctly, 0 = Link is not setup
correctly.
VARIABLES TYPE VARIABLES DESCRIPTION
institution Input
This is the institution name or number.