@pritiranjan/hl7v2 0.1.0

package/dist/index.js

@@ -0,0 +1,200 @@
+import { InvalidHL7Error, parseHL7DateTime, SegmentNotFoundError, decodeEscapes, HL7ParseError } from './chunk-Q6NISXHR.js';
+export { HL7ParseError, InvalidHL7Error, SegmentNotFoundError, decodeEscapes, encodeEscapes, formatHL7Date, formatHL7DateTime, parseHL7DateTime } from './chunk-Q6NISXHR.js';
+
+// src/schema.ts
+var DEFAULT_ENCODING = {
+  field: "|",
+  component: "^",
+  repetition: "~",
+  escape: "\\",
+  subComponent: "&"
+};
+
+// src/parser.ts
+function parseEncodingChars(mshLine) {
+  const field = mshLine[3];
+  const component = mshLine[4];
+  const repetition = mshLine[5];
+  const escape = mshLine[6];
+  const subComponent = mshLine[7];
+  if (!field || !component || !repetition || !escape || !subComponent) {
+    throw new InvalidHL7Error(
+      `MSH encoding characters are incomplete \u2014 expected 5 chars at positions 3-7, got: "${mshLine.slice(3, 8)}"`
+    );
+  }
+  return { field, component, repetition, escape, subComponent };
+}
+function parseField(raw, enc) {
+  return raw.split(enc.repetition).map(
+    (rep) => rep.split(enc.component).map(
+      (comp) => comp.split(enc.subComponent)
+    )
+  );
+}
+function parseMSHSegment(line, enc) {
+  const parts = line.split(enc.field);
+  const fields = [
+    // MSH.1 — the field separator character itself
+    [[[enc.field]]],
+    // MSH.2 — encoding characters verbatim; must NOT be split on component separator
+    [[[parts[1] ?? ""]]],
+    // MSH.3 onwards — normal fields
+    ...parts.slice(2).map((f) => parseField(f, enc))
+  ];
+  return { id: "MSH", fields, raw: line };
+}
+function parseGenericSegment(line, enc, lineNum) {
+  const sepIdx = line.indexOf(enc.field);
+  const id = sepIdx === -1 ? line : line.slice(0, sepIdx);
+  if (!/^[A-Z][A-Z0-9]{2}$/.test(id)) {
+    throw new HL7ParseError(
+      `Invalid segment identifier "${id}" at line ${String(lineNum)} \u2014 expected 3 alphanumeric characters (A-Z, 0-9) starting with a letter`,
+      { line: lineNum, segmentId: id }
+    );
+  }
+  const fieldStrings = sepIdx === -1 ? [] : line.slice(sepIdx + 1).split(enc.field);
+  return { id, fields: fieldStrings.map((f) => parseField(f, enc)), raw: line };
+}
+function mshValue(seg, fieldNum) {
+  return seg.fields[fieldNum - 1]?.[0]?.[0]?.[0] ?? "";
+}
+function parseMessageType(field) {
+  const firstRep = field[0] ?? [];
+  const struct = firstRep[2]?.[0];
+  return {
+    type: firstRep[0]?.[0] ?? "",
+    event: firstRep[1]?.[0] ?? "",
+    structure: struct !== void 0 && struct !== "" ? struct : void 0
+  };
+}
+function detectLineEnding(raw) {
+  if (raw.includes("\r\n")) return "\r\n";
+  if (raw.includes("\r")) return "\r";
+  return "\n";
+}
+function parse(raw, options = {}) {
+  if (!raw || !raw.trim()) {
+    throw new InvalidHL7Error("Input is empty");
+  }
+  const normalised = raw.replace(/\r\n/g, "\r").replace(/\n/g, "\r");
+  const lines = normalised.split("\r").filter((l) => l.trim().length > 0);
+  const firstLine = lines[0];
+  if (!firstLine?.startsWith("MSH")) {
+    throw new InvalidHL7Error(
+      `First non-blank line must be an MSH segment, got: "${(firstLine ?? "").slice(0, 30)}"`
+    );
+  }
+  if (firstLine.length < 8) {
+    throw new InvalidHL7Error(
+      "MSH segment is too short to contain encoding characters (minimum length: 8)"
+    );
+  }
+  const encoding = parseEncodingChars(firstLine);
+  const segments2 = lines.map((line, idx) => {
+    if (line.startsWith("MSH")) return parseMSHSegment(line, encoding);
+    return parseGenericSegment(line, encoding, idx + 1);
+  });
+  const msh = segments2[0];
+  if (!msh) throw new InvalidHL7Error("No MSH segment could be parsed");
+  const shouldDecode = options.decodeEscapes === true;
+  const decode = (v) => shouldDecode ? decodeEscapes(v, encoding) : v;
+  const msgTypeField = msh.fields[8] ?? [];
+  return {
+    version: decode(mshValue(msh, 12)),
+    messageType: parseMessageType(msgTypeField),
+    messageControlId: decode(mshValue(msh, 10)),
+    timestamp: parseHL7DateTime(mshValue(msh, 7)),
+    sendingApplication: decode(mshValue(msh, 3)),
+    sendingFacility: decode(mshValue(msh, 4)),
+    receivingApplication: decode(mshValue(msh, 5)),
+    receivingFacility: decode(mshValue(msh, 6)),
+    processingId: mshValue(msh, 11),
+    segments: segments2,
+    encoding,
+    raw: raw.trim(),
+    lineEnding: detectLineEnding(raw)
+  };
+}
+function isHL7(input) {
+  return /^MSH[^A-Za-z0-9]/.test(input.trimStart());
+}
+
+// src/encoder.ts
+function encodeField(field, enc) {
+  return field.map(
+    (rep) => rep.map((comp) => comp.join(enc.subComponent)).join(enc.component)
+  ).join(enc.repetition);
+}
+function encodeMSHSegment(seg, enc) {
+  const encodingCharsStr = enc.component + enc.repetition + enc.escape + enc.subComponent;
+  const rest = seg.fields.slice(2).map((f) => encodeField(f, enc)).join(enc.field);
+  return `MSH${enc.field}${encodingCharsStr}${enc.field}${rest}`;
+}
+function encodeSegment(seg, enc) {
+  if (seg.id === "MSH") return encodeMSHSegment(seg, enc);
+  const fields = seg.fields.map((f) => encodeField(f, enc)).join(enc.field);
+  return `${seg.id}${enc.field}${fields}`;
+}
+function encode(msg, options = {}) {
+  const lineEnding = options.lineEnding ?? msg.lineEnding;
+  const enc = msg.encoding;
+  const lines = msg.segments.map((seg) => encodeSegment(seg, enc));
+  const result = lines.join(lineEnding);
+  return options.trailingNewline === true ? result + lineEnding : result;
+}
+
+// src/query.ts
+function segment(msg, id, options = {}) {
+  const upper = id.toUpperCase();
+  const idx = (options.segmentIndex ?? 1) - 1;
+  const matches = msg.segments.filter((s) => s.id === upper);
+  const found = matches[idx];
+  if (!found) throw new SegmentNotFoundError(upper);
+  return found;
+}
+function segments(msg, id) {
+  return msg.segments.filter((s) => s.id === id.toUpperCase());
+}
+function hasSegment(msg, id) {
+  return msg.segments.some((s) => s.id === id.toUpperCase());
+}
+function get(msg, segmentId, field, component, subComponent, options = {}) {
+  const segIdx = (options.segmentIndex ?? 1) - 1;
+  const repIdx = (options.repetition ?? 1) - 1;
+  const compIdx = (component ?? 1) - 1;
+  const subIdx = (subComponent ?? 1) - 1;
+  const segs = msg.segments.filter((s) => s.id === segmentId.toUpperCase());
+  const seg = segs[segIdx];
+  if (!seg) return "";
+  const fieldValue = seg.fields[field - 1];
+  if (!fieldValue) return "";
+  const raw = fieldValue[repIdx]?.[compIdx]?.[subIdx] ?? "";
+  return options.decode === true ? decodeEscapes(raw, msg.encoding) : raw;
+}
+function getFromSegment(seg, msg, field, component, subComponent, options = {}) {
+  const repIdx = (options.repetition ?? 1) - 1;
+  const compIdx = (component ?? 1) - 1;
+  const subIdx = (subComponent ?? 1) - 1;
+  const fieldValue = seg.fields[field - 1];
+  if (!fieldValue) return "";
+  const raw = fieldValue[repIdx]?.[compIdx]?.[subIdx] ?? "";
+  return options.decode === true ? decodeEscapes(raw, msg.encoding) : raw;
+}
+function getRepetitions(msg, segmentId, field, options = {}) {
+  const segIdx = (options.segmentIndex ?? 1) - 1;
+  const segs = msg.segments.filter((s) => s.id === segmentId.toUpperCase());
+  const seg = segs[segIdx];
+  if (!seg) return [];
+  const fieldValue = seg.fields[field - 1];
+  if (!fieldValue) return [];
+  if (options.decode !== true) return fieldValue;
+  return fieldValue.map(
+    (rep) => rep.map(
+      (comp) => comp.map((sub) => decodeEscapes(sub, msg.encoding))
+    )
+  );
+}
+
+export { DEFAULT_ENCODING, encode, encodeSegment, get, getFromSegment, getRepetitions, hasSegment, isHL7, parse, segment, segments };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schema.ts","../src/parser.ts","../src/encoder.ts","../src/query.ts"],"names":["segments"],"mappings":";;;;AAmBO,IAAM,gBAAA,GAAkC;AAAA,EAC7C,KAAA,EAAO,GAAA;AAAA,EACP,SAAA,EAAW,GAAA;AAAA,EACX,UAAA,EAAY,GAAA;AAAA,EACZ,MAAA,EAAQ,IAAA;AAAA,EACR,YAAA,EAAc;AAChB;;;ACJA,SAAS,mBAAmB,OAAA,EAAgC;AAC1D,EAAA,MAAM,KAAA,GAAe,QAAQ,CAAC,CAAA;AAC9B,EAAA,MAAM,SAAA,GAAe,QAAQ,CAAC,CAAA;AAC9B,EAAA,MAAM,UAAA,GAAe,QAAQ,CAAC,CAAA;AAC9B,EAAA,MAAM,MAAA,GAAe,QAAQ,CAAC,CAAA;AAC9B,EAAA,MAAM,YAAA,GAAe,QAAQ,CAAC,CAAA;AAE9B,EAAA,IAAI,CAAC,SAAS,CAAC,SAAA,IAAa,CAAC,UAAA,IAAc,CAAC,MAAA,IAAU,CAAC,YAAA,EAAc;AACnE,IAAA,MAAM,IAAI,eAAA;AAAA,MACR,CAAA,uFAAA,EAC4C,OAAA,CAAQ,KAAA,CAAM,CAAA,EAAG,CAAC,CAAC,CAAA,CAAA;AAAA,KACjE;AAAA,EACF;AAEA,EAAA,OAAO,EAAE,KAAA,EAAO,SAAA,EAAW,UAAA,EAAY,QAAQ,YAAA,EAAa;AAC9D;AAMA,SAAS,UAAA,CAAW,KAAa,GAAA,EAA8B;AAC7D,EAAA,OAAO,GAAA,CAAI,KAAA,CAAM,GAAA,CAAI,UAAU,CAAA,CAAE,GAAA;AAAA,IAAI,CAAA,GAAA,KACnC,GAAA,CAAI,KAAA,CAAM,GAAA,CAAI,SAAS,CAAA,CAAE,GAAA;AAAA,MAAI,CAAA,IAAA,KAC3B,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,YAAY;AAAA;AAC7B,GACF;AACF;AAEA,SAAS,eAAA,CAAgB,MAAc,GAAA,EAAgC;AACrE,EAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,KAAK,CAAA;AAClC,EAAA,MAAM,MAAA,GAAqB;AAAA;AAAA,IAEzB,CAAC,CAAC,CAAC,GAAA,CAAI,KAAK,CAAC,CAAC,CAAA;AAAA;AAAA,IAEd,CAAC,CAAC,CAAC,KAAA,CAAM,CAAC,CAAA,IAAK,EAAE,CAAC,CAAC,CAAA;AAAA;AAAA,IAEnB,GAAG,KAAA,CAAM,KAAA,CAAM,CAAC,CAAA,CAAE,IAAI,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAG,CAAC;AAAA,GAC/C;AACA,EAAA,OAAO,EAAE,EAAA,EAAI,KAAA,EAAO,MAAA,EAAQ,KAAK,IAAA,EAAK;AACxC;AAEA,SAAS,mBAAA,CAAoB,IAAA,EAAc,GAAA,EAAoB,OAAA,EAA6B;AAC1F,EAAA,MAAM,MAAA,GAAS,IAAA,CAAK,OAAA,CAAQ,GAAA,CAAI,KAAK,CAAA;AACrC,EAAA,MAAM,KAAS,MAAA,KAAW,EAAA,GAAK,OAAO,IAAA,CAAK,KAAA,CAAM,GAAG,MAAM,CAAA;AAE1D,EAAA,IAAI,CAAC,oBAAA,CAAqB,IAAA,CAAK,EAAE,CAAA,EAAG;AAClC,IAAA,MAAM,IAAI,aAAA;AAAA,MACR,CAAA,4BAAA,EAA+B,EAAE,CAAA,UAAA,EAAa,MAAA,CAAO,OAAO,CAAC,CAAA,4EAAA,CAAA;AAAA,MAE7D,EAAE,IAAA,EAAM,OAAA,EAAS,SAAA,EAAW,EAAA;AAAG,KACjC;AAAA,EACF;AAEA,EAAA,MAAM,YAAA,GAAe,MAAA,KAAW,EAAA,GAAK,EAAC,GAAI,IAAA,CAAK,KAAA,CAAM,MAAA,GAAS,CAAC,CAAA,CAAE,KAAA,CAAM,GAAA,CAAI,KAAK,CAAA;AAChF,EAAA,OAAO,EAAE,EAAA,EAAI,MAAA,EAAQ,YAAA,CAAa,GAAA,CAAI,CAAA,CAAA,KAAK,UAAA,CAAW,CAAA,EAAG,GAAG,CAAC,CAAA,EAAG,GAAA,EAAK,IAAA,EAAK;AAC5E;AAGA,SAAS,QAAA,CAAS,KAAiB,QAAA,EAA0B;AAC3D,EAAA,OAAO,GAAA,CAAI,MAAA,CAAO,QAAA,GAAW,CAAC,CAAA,GAAI,CAAC,CAAA,GAAI,CAAC,CAAA,GAAI,CAAC,CAAA,IAAK,EAAA;AACpD;AAEA,SAAS,iBAAiB,KAAA,EAA8B;AACtD,EAAA,MAAM,QAAA,GAAW,KAAA,CAAM,CAAC,CAAA,IAAK,EAAC;AAC9B,EAAA,MAAM,MAAA,GAAW,QAAA,CAAS,CAAC,CAAA,GAAI,CAAC,CAAA;AAChC,EAAA,OAAO;AAAA,IACL,IAAA,EAAW,QAAA,CAAS,CAAC,CAAA,GAAI,CAAC,CAAA,IAAK,EAAA;AAAA,IAC/B,KAAA,EAAW,QAAA,CAAS,CAAC,CAAA,GAAI,CAAC,CAAA,IAAK,EAAA;AAAA,IAC/B,SAAA,EAAW,MAAA,KAAW,MAAA,IAAa,MAAA,KAAW,KAAK,MAAA,GAAS;AAAA,GAC9D;AACF;AAEA,SAAS,iBAAiB,GAAA,EAAmC;AAC3D,EAAA,IAAI,GAAA,CAAI,QAAA,CAAS,MAAM,CAAA,EAAG,OAAO,MAAA;AACjC,EAAA,IAAI,GAAA,CAAI,QAAA,CAAS,IAAI,CAAA,EAAK,OAAO,IAAA;AACjC,EAAA,OAAO,IAAA;AACT;AA+BO,SAAS,KAAA,CAAM,GAAA,EAAa,OAAA,GAAwB,EAAC,EAAe;AACzE,EAAA,IAAI,CAAC,GAAA,IAAO,CAAC,GAAA,CAAI,MAAK,EAAG;AACvB,IAAA,MAAM,IAAI,gBAAgB,gBAAgB,CAAA;AAAA,EAC5C;AAGA,EAAA,MAAM,UAAA,GAAa,IAAI,OAAA,CAAQ,OAAA,EAAS,IAAI,CAAA,CAAE,OAAA,CAAQ,OAAO,IAAI,CAAA;AACjE,EAAA,MAAM,KAAA,GAAQ,UAAA,CAAW,KAAA,CAAM,IAAI,CAAA,CAAE,MAAA,CAAO,CAAA,CAAA,KAAK,CAAA,CAAE,IAAA,EAAK,CAAE,MAAA,GAAS,CAAC,CAAA;AAEpE,EAAA,MAAM,SAAA,GAAY,MAAM,CAAC,CAAA;AACzB,EAAA,IAAI,CAAC,SAAA,EAAW,UAAA,CAAW,KAAK,CAAA,EAAG;AACjC,IAAA,MAAM,IAAI,eAAA;AAAA,MACR,uDAAuD,SAAA,IAAa,EAAA,EAAI,KAAA,CAAM,CAAA,EAAG,EAAE,CAAC,CAAA,CAAA;AAAA,KACtF;AAAA,EACF;AACA,EAAA,IAAI,SAAA,CAAU,SAAS,CAAA,EAAG;AACxB,IAAA,MAAM,IAAI,eAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AAEA,EAAA,MAAM,QAAA,GAAW,mBAAmB,SAAS,CAAA;AAE7C,EAAA,MAAMA,SAAAA,GAAyB,KAAA,CAAM,GAAA,CAAI,CAAC,MAAM,GAAA,KAAQ;AACtD,IAAA,IAAI,KAAK,UAAA,CAAW,KAAK,GAAG,OAAO,eAAA,CAAgB,MAAM,QAAQ,CAAA;AACjE,IAAA,OAAO,mBAAA,CAAoB,IAAA,EAAM,QAAA,EAAU,GAAA,GAAM,CAAC,CAAA;AAAA,EACpD,CAAC,CAAA;AAED,EAAA,MAAM,GAAA,GAAMA,UAAS,CAAC,CAAA;AACtB,EAAA,IAAI,CAAC,GAAA,EAAK,MAAM,IAAI,gBAAgB,gCAAgC,CAAA;AAEpE,EAAA,MAAM,YAAA,GAAe,QAAQ,aAAA,KAAkB,IAAA;AAC/C,EAAA,MAAM,SAAS,CAAC,CAAA,KACd,eAAe,aAAA,CAAc,CAAA,EAAG,QAAQ,CAAA,GAAI,CAAA;AAI9C,EAAA,MAAM,YAAA,GAAe,GAAA,CAAI,MAAA,CAAO,CAAC,KAAK,EAAC;AAEvC,EAAA,OAAO;AAAA,IACL,OAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,EAAE,CAAC,CAAA;AAAA,IAC9C,WAAA,EAAsB,iBAAiB,YAAY,CAAA;AAAA,IACnD,gBAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,EAAE,CAAC,CAAA;AAAA,IAC9C,SAAA,EAAsB,gBAAA,CAAiB,QAAA,CAAS,GAAA,EAAK,CAAC,CAAC,CAAA;AAAA,IACvD,kBAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,CAAC,CAAC,CAAA;AAAA,IAC7C,eAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,CAAC,CAAC,CAAA;AAAA,IAC7C,oBAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,CAAC,CAAC,CAAA;AAAA,IAC7C,iBAAA,EAAsB,MAAA,CAAO,QAAA,CAAS,GAAA,EAAK,CAAC,CAAC,CAAA;AAAA,IAC7C,YAAA,EAAsB,QAAA,CAAS,GAAA,EAAK,EAAE,CAAA;AAAA,IACtC,QAAA,EAAAA,SAAAA;AAAA,IACA,QAAA;AAAA,IACA,GAAA,EAAK,IAAI,IAAA,EAAK;AAAA,IACd,UAAA,EAAY,iBAAiB,GAAG;AAAA,GAClC;AACF;AAMO,SAAS,MAAM,KAAA,EAAwB;AAC5C,EAAA,OAAO,kBAAA,CAAmB,IAAA,CAAK,KAAA,CAAM,SAAA,EAAW,CAAA;AAClD;;;AC3KA,SAAS,WAAA,CAAY,OAAiB,GAAA,EAA4B;AAChE,EAAA,OAAO,KAAA,CACJ,GAAA;AAAA,IAAI,CAAA,GAAA,KACH,GAAA,CACG,GAAA,CAAI,CAAA,IAAA,KAAQ,IAAA,CAAK,IAAA,CAAK,GAAA,CAAI,YAAY,CAAC,CAAA,CACvC,IAAA,CAAK,GAAA,CAAI,SAAS;AAAA,GACvB,CACC,IAAA,CAAK,GAAA,CAAI,UAAU,CAAA;AACxB;AAEA,SAAS,gBAAA,CAAiB,KAAiB,GAAA,EAA4B;AAGrE,EAAA,MAAM,mBACJ,GAAA,CAAI,SAAA,GAAY,IAAI,UAAA,GAAa,GAAA,CAAI,SAAS,GAAA,CAAI,YAAA;AAKpD,EAAA,MAAM,IAAA,GAAO,GAAA,CAAI,MAAA,CACd,KAAA,CAAM,CAAC,CAAA,CACP,GAAA,CAAI,CAAA,CAAA,KAAK,WAAA,CAAY,GAAG,GAAG,CAAC,CAAA,CAC5B,IAAA,CAAK,IAAI,KAAK,CAAA;AAEjB,EAAA,OAAO,CAAA,GAAA,EAAM,IAAI,KAAK,CAAA,EAAG,gBAAgB,CAAA,EAAG,GAAA,CAAI,KAAK,CAAA,EAAG,IAAI,CAAA,CAAA;AAC9D;AAEA,SAAS,aAAA,CAAc,KAAiB,GAAA,EAA4B;AAClE,EAAA,IAAI,IAAI,EAAA,KAAO,KAAA,EAAO,OAAO,gBAAA,CAAiB,KAAK,GAAG,CAAA;AACtD,EAAA,MAAM,MAAA,GAAS,GAAA,CAAI,MAAA,CAAO,GAAA,CAAI,CAAA,CAAA,KAAK,WAAA,CAAY,CAAA,EAAG,GAAG,CAAC,CAAA,CAAE,IAAA,CAAK,GAAA,CAAI,KAAK,CAAA;AACtE,EAAA,OAAO,GAAG,GAAA,CAAI,EAAE,GAAG,GAAA,CAAI,KAAK,GAAG,MAAM,CAAA,CAAA;AACvC;AAgCO,SAAS,MAAA,CAAO,GAAA,EAAiB,OAAA,GAAyB,EAAC,EAAW;AAC3E,EAAA,MAAM,UAAA,GAAa,OAAA,CAAQ,UAAA,IAAc,GAAA,CAAI,UAAA;AAC7C,EAAA,MAAM,MAAM,GAAA,CAAI,QAAA;AAEhB,EAAA,MAAM,KAAA,GAAQ,IAAI,QAAA,CAAS,GAAA,CAAI,SAAO,aAAA,CAAc,GAAA,EAAK,GAAG,CAAC,CAAA;AAC7D,EAAA,MAAM,MAAA,GAAS,KAAA,CAAM,IAAA,CAAK,UAAU,CAAA;AACpC,EAAA,OAAO,OAAA,CAAQ,eAAA,KAAoB,IAAA,GAAO,MAAA,GAAS,UAAA,GAAa,MAAA;AAClE;;;ACpEO,SAAS,OAAA,CACd,GAAA,EACA,EAAA,EACA,OAAA,GAAqC,EAAC,EAC1B;AACZ,EAAA,MAAM,KAAA,GAAQ,GAAG,WAAA,EAAY;AAC7B,EAAA,MAAM,GAAA,GAAA,CAAO,OAAA,CAAQ,YAAA,IAAgB,CAAA,IAAK,CAAA;AAC1C,EAAA,MAAM,UAAU,GAAA,CAAI,QAAA,CAAS,OAAO,CAAA,CAAA,KAAK,CAAA,CAAE,OAAO,KAAK,CAAA;AACvD,EAAA,MAAM,KAAA,GAAQ,QAAQ,GAAG,CAAA;AACzB,EAAA,IAAI,CAAC,KAAA,EAAO,MAAM,IAAI,qBAAqB,KAAK,CAAA;AAChD,EAAA,OAAO,KAAA;AACT;AAeO,SAAS,QAAA,CAAS,KAAiB,EAAA,EAA0B;AAClE,EAAA,OAAO,GAAA,CAAI,SAAS,MAAA,CAAO,CAAA,CAAA,KAAK,EAAE,EAAA,KAAO,EAAA,CAAG,aAAa,CAAA;AAC3D;AAUO,SAAS,UAAA,CAAW,KAAiB,EAAA,EAAqB;AAC/D,EAAA,OAAO,GAAA,CAAI,SAAS,IAAA,CAAK,CAAA,CAAA,KAAK,EAAE,EAAA,KAAO,EAAA,CAAG,aAAa,CAAA;AACzD;AA4DO,SAAS,GAAA,CACd,KACA,SAAA,EACA,KAAA,EACA,WACA,YAAA,EACA,OAAA,GAAsB,EAAC,EACf;AACR,EAAA,MAAM,MAAA,GAAA,CAAY,OAAA,CAAQ,YAAA,IAAgB,CAAA,IAAK,CAAA;AAC/C,EAAA,MAAM,MAAA,GAAA,CAAY,OAAA,CAAQ,UAAA,IAAgB,CAAA,IAAK,CAAA;AAC/C,EAAA,MAAM,OAAA,GAAA,CAAY,aAAwB,CAAA,IAAK,CAAA;AAC/C,EAAA,MAAM,MAAA,GAAA,CAAY,gBAAwB,CAAA,IAAK,CAAA;AAE/C,EAAA,MAAM,IAAA,GAAO,IAAI,QAAA,CAAS,MAAA,CAAO,OAAK,CAAA,CAAE,EAAA,KAAO,SAAA,CAAU,WAAA,EAAa,CAAA;AACtE,EAAA,MAAM,GAAA,GAAO,KAAK,MAAM,CAAA;AACxB,EAAA,IAAI,CAAC,KAAK,OAAO,EAAA;AAGjB,EAAA,MAAM,UAAA,GAAmC,GAAA,CAAI,MAAA,CAAO,KAAA,GAAQ,CAAC,CAAA;AAC7D,EAAA,IAAI,CAAC,YAAY,OAAO,EAAA;AAExB,EAAA,MAAM,MAAM,UAAA,CAAW,MAAM,IAAI,OAAO,CAAA,GAAI,MAAM,CAAA,IAAK,EAAA;AACvD,EAAA,OAAO,QAAQ,MAAA,KAAW,IAAA,GAAO,cAAc,GAAA,EAAK,GAAA,CAAI,QAAQ,CAAA,GAAI,GAAA;AACtE;AAcO,SAAS,cAAA,CACd,KACA,GAAA,EACA,KAAA,EACA,WACA,YAAA,EACA,OAAA,GAA4C,EAAC,EACrC;AACR,EAAA,MAAM,MAAA,GAAA,CAAW,OAAA,CAAQ,UAAA,IAAc,CAAA,IAAK,CAAA;AAC5C,EAAA,MAAM,OAAA,GAAA,CAAW,aAAsB,CAAA,IAAK,CAAA;AAC5C,EAAA,MAAM,MAAA,GAAA,CAAW,gBAAsB,CAAA,IAAK,CAAA;AAE5C,EAAA,MAAM,UAAA,GAAmC,GAAA,CAAI,MAAA,CAAO,KAAA,GAAQ,CAAC,CAAA;AAC7D,EAAA,IAAI,CAAC,YAAY,OAAO,EAAA;AAExB,EAAA,MAAM,MAAM,UAAA,CAAW,MAAM,IAAI,OAAO,CAAA,GAAI,MAAM,CAAA,IAAK,EAAA;AACvD,EAAA,OAAO,QAAQ,MAAA,KAAW,IAAA,GAAO,cAAc,GAAA,EAAK,GAAA,CAAI,QAAQ,CAAA,GAAI,GAAA;AACtE;AAeO,SAAS,eACd,GAAA,EACA,SAAA,EACA,KAAA,EACA,OAAA,GAA0C,EAAC,EAC7B;AACd,EAAA,MAAM,MAAA,GAAA,CAAU,OAAA,CAAQ,YAAA,IAAgB,CAAA,IAAK,CAAA;AAE7C,EAAA,MAAM,IAAA,GAAO,IAAI,QAAA,CAAS,MAAA,CAAO,OAAK,CAAA,CAAE,EAAA,KAAO,SAAA,CAAU,WAAA,EAAa,CAAA;AACtE,EAAA,MAAM,GAAA,GAAO,KAAK,MAAM,CAAA;AACxB,EAAA,IAAI,CAAC,GAAA,EAAK,OAAO,EAAC;AAElB,EAAA,MAAM,UAAA,GAAmC,GAAA,CAAI,MAAA,CAAO,KAAA,GAAQ,CAAC,CAAA;AAC7D,EAAA,IAAI,CAAC,UAAA,EAAY,OAAO,EAAC;AAEzB,EAAA,IAAI,OAAA,CAAQ,MAAA,KAAW,IAAA,EAAM,OAAO,UAAA;AAEpC,EAAA,OAAO,UAAA,CAAW,GAAA;AAAA,IAAI,SACpB,GAAA,CAAI,GAAA;AAAA,MAAI,CAAA,IAAA,KACN,KAAK,GAAA,CAAI,CAAA,GAAA,KAAO,cAAc,GAAA,EAAK,GAAA,CAAI,QAAQ,CAAC;AAAA;AAClD,GACF;AACF","file":"index.js","sourcesContent":["/**\n * The five special characters that govern HL7 v2 encoding.\n * Defined in MSH.1 and MSH.2 of every message.\n * Default values follow the HL7 v2 standard.\n */\nexport interface EncodingChars {\n  /** Separates fields within a segment. Default: `|` */\n  readonly field: string;\n  /** Separates components within a field. Default: `^` */\n  readonly component: string;\n  /** Separates repetitions of a field. Default: `~` */\n  readonly repetition: string;\n  /** Introduces escape sequences. Default: `\\` */\n  readonly escape: string;\n  /** Separates sub-components. Default: `&` */\n  readonly subComponent: string;\n}\n\n/** HL7 v2 standard encoding characters. */\nexport const DEFAULT_ENCODING: EncodingChars = {\n  field: '|',\n  component: '^',\n  repetition: '~',\n  escape: '\\\\',\n  subComponent: '&',\n} as const;\n\n/**\n * A single HL7 v2 field value modelled as a 3-dimensional array.\n *\n * Dimensions (all 0-indexed internally):\n *   `value[repetition][component][subComponent]`\n *\n * Most fields are simple strings: `[[['value']]]`\n * Composite fields: `[[['family', 'given', 'middle']]]`\n * Repeated fields: `[[['home phone']], [['work phone']]]`\n */\nexport type HL7Field = string[][][];\n\n/**\n * A single HL7 v2 segment — one line of a message.\n *\n * @example\n * // PID|1||MRN123^^^HOSP^MR||DOE^JOHN^A\n * segment.id      // 'PID'\n * segment.fields  // [[...], [...], ...]\n */\nexport interface HL7Segment {\n  /** Three-letter segment identifier (e.g., `'MSH'`, `'PID'`, `'OBX'`). */\n  readonly id: string;\n  /**\n   * Segment fields, 0-indexed.\n   * `fields[n]` corresponds to field number `n+1` in the HL7 spec.\n   *\n   * MSH is special: `fields[0]` = MSH.1 (the field separator char itself).\n   */\n  readonly fields: HL7Field[];\n  /** The original unparsed segment string — preserved for round-trip fidelity. */\n  readonly raw: string;\n}\n\n/** Parsed message type and trigger event from MSH.9. */\nexport interface MessageType {\n  /** Message type code (e.g., `'ADT'`, `'ORU'`, `'ORM'`). */\n  readonly type: string;\n  /** Trigger event code (e.g., `'A01'`, `'R01'`, `'O01'`). */\n  readonly event: string;\n  /** Optional message structure (e.g., `'ADT_A01'`). */\n  readonly structure: string | undefined;\n}\n\n/** Processing ID — indicates the environment the message was sent from. */\nexport type ProcessingId = 'P' | 'D' | 'T' | string;\n\n/**\n * A fully parsed HL7 v2.x message.\n *\n * @example\n * const msg = parse(raw);\n * msg.version          // '2.5.1'\n * msg.messageType      // { type: 'ADT', event: 'A01', structure: 'ADT_A01' }\n * msg.messageControlId // 'MSG000001'\n * msg.segments         // HL7Segment[]\n */\nexport interface HL7Message {\n  /** HL7 version string extracted from MSH.12 (e.g., `'2.5'`, `'2.5.1'`). */\n  readonly version: string;\n  /** Message type and trigger event parsed from MSH.9. */\n  readonly messageType: MessageType;\n  /** Unique message control ID from MSH.10. Used for acknowledgement correlation. */\n  readonly messageControlId: string;\n  /** Message creation timestamp from MSH.7. `undefined` if absent or unparseable. */\n  readonly timestamp: Date | undefined;\n  /** Sending application name from MSH.3. */\n  readonly sendingApplication: string;\n  /** Sending facility name from MSH.4. */\n  readonly sendingFacility: string;\n  /** Receiving application name from MSH.5. */\n  readonly receivingApplication: string;\n  /** Receiving facility name from MSH.6. */\n  readonly receivingFacility: string;\n  /** Processing ID from MSH.11. `'P'` = Production, `'D'` = Debugging, `'T'` = Training. */\n  readonly processingId: ProcessingId;\n  /** All segments in document order. */\n  readonly segments: HL7Segment[];\n  /** Encoding characters extracted from MSH.1 and MSH.2. */\n  readonly encoding: EncodingChars;\n  /** The original raw input string — preserved without modification. */\n  readonly raw: string;\n  /**\n   * The line ending character(s) detected from the original input.\n   * Used by `encode()` to restore byte-identical output.\n   * `'\\r'` (canonical HL7), `'\\n'` (Unix), or `'\\r\\n'` (Windows).\n   */\n  readonly lineEnding: '\\r' | '\\n' | '\\r\\n';\n}\n","import { InvalidHL7Error, HL7ParseError } from './errors.js';\nimport { parseHL7DateTime } from './datetime.js';\nimport { decodeEscapes } from './escape.js';\nimport type { EncodingChars, HL7Field, HL7Message, HL7Segment, MessageType } from './schema.js';\nimport { DEFAULT_ENCODING } from './schema.js';\n\nexport interface ParseOptions {\n  /**\n   * When `true`, HL7 escape sequences within field values are decoded to their\n   * plain-text equivalents (e.g. `\\F\\` → `|`).\n   *\n   * Defaults to `false` so that `encode(parse(raw))` is byte-identical\n   * to the original input — essential for ACK generation and message forwarding.\n   */\n  decodeEscapes?: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Internal helpers\n// ---------------------------------------------------------------------------\n\nfunction parseEncodingChars(mshLine: string): EncodingChars {\n  const field        = mshLine[3];\n  const component    = mshLine[4];\n  const repetition   = mshLine[5];\n  const escape       = mshLine[6];\n  const subComponent = mshLine[7];\n\n  if (!field || !component || !repetition || !escape || !subComponent) {\n    throw new InvalidHL7Error(\n      `MSH encoding characters are incomplete — ` +\n      `expected 5 chars at positions 3-7, got: \"${mshLine.slice(3, 8)}\"`,\n    );\n  }\n\n  return { field, component, repetition, escape, subComponent };\n}\n\n/**\n * Parse a raw field string into the canonical 3-D HL7Field structure:\n * `value[repetition][component][subComponent]`\n */\nfunction parseField(raw: string, enc: EncodingChars): HL7Field {\n  return raw.split(enc.repetition).map(rep =>\n    rep.split(enc.component).map(comp =>\n      comp.split(enc.subComponent),\n    ),\n  );\n}\n\nfunction parseMSHSegment(line: string, enc: EncodingChars): HL7Segment {\n  const parts = line.split(enc.field);\n  const fields: HL7Field[] = [\n    // MSH.1 — the field separator character itself\n    [[[enc.field]]],\n    // MSH.2 — encoding characters verbatim; must NOT be split on component separator\n    [[[parts[1] ?? '']]],\n    // MSH.3 onwards — normal fields\n    ...parts.slice(2).map(f => parseField(f, enc)),\n  ];\n  return { id: 'MSH', fields, raw: line };\n}\n\nfunction parseGenericSegment(line: string, enc: EncodingChars, lineNum: number): HL7Segment {\n  const sepIdx = line.indexOf(enc.field);\n  const id     = sepIdx === -1 ? line : line.slice(0, sepIdx);\n\n  if (!/^[A-Z][A-Z0-9]{2}$/.test(id)) {\n    throw new HL7ParseError(\n      `Invalid segment identifier \"${id}\" at line ${String(lineNum)} — ` +\n      `expected 3 alphanumeric characters (A-Z, 0-9) starting with a letter`,\n      { line: lineNum, segmentId: id },\n    );\n  }\n\n  const fieldStrings = sepIdx === -1 ? [] : line.slice(sepIdx + 1).split(enc.field);\n  return { id, fields: fieldStrings.map(f => parseField(f, enc)), raw: line };\n}\n\n/** Extract a simple scalar value from an MSH field by 1-based field number. */\nfunction mshValue(seg: HL7Segment, fieldNum: number): string {\n  return seg.fields[fieldNum - 1]?.[0]?.[0]?.[0] ?? '';\n}\n\nfunction parseMessageType(field: HL7Field): MessageType {\n  const firstRep = field[0] ?? [];\n  const struct   = firstRep[2]?.[0];\n  return {\n    type:      firstRep[0]?.[0] ?? '',\n    event:     firstRep[1]?.[0] ?? '',\n    structure: struct !== undefined && struct !== '' ? struct : undefined,\n  };\n}\n\nfunction detectLineEnding(raw: string): '\\r' | '\\n' | '\\r\\n' {\n  if (raw.includes('\\r\\n')) return '\\r\\n';\n  if (raw.includes('\\r'))   return '\\r';\n  return '\\n';\n}\n\n// ---------------------------------------------------------------------------\n// Public API\n// ---------------------------------------------------------------------------\n\n/**\n * Parse an HL7 v2.x message string into a structured {@link HL7Message}.\n *\n * ### Supported inputs\n * - HL7 versions 2.1 – 2.8\n * - Line endings: `\\r` (canonical), `\\n`, or `\\r\\n` — all normalised to `\\r`\n * - Custom encoding characters (non-default separators)\n * - Messages with blank lines (skipped silently)\n *\n * ### Round-trip fidelity\n * By default (`decodeEscapes: false`), field values retain their raw HL7\n * escape sequences, making `encode(parse(raw)) === raw` hold true.\n * Use `decodeEscapes: true` only when you need to display or process the\n * human-readable values and do not intend to re-encode the message.\n *\n * @throws {InvalidHL7Error} When the input is empty or does not start with MSH\n * @throws {HL7ParseError}   When a segment identifier or field structure is invalid\n *\n * @example\n * import { parse } from 'hl7v2';\n *\n * const msg = parse(rawString);\n * console.log(msg.messageType); // { type: 'ADT', event: 'A01', structure: 'ADT_A01' }\n * console.log(msg.version);     // '2.5.1'\n */\nexport function parse(raw: string, options: ParseOptions = {}): HL7Message {\n  if (!raw || !raw.trim()) {\n    throw new InvalidHL7Error('Input is empty');\n  }\n\n  // Normalise all line ending variants to the HL7 canonical segment terminator \\r\n  const normalised = raw.replace(/\\r\\n/g, '\\r').replace(/\\n/g, '\\r');\n  const lines = normalised.split('\\r').filter(l => l.trim().length > 0);\n\n  const firstLine = lines[0];\n  if (!firstLine?.startsWith('MSH')) {\n    throw new InvalidHL7Error(\n      `First non-blank line must be an MSH segment, got: \"${(firstLine ?? '').slice(0, 30)}\"`,\n    );\n  }\n  if (firstLine.length < 8) {\n    throw new InvalidHL7Error(\n      'MSH segment is too short to contain encoding characters (minimum length: 8)',\n    );\n  }\n\n  const encoding = parseEncodingChars(firstLine);\n\n  const segments: HL7Segment[] = lines.map((line, idx) => {\n    if (line.startsWith('MSH')) return parseMSHSegment(line, encoding);\n    return parseGenericSegment(line, encoding, idx + 1);\n  });\n\n  const msh = segments[0];\n  if (!msh) throw new InvalidHL7Error('No MSH segment could be parsed');\n\n  const shouldDecode = options.decodeEscapes === true;\n  const decode = (v: string): string =>\n    shouldDecode ? decodeEscapes(v, encoding) : v;\n\n  // MSH.9 is at fields[8] (0-based). Pass the full HL7Field so all components\n  // of the composite \"MSG_TYPE^TRIGGER_EVENT^MSG_STRUCTURE\" are accessible.\n  const msgTypeField = msh.fields[8] ?? [];\n\n  return {\n    version:              decode(mshValue(msh, 12)),\n    messageType:          parseMessageType(msgTypeField),\n    messageControlId:     decode(mshValue(msh, 10)),\n    timestamp:            parseHL7DateTime(mshValue(msh, 7)),\n    sendingApplication:   decode(mshValue(msh, 3)),\n    sendingFacility:      decode(mshValue(msh, 4)),\n    receivingApplication: decode(mshValue(msh, 5)),\n    receivingFacility:    decode(mshValue(msh, 6)),\n    processingId:         mshValue(msh, 11),\n    segments,\n    encoding,\n    raw: raw.trim(),\n    lineEnding: detectLineEnding(raw),\n  };\n}\n\n/**\n * Return `true` if the input looks like an HL7 v2 message.\n * This is a fast heuristic check — it does not fully parse the message.\n */\nexport function isHL7(input: string): boolean {\n  return /^MSH[^A-Za-z0-9]/.test(input.trimStart());\n}\n\n// Re-export DEFAULT_ENCODING for convenience\nexport { DEFAULT_ENCODING };\n","import type { EncodingChars, HL7Field, HL7Message, HL7Segment } from './schema.js';\n\nexport interface EncodeOptions {\n  /**\n   * Line ending to use between segments.\n   * HL7 v2 canonical is `'\\r'`. Some systems expect `'\\r\\n'` or `'\\n'`.\n   * @default '\\r'\n   */\n  lineEnding?: '\\r' | '\\n' | '\\r\\n';\n  /**\n   * When `true`, a trailing line ending is appended after the last segment.\n   * @default false\n   */\n  trailingNewline?: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Internal helpers\n// ---------------------------------------------------------------------------\n\nfunction encodeField(field: HL7Field, enc: EncodingChars): string {\n  return field\n    .map(rep =>\n      rep\n        .map(comp => comp.join(enc.subComponent))\n        .join(enc.component),\n    )\n    .join(enc.repetition);\n}\n\nfunction encodeMSHSegment(seg: HL7Segment, enc: EncodingChars): string {\n  // Reconstruct MSH verbatim from its fields:\n  // MSH + field_sep + encoding_chars + field_sep + MSH.3 + ...\n  const encodingCharsStr =\n    enc.component + enc.repetition + enc.escape + enc.subComponent;\n\n  // fields[0] = MSH.1 (field sep, skip — already in prefix)\n  // fields[1] = MSH.2 (encoding chars, always output verbatim)\n  // fields[2..] = MSH.3 onwards\n  const rest = seg.fields\n    .slice(2)\n    .map(f => encodeField(f, enc))\n    .join(enc.field);\n\n  return `MSH${enc.field}${encodingCharsStr}${enc.field}${rest}`;\n}\n\nfunction encodeSegment(seg: HL7Segment, enc: EncodingChars): string {\n  if (seg.id === 'MSH') return encodeMSHSegment(seg, enc);\n  const fields = seg.fields.map(f => encodeField(f, enc)).join(enc.field);\n  return `${seg.id}${enc.field}${fields}`;\n}\n\n// ---------------------------------------------------------------------------\n// Public API\n// ---------------------------------------------------------------------------\n\n/**\n * Encode an {@link HL7Message} back into a raw HL7 v2 string.\n *\n * ### Round-trip guarantee\n * When called on a message produced by `parse(raw)` with default options\n * (i.e., `decodeEscapes` was **not** set to `true`), this function produces\n * output that is byte-identical to the original input, modulo line endings.\n *\n * ### Encoding characters\n * The message's own `encoding` field is used. Override via `options.encoding`\n * if you need to re-encode to a different separator set (rare).\n *\n * @param msg     - The message to encode\n * @param options - Optional output configuration\n *\n * @example\n * import { parse, encode } from 'hl7v2';\n *\n * const msg   = parse(rawString);\n * const back  = encode(msg);   // byte-identical to rawString (modulo line endings)\n *\n * // Modify a field and re-encode\n * const mutable = structuredClone(msg) as HL7Message;\n * // ... set fields ...\n * const updated = encode(mutable);\n */\nexport function encode(msg: HL7Message, options: EncodeOptions = {}): string {\n  const lineEnding = options.lineEnding ?? msg.lineEnding;\n  const enc = msg.encoding;\n\n  const lines = msg.segments.map(seg => encodeSegment(seg, enc));\n  const result = lines.join(lineEnding);\n  return options.trailingNewline === true ? result + lineEnding : result;\n}\n\n/**\n * Encode a single {@link HL7Segment} to a string using the given encoding characters.\n *\n * Useful when constructing ACK messages or individual segments programmatically.\n *\n * @example\n * import { encodeSegment } from 'hl7v2';\n *\n * const mshString = encodeSegment(msg.segments[0], msg.encoding);\n */\nexport { encodeSegment };\n","import { SegmentNotFoundError } from './errors.js';\nimport { decodeEscapes } from './escape.js';\nimport type { HL7Field, HL7Message, HL7Segment } from './schema.js';\n\n// ---------------------------------------------------------------------------\n// Segment access\n// ---------------------------------------------------------------------------\n\n/**\n * Return the first segment with the given identifier.\n *\n * When a message contains multiple segments with the same identifier (e.g.\n * repeating OBX groups), pass `{ segmentIndex: N }` (1-based) to select which\n * occurrence to return. Defaults to the first occurrence (`segmentIndex: 1`).\n *\n * @throws {SegmentNotFoundError} When no segment with `id` exists at the given index.\n *\n * @example\n * const pid  = segment(msg, 'PID');\n * const obx1 = segment(msg, 'OBX', { segmentIndex: 1 });  // first OBX\n * const obx2 = segment(msg, 'OBX', { segmentIndex: 2 });  // second OBX\n */\nexport function segment(\n  msg: HL7Message,\n  id: string,\n  options: { segmentIndex?: number } = {},\n): HL7Segment {\n  const upper = id.toUpperCase();\n  const idx = (options.segmentIndex ?? 1) - 1; // convert 1-based to 0-based\n  const matches = msg.segments.filter(s => s.id === upper);\n  const found = matches[idx];\n  if (!found) throw new SegmentNotFoundError(upper);\n  return found;\n}\n\n/**\n * Return all segments with the given identifier.\n * Returns an empty array (never throws) when none are found.\n *\n * Useful for repeating segments such as OBX (lab results), NTE (notes),\n * or DG1 (diagnoses).\n *\n * @example\n * const allOBX = segments(msg, 'OBX');\n * for (const obx of allOBX) {\n *   console.log(get(msg, obx, 5)); // OBX.5 — observation value\n * }\n */\nexport function segments(msg: HL7Message, id: string): HL7Segment[] {\n  return msg.segments.filter(s => s.id === id.toUpperCase());\n}\n\n/**\n * Return `true` if the message contains at least one segment with the given identifier.\n *\n * @example\n * if (hasSegment(msg, 'PV1')) {\n *   const pv1 = segment(msg, 'PV1');\n * }\n */\nexport function hasSegment(msg: HL7Message, id: string): boolean {\n  return msg.segments.some(s => s.id === id.toUpperCase());\n}\n\n// ---------------------------------------------------------------------------\n// Field value access\n// ---------------------------------------------------------------------------\n\nexport interface GetOptions {\n  /**\n   * 1-based repetition number. Defaults to `1` (first repetition).\n   *\n   * @example\n   * // PID.3 can repeat — get the second identifier\n   * get(msg, 'PID', 3, undefined, undefined, { repetition: 2 });\n   */\n  repetition?: number;\n  /**\n   * When `true`, decode HL7 escape sequences in the returned value.\n   * Defaults to `false`.\n   */\n  decode?: boolean;\n  /**\n   * 1-based index when the message contains multiple segments with the same\n   * identifier. Defaults to `1` (first occurrence).\n   *\n   * @example\n   * // Get OBX.5 from the third OBX segment\n   * get(msg, 'OBX', 5, undefined, undefined, { segmentIndex: 3 });\n   */\n  segmentIndex?: number;\n}\n\n/**\n * Extract a scalar string value from a message field using 1-based HL7 addressing.\n *\n * Returns an empty string `''` rather than throwing when the field, component,\n * or sub-component does not exist — reflecting HL7's rule that absent elements\n * are equivalent to empty strings.\n *\n * HL7 addressing reference (1-based throughout):\n * - `get(msg, 'PID', 3)`          → PID.3       (first component, first repetition)\n * - `get(msg, 'PID', 5, 1)`       → PID.5.1     (family name component)\n * - `get(msg, 'PID', 5, 2)`       → PID.5.2     (given name component)\n * - `get(msg, 'PID', 11, 1, 1)`   → PID.11.1.1  (sub-component)\n * - `get(msg, 'OBX', 5, 1, 1, { repetition: 2 })` → OBX.5[2].1.1 (second repetition)\n *\n * @param msg        - Parsed HL7 message\n * @param segmentId  - Three-letter segment identifier (case-insensitive)\n * @param field      - 1-based field number\n * @param component  - 1-based component number (defaults to 1)\n * @param subComponent - 1-based sub-component number (defaults to 1)\n * @param options    - See {@link GetOptions}\n *\n * @example\n * import { parse, get } from 'hl7v2';\n *\n * const msg       = parse(raw);\n * const mrn       = get(msg, 'PID', 3);       // PID.3 — medical record number\n * const lastName  = get(msg, 'PID', 5, 1);    // PID.5.1 — family name\n * const firstName = get(msg, 'PID', 5, 2);    // PID.5.2 — given name\n */\nexport function get(\n  msg: HL7Message,\n  segmentId: string,\n  field: number,\n  component?: number,\n  subComponent?: number,\n  options: GetOptions = {},\n): string {\n  const segIdx   = (options.segmentIndex ?? 1) - 1; // convert 1-based to 0-based\n  const repIdx   = (options.repetition   ?? 1) - 1; // convert 1-based to 0-based\n  const compIdx  = (component            ?? 1) - 1;\n  const subIdx   = (subComponent         ?? 1) - 1;\n\n  const segs = msg.segments.filter(s => s.id === segmentId.toUpperCase());\n  const seg  = segs[segIdx];\n  if (!seg) return '';\n\n  // fields are 0-indexed, HL7 field numbers are 1-based\n  const fieldValue: HL7Field | undefined = seg.fields[field - 1];\n  if (!fieldValue) return '';\n\n  const raw = fieldValue[repIdx]?.[compIdx]?.[subIdx] ?? '';\n  return options.decode === true ? decodeEscapes(raw, msg.encoding) : raw;\n}\n\n/**\n * Extract a field value from a known segment reference (returned by {@link segment}\n * or {@link segments}).\n *\n * Equivalent to {@link get} but accepts an `HL7Segment` directly — useful when\n * iterating over repeating segments.\n *\n * @example\n * for (const obx of segments(msg, 'OBX')) {\n *   const value = getFromSegment(obx, msg, 5);  // OBX.5 for each OBX segment\n * }\n */\nexport function getFromSegment(\n  seg: HL7Segment,\n  msg: HL7Message,\n  field: number,\n  component?: number,\n  subComponent?: number,\n  options: Omit<GetOptions, 'segmentIndex'> = {},\n): string {\n  const repIdx  = (options.repetition ?? 1) - 1;\n  const compIdx = (component          ?? 1) - 1;\n  const subIdx  = (subComponent       ?? 1) - 1;\n\n  const fieldValue: HL7Field | undefined = seg.fields[field - 1];\n  if (!fieldValue) return '';\n\n  const raw = fieldValue[repIdx]?.[compIdx]?.[subIdx] ?? '';\n  return options.decode === true ? decodeEscapes(raw, msg.encoding) : raw;\n}\n\n/**\n * Return all repetitions of a field as a `string[][][]` structure (one entry\n * per repetition, preserving the `[component][subComponent]` shape).\n *\n * Useful for fields like PID.3 (patient identifier list) that carry multiple\n * typed identifiers — each with its own components — across repetitions.\n *\n * @example\n * const ids = getRepetitions(msg, 'PID', 3);\n * ids[0]?.[0]?.[0]  // → first identifier value  (PID.3[1].1)\n * ids[0]?.[3]?.[0]  // → first identifier's assigning authority (PID.3[1].4)\n * ids[1]?.[0]?.[0]  // → second identifier value (PID.3[2].1)\n */\nexport function getRepetitions(\n  msg: HL7Message,\n  segmentId: string,\n  field: number,\n  options: Omit<GetOptions, 'repetition'> = {},\n): string[][][] {\n  const segIdx = (options.segmentIndex ?? 1) - 1;\n\n  const segs = msg.segments.filter(s => s.id === segmentId.toUpperCase());\n  const seg  = segs[segIdx];\n  if (!seg) return [];\n\n  const fieldValue: HL7Field | undefined = seg.fields[field - 1];\n  if (!fieldValue) return [];\n\n  if (options.decode !== true) return fieldValue;\n\n  return fieldValue.map(rep =>\n    rep.map(comp =>\n      comp.map(sub => decodeEscapes(sub, msg.encoding)),\n    ),\n  );\n}\n"]}

package/dist/schema-qr-scwmL.d.cts

@@ -0,0 +1,106 @@
+/**
+ * The five special characters that govern HL7 v2 encoding.
+ * Defined in MSH.1 and MSH.2 of every message.
+ * Default values follow the HL7 v2 standard.
+ */
+interface EncodingChars {
+    /** Separates fields within a segment. Default: `|` */
+    readonly field: string;
+    /** Separates components within a field. Default: `^` */
+    readonly component: string;
+    /** Separates repetitions of a field. Default: `~` */
+    readonly repetition: string;
+    /** Introduces escape sequences. Default: `\` */
+    readonly escape: string;
+    /** Separates sub-components. Default: `&` */
+    readonly subComponent: string;
+}
+/** HL7 v2 standard encoding characters. */
+declare const DEFAULT_ENCODING: EncodingChars;
+/**
+ * A single HL7 v2 field value modelled as a 3-dimensional array.
+ *
+ * Dimensions (all 0-indexed internally):
+ *   `value[repetition][component][subComponent]`
+ *
+ * Most fields are simple strings: `[[['value']]]`
+ * Composite fields: `[[['family', 'given', 'middle']]]`
+ * Repeated fields: `[[['home phone']], [['work phone']]]`
+ */
+type HL7Field = string[][][];
+/**
+ * A single HL7 v2 segment — one line of a message.
+ *
+ * @example
+ * // PID|1||MRN123^^^HOSP^MR||DOE^JOHN^A
+ * segment.id      // 'PID'
+ * segment.fields  // [[...], [...], ...]
+ */
+interface HL7Segment {
+    /** Three-letter segment identifier (e.g., `'MSH'`, `'PID'`, `'OBX'`). */
+    readonly id: string;
+    /**
+     * Segment fields, 0-indexed.
+     * `fields[n]` corresponds to field number `n+1` in the HL7 spec.
+     *
+     * MSH is special: `fields[0]` = MSH.1 (the field separator char itself).
+     */
+    readonly fields: HL7Field[];
+    /** The original unparsed segment string — preserved for round-trip fidelity. */
+    readonly raw: string;
+}
+/** Parsed message type and trigger event from MSH.9. */
+interface MessageType {
+    /** Message type code (e.g., `'ADT'`, `'ORU'`, `'ORM'`). */
+    readonly type: string;
+    /** Trigger event code (e.g., `'A01'`, `'R01'`, `'O01'`). */
+    readonly event: string;
+    /** Optional message structure (e.g., `'ADT_A01'`). */
+    readonly structure: string | undefined;
+}
+/** Processing ID — indicates the environment the message was sent from. */
+type ProcessingId = 'P' | 'D' | 'T' | string;
+/**
+ * A fully parsed HL7 v2.x message.
+ *
+ * @example
+ * const msg = parse(raw);
+ * msg.version          // '2.5.1'
+ * msg.messageType      // { type: 'ADT', event: 'A01', structure: 'ADT_A01' }
+ * msg.messageControlId // 'MSG000001'
+ * msg.segments         // HL7Segment[]
+ */
+interface HL7Message {
+    /** HL7 version string extracted from MSH.12 (e.g., `'2.5'`, `'2.5.1'`). */
+    readonly version: string;
+    /** Message type and trigger event parsed from MSH.9. */
+    readonly messageType: MessageType;
+    /** Unique message control ID from MSH.10. Used for acknowledgement correlation. */
+    readonly messageControlId: string;
+    /** Message creation timestamp from MSH.7. `undefined` if absent or unparseable. */
+    readonly timestamp: Date | undefined;
+    /** Sending application name from MSH.3. */
+    readonly sendingApplication: string;
+    /** Sending facility name from MSH.4. */
+    readonly sendingFacility: string;
+    /** Receiving application name from MSH.5. */
+    readonly receivingApplication: string;
+    /** Receiving facility name from MSH.6. */
+    readonly receivingFacility: string;
+    /** Processing ID from MSH.11. `'P'` = Production, `'D'` = Debugging, `'T'` = Training. */
+    readonly processingId: ProcessingId;
+    /** All segments in document order. */
+    readonly segments: HL7Segment[];
+    /** Encoding characters extracted from MSH.1 and MSH.2. */
+    readonly encoding: EncodingChars;
+    /** The original raw input string — preserved without modification. */
+    readonly raw: string;
+    /**
+     * The line ending character(s) detected from the original input.
+     * Used by `encode()` to restore byte-identical output.
+     * `'\r'` (canonical HL7), `'\n'` (Unix), or `'\r\n'` (Windows).
+     */
+    readonly lineEnding: '\r' | '\n' | '\r\n';
+}
+
+export { DEFAULT_ENCODING as D, type EncodingChars as E, type HL7Message as H, type MessageType as M, type HL7Segment as a, type HL7Field as b };

package/dist/schema-qr-scwmL.d.ts

@@ -0,0 +1,106 @@
+/**
+ * The five special characters that govern HL7 v2 encoding.
+ * Defined in MSH.1 and MSH.2 of every message.
+ * Default values follow the HL7 v2 standard.
+ */
+interface EncodingChars {
+    /** Separates fields within a segment. Default: `|` */
+    readonly field: string;
+    /** Separates components within a field. Default: `^` */
+    readonly component: string;
+    /** Separates repetitions of a field. Default: `~` */
+    readonly repetition: string;
+    /** Introduces escape sequences. Default: `\` */
+    readonly escape: string;
+    /** Separates sub-components. Default: `&` */
+    readonly subComponent: string;
+}
+/** HL7 v2 standard encoding characters. */
+declare const DEFAULT_ENCODING: EncodingChars;
+/**
+ * A single HL7 v2 field value modelled as a 3-dimensional array.
+ *
+ * Dimensions (all 0-indexed internally):
+ *   `value[repetition][component][subComponent]`
+ *
+ * Most fields are simple strings: `[[['value']]]`
+ * Composite fields: `[[['family', 'given', 'middle']]]`
+ * Repeated fields: `[[['home phone']], [['work phone']]]`
+ */
+type HL7Field = string[][][];
+/**
+ * A single HL7 v2 segment — one line of a message.
+ *
+ * @example
+ * // PID|1||MRN123^^^HOSP^MR||DOE^JOHN^A
+ * segment.id      // 'PID'
+ * segment.fields  // [[...], [...], ...]
+ */
+interface HL7Segment {
+    /** Three-letter segment identifier (e.g., `'MSH'`, `'PID'`, `'OBX'`). */
+    readonly id: string;
+    /**
+     * Segment fields, 0-indexed.
+     * `fields[n]` corresponds to field number `n+1` in the HL7 spec.
+     *
+     * MSH is special: `fields[0]` = MSH.1 (the field separator char itself).
+     */
+    readonly fields: HL7Field[];
+    /** The original unparsed segment string — preserved for round-trip fidelity. */
+    readonly raw: string;
+}
+/** Parsed message type and trigger event from MSH.9. */
+interface MessageType {
+    /** Message type code (e.g., `'ADT'`, `'ORU'`, `'ORM'`). */
+    readonly type: string;
+    /** Trigger event code (e.g., `'A01'`, `'R01'`, `'O01'`). */
+    readonly event: string;
+    /** Optional message structure (e.g., `'ADT_A01'`). */
+    readonly structure: string | undefined;
+}
+/** Processing ID — indicates the environment the message was sent from. */
+type ProcessingId = 'P' | 'D' | 'T' | string;
+/**
+ * A fully parsed HL7 v2.x message.
+ *
+ * @example
+ * const msg = parse(raw);
+ * msg.version          // '2.5.1'
+ * msg.messageType      // { type: 'ADT', event: 'A01', structure: 'ADT_A01' }
+ * msg.messageControlId // 'MSG000001'
+ * msg.segments         // HL7Segment[]
+ */
+interface HL7Message {
+    /** HL7 version string extracted from MSH.12 (e.g., `'2.5'`, `'2.5.1'`). */
+    readonly version: string;
+    /** Message type and trigger event parsed from MSH.9. */
+    readonly messageType: MessageType;
+    /** Unique message control ID from MSH.10. Used for acknowledgement correlation. */
+    readonly messageControlId: string;
+    /** Message creation timestamp from MSH.7. `undefined` if absent or unparseable. */
+    readonly timestamp: Date | undefined;
+    /** Sending application name from MSH.3. */
+    readonly sendingApplication: string;
+    /** Sending facility name from MSH.4. */
+    readonly sendingFacility: string;
+    /** Receiving application name from MSH.5. */
+    readonly receivingApplication: string;
+    /** Receiving facility name from MSH.6. */
+    readonly receivingFacility: string;
+    /** Processing ID from MSH.11. `'P'` = Production, `'D'` = Debugging, `'T'` = Training. */
+    readonly processingId: ProcessingId;
+    /** All segments in document order. */
+    readonly segments: HL7Segment[];
+    /** Encoding characters extracted from MSH.1 and MSH.2. */
+    readonly encoding: EncodingChars;
+    /** The original raw input string — preserved without modification. */
+    readonly raw: string;
+    /**
+     * The line ending character(s) detected from the original input.
+     * Used by `encode()` to restore byte-identical output.
+     * `'\r'` (canonical HL7), `'\n'` (Unix), or `'\r\n'` (Windows).
+     */
+    readonly lineEnding: '\r' | '\n' | '\r\n';
+}
+
+export { DEFAULT_ENCODING as D, type EncodingChars as E, type HL7Message as H, type MessageType as M, type HL7Segment as a, type HL7Field as b };