Print Page as PDF
HLO APPLICATION ACKNOWLEDGEMENT APIS ICR (4722)

HLO APPLICATION ACKNOWLEDGEMENT APIS    ICR (4722)

Name Value
NUMBER 4722
IA # 4722
DATE CREATED 2005/08/19
CUSTODIAL PACKAGE HEALTH LEVEL SEVEN
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE HLOAPI2
NAME HLO APPLICATION ACKNOWLEDGEMENT APIS
GENERAL DESCRIPTION
These APIs are used by applications to return
application acknowledgments to messages received via HLO.
STATUS Active
DURATION Till Otherwise Agreed
ID HLOAPI2
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$ACK(.HLMSTATE,.PARMS,.ACK,.ERROR)
This API initiates (but doesn't complete) an
application acknowledgment. This API should NOT be called for batch messages,
use $$BATCHACK^HLOAPI3 instead.
VARIABLES TYPE VARIABLES DESCRIPTION
$$ACK Output
Function call returns 1 on success, 0 on failure.
HLMSTATE Both
Obtained by calling $$STARTMSG^HLOPRS when parsing
the original message. It is used internally by HLO.
PARMS Input
Optional. These subscripts may be defined:

("ACK CODE") - MSA1 contains AA, AE, or AR.  ("ERROR MESSAGE") - MSA3, should
be used only if AE or AR.  ("ACCEPT ACK RESPONSE") - Optional. The
<tag^routine> to call in response to a commit ack.    ("ACCEPT ACK TYPE") -
{AL,NE} (Optional, defaults to AL).  ("CONTINUATION POINTER") -Indicates a
fragmented messages.  ("COUNTRY") - The three-character country code
(optional).  ("EVENT") - The three-character event type (optional, defaults to
the event code of the original message).  ("ENCODING CHARACTERS") - The four
HL7 encoding characters (optional, defaults to "^~\&".  ("FAILURE RESPONSE") -
Optional. The <tag>^<routine> that the sending application routine should
execute if the transmission of the message fails, i.e., the message can not be
sent or a requested commit ack is not received.  ("FIELD SEPARATOR") - Field
separator (optional, defaults to "|").  ("MESSAGE TYPE") - If not defined, ACK
is used.  ("MESSAGE STRUCTURE CODE") - Optional.  ("QUEUE")- Optional. An
application can name its own private queue (a string under 20 characters, it
should be namespaced). The default is the name of the queue of the original
message ("SECURITY") - Optional. Security information to include in the header
segment, SEQ 8. ("VERSION") - The HL7 Version ID (optional, defaults to 2.4).

ACK Output
The acknowledgement message being built.
ERROR Output
On failure, an error message is returned.
$$SENDACK(.ACK,.ERROR)
Sends the acknowledgment message that was begun by a
call to $$ACK^HLAPI2 or a batch of acknowledgement messages that was begun by
a call to $$$$BATCHACK^HLOAPI3.
VARIABLES TYPE VARIABLES DESCRIPTION
$$SENDACK Output
Function call returns 1 on success, 0 on failure.
ACK Input
An array that contains the acknowledgment message
that was built by calling the other APIs.
ERROR Output
If the function fails, an error message is returned.

MAIL MESSAGE 41001358
Generated from JAN 24, 2019@ IA Listing Descriptions