Developer documentation‎ > ‎HL7 API‎ > ‎

Standard HL7 Acknowledgement


Acknowledgement

Overview

This message is used to indicate whether PKB received your message successfully or not. There is 1 success code (AA) and 2 error codes (AR or AE) that can be returned in MSA-1.1.
AR is used to indicate an error condition that we have checked for, e.g. a mandatory field was not included.
AE is used to indicate an unexpected error occurred.

Definition


SegmentFieldComponentDescriptionExample
MSH

Message header. This conforms to PKB's standard definition.
MSA

Message acknowledgement

MSA-1
Acknowledgement code


MSA-1.1Acknowledgement code. AA = accepted, AR = rejected, AE = errorAR

MSA-2
Message control ID. This will match the message control ID supplied in the inbound message.


MSA-2.1Message control IDABC0000000001

MSA-3
Text message. If there is an error, this will provide further details.


MSA-3.1Text messageplacer id (SCH.1.1) must be provided

Examples

PKB will respond with an ACK message; there are three possible acknowledgement codes.

AA: Message received successfully.
MSH|^~\&|HL7API|PKB|HOSPSYS|HOSP|201311131009||ACK^R01|201311131009.59|P|2.4
MSA|AA|20133090012357||


AR: Message rejected due to validation errors (detail included).
MSH|^~\&|HL7API|PKB|HOSPSYS|HOSP|201311131010||ACK^R01|201311131010.60|P|2.4
MSA|AR|20133090012408|Parsing or validation error: OBR[1].OBX[2]: No observation timestamp in OBX or OBR|


AE: Unexpected error during processing (usually due to a severely malformed message).
MSH|^~\&|HL7API|PKB|HOSPSYS|HOSP|201311131005||ACK^R01|201311131005.51|P|2.4
MSA|AE|20133090010842|Unexpected error while processing: null|


Comments