Decode HL7 message

Inputs

The designer shows the main inputs (output format, validate, generate ACK, ACK mode); the rest are under Advanced parameters.

Output

Outputs are in the action's body, in camelCase. body('Decode_HL7') is this object (run history shows it under body, next to statusCode):

body('Decode_HL7')
├─ success        true when every message decoded without errors (warnings allowed)
├─ isBatch, messageCount
├─ ackCode        the FIRST message's
├─ xml            the FIRST message's document, as a string (outputFormat xml)
├─ json           the same document as JSON text (outputFormat json); the other one is null
├─ outputFormat   "xml" or "json"
├─ ack            the FIRST message's ACK (ER7)
├─ batchAck       FHS/BHS … BTS/FTS around every message's ACK, for a batch
├─ messages[]     one entry per message, in input order:
│    success, ackCode, messageType, triggerEvent, messageStructure, version, controlId,
│    sendingApplication, sendingFacility, receivingApplication, receivingFacility, processingId,
│    schema, xml, json, ack, errors[]
└─ errors[]       every message's errors: code, codeText, severity, message, location, controlId

• xml and json are strings, not objects. Read them with xml(body('Decode_HL7')?['xml']) and xpath(), or with json(body('Decode_HL7')?['json']). See Maps and XPath.
• MSH is in the document, and its main values are also copied into each messages[i]. body('Decode_HL7')?['messages']?[0]?['controlId'] is MSH-10 without any XPath.
• The top-level xml, json, ack and ackCode are the first message's. For a batch or several messages, loop over messages. Each entry has its own document, ACK and errors. success covers all of them.
• The input isn't repeated in the outputs. It is in the action's inputs in run history.

A message whose PID-8 is X, a value the schema's table doesn't allow:

{
  "success": false,
  "isBatch": false,
  "messageCount": 1,
  "ackCode": "AE",
  "xml": "<ns0:ADT_A01_25 xmlns:ns0=\"http://lambogenius.com/HealthCare/HL7/2X\"><MSH>…</ns0:ADT_A01_25>",
  "json": null,
  "outputFormat": "xml",
  "ack": "MSH|^~\\&|TARGET|FACILITY|HOSPITAL|FACILITY|20261021182459-0400||ACK^A01^ACK|20261021222459365359|T|2.5\rMSA|AE|MSG00003|XSD validation: …\rERR||PID^3^8^1|102^Data type error^HL70357|E||||XSD validation: …\r",
  "batchAck": null,
  "messages": [ {
    "success": false, "ackCode": "AE",
    "messageType": "ADT", "triggerEvent": "A01", "messageStructure": "ADT_A01", "version": "2.5", "controlId": "MSG00003",
    "sendingApplication": "HOSPITAL", "sendingFacility": "FACILITY", "receivingApplication": "TARGET", "receivingFacility": "FACILITY",
    "processingId": "T", "schema": "ADT_A01_25.xsd#ADT_A01_25",
    "xml": "<ns0:ADT_A01_25 …", "json": null, "ack": "MSH|^~\\&|TARGET|…", "errors": [ … ]
  } ],
  "errors": [ {
    "code": "102", "codeText": "Data type error", "severity": "Error",
    "message": "XSD validation: The 'PID_8_AdministrativeSex' element is invalid - The value 'X' is invalid according to its datatype … - The Enumeration constraint failed.",
    "location": "PID[3].8(1)", "controlId": "MSG00003"
  } ]
}

• errors[] carry the HL7 table 0357 code, codeText, severity (Error or Warning), message, controlId and a location.
• Locations read SEGMENT[n].field(repetition).component.subcomponent, where n is the segment's position in the message: PID[3].8(1) is the third segment (the PID), field 8, first repetition.
• The document is still returned when validation fails, so you can log or inspect it.

ACK codes, and when the action fails