Interface: MessageStructure

The structure summary for a parsed message: the data behind Hl7Message.structure. For an unrecognized type, recognized is false, expectedGroups is empty, and missingGroups is empty (the safety net is deliberately silent on types it does not model).

Properties

expectedGroups

readonly expectedGroups: readonly StructureGroup[]

Per-expected-group presence verdicts (empty when unrecognized).

---

messageCode

readonly messageCode: string

MSH-9.1 message code observed on the message. "" when absent, and "<withheld>" when recognized is false and the observed value is not identifier-shaped (MSH-9 can hold a data field on a malformed message).

---

missingGroups

readonly missingGroups: readonly string[]

Names of the expected groups that are entirely absent (the warnings).

---

recognized

readonly recognized: boolean

true when a MESSAGE_STRUCTURE_DEFINITIONS entry matched the type.

---

triggerEvent

readonly triggerEvent: string

MSH-9.2 trigger event observed on the message. "" when absent, and "<withheld>" when recognized is false and the observed value is not identifier-shaped. Note that on the recognized branch this is echoed verbatim, which for a definition matching on message code alone (ACK) means an arbitrary MSH-9.2.