Skip to main content
Version: v0.0.4

Function: analyzeMessageStructure()

analyzeMessageStructure(messageCode, triggerEvent, presentSegmentNames): MessageStructure

Analyze a parsed message's structure against the conservative expected-group registry. Pure: it takes the message code, trigger event, and the set of segment names actually present, and returns a MessageStructure summary. It decides nothing about whether to warn: the caller (parser) emits one MISSING_EXPECTED_GROUP warning per name in missingGroups.

Parameters

messageCode

string

MSH-9.1 (e.g. "ORU"); empty string if absent.

triggerEvent

string

MSH-9.2 (e.g. "R01"); empty string if absent.

presentSegmentNames

ReadonlySet<string>

the set of segment names present in the message.

Returns

MessageStructure

Example

import { analyzeMessageStructure } from "@cosyte/hl7";
const s = analyzeMessageStructure("ORU", "R01", new Set(["MSH", "PID"]));
console.log(s.recognized); // true
console.log(s.missingGroups); // ["result"] (no OBR/OBX)