@cosyte/hl7 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -496,12 +496,14 @@ declare function unterminatedStreamMessage(position: Hl7Position): Hl7ParseWarni
  */
 
 /**
- * Positional context attached to every warning and fatal error. Fields are
- * 1-indexed against the HL7 spec convention (see `RawSegment.fields` for the
- * index 0 slot convention). All fields past `segmentIndex` are optional,
- * for a top-level fatal like `EMPTY_INPUT` only `segmentIndex: 0` is
- * populated; for a tokenizer warning deep inside a subcomponent all five
- * indices may be set.
+ * Positional context attached to every warning and fatal error.
+ * `segmentIndex` counts segments from 0, so a parsed message's MSH segment is
+ * 0. The other fields are 1-indexed against the HL7 spec convention:
+ * `fieldIndex: 3` on MSH is MSH-3 and `repetitionIndex: 1` is the first
+ * repetition (see `RawSegment.fields` for the index 0 slot convention). All
+ * fields past `segmentIndex` are optional: for a top-level fatal like
+ * `EMPTY_INPUT` only `segmentIndex: 0` is populated; for a tokenizer warning
+ * deep inside a subcomponent all five indices may be set.
  *
  * @remarks
  * With `exactOptionalPropertyTypes: true`, do not pass `fieldIndex: undefined`
@@ -1445,7 +1447,7 @@ declare function parsePl(rep: RawRepetition, enc: EncodingCharacters): PL;
  * Usage examples (the literal OBX-5 string ⇒ what this parses):
  *   `>^100`        ⇒ greater-than 100        → { comparator: ">", num1: 100 }
  *   `<^10`         ⇒ less-than 10            → { comparator: "<", num1: 10 }
- *   `^100^-^200`   ⇒ range 100–200          → { num1: 100, separatorOrSuffix: "-", num2: 200 }
+ *   `^100^-^200`   ⇒ range 100 to 200        → { num1: 100, separatorOrSuffix: "-", num2: 200 }
  *   `^1^:^128`     ⇒ titer/ratio 1:128      → { num1: 1, separatorOrSuffix: ":", num2: 128 }
  *
  * Safety: `num1`/`num2` are parsed with the same strict `Number()` discipline
@@ -1599,7 +1601,7 @@ type DtmPrecision = "year" | "month" | "day" | "hour" | "minute" | "second" | "f
  * shape of the `TS` composite (`field.asTs()`) and every helper datetime.
  *
  * The parts are only populated when `valid` is `true`. `month`/`day`/… are
- * **spec-native** (`month` is 1–12, NOT the JS `Date` 0–11). `offsetMinutes`
+ * **spec-native** (`month` is 1 to 12, NOT the JS `Date` 0 to 11). `offsetMinutes`
  * is present iff `hasTimezone` is `true` and is signed minutes east of UTC
  * (`+0500` → `300`, `-0430` → `-270`). A missing offset is **flagged**
  * (`hasTimezone: false`), never resolved to UTC: the consumer decides how to
@@ -1628,15 +1630,15 @@ interface DtmParts {
     readonly precision?: DtmPrecision;
     /** Four-digit year. */
     readonly year?: number;
-    /** Month, 1–12 (spec-native, NOT JS 0–11). */
+    /** Month, 1 to 12 (spec-native, NOT JS 0 to 11). */
     readonly month?: number;
-    /** Day of month, 1–31. */
+    /** Day of month, 1 to 31. */
     readonly day?: number;
-    /** Hour, 0–23. */
+    /** Hour, 0 to 23. */
     readonly hour?: number;
-    /** Minute, 0–59. */
+    /** Minute, 0 to 59. */
     readonly minute?: number;
-    /** Second, 0–59. */
+    /** Second, 0 to 59. */
     readonly second?: number;
     /**
      * Fractional-second digits exactly as populated (no leading dot), e.g.
@@ -6156,7 +6158,7 @@ interface ProfiledMessage<P> extends Hl7Message {
 
 /**
  * Public entry point for the `@cosyte/hl7` parser: composes every
- * parser stage built across Plans 01–05 (normalize, strip MLLP, split
+ * parser stage built across Plans 01 to 05 (normalize, strip MLLP, split
  * segments, read delimiters, tokenize) and routes every Tier-2 warning
  * through a single `emitWarning` chokepoint. The four Tier-3 fatal codes
  * (`EMPTY_INPUT`, `NO_MSH_SEGMENT`, `MSH_TOO_SHORT`,
@@ -8723,7 +8725,7 @@ declare function supportsBuilderMessage(messageCode: string, triggerEvent: strin
  * - **Table 0357** Message error condition codes: https://terminology.hl7.org/CodeSystem-v2-0357.html
  * - **Table 0516** Error severity: HL7 v2 Chapter 2 §2.14.5 (ERR-4)
  * - **Table 0155** Accept/application acknowledgment conditions (MSH-15/16),
- *   HL7 v2 Chapter 2 §2.14.9.15–16
+ *   HL7 v2 Chapter 2 §2.14.9.15 to 16
  *
  * Zero runtime deps.
  */
@@ -8861,7 +8863,7 @@ type AckMode = "original" | "enhanced";
  * inbound message that carries no MSH-10 correlation id.
  *
  * Spec traceability: HL7 v2 Chapter 2 §2.9 (ack model), §2.14.8 (MSA),
- * §2.14.5 (ERR), §2.14.9.15–16 (MSH-15/16). Tables 0008 / 0357 / 0516 / 0155
+ * §2.14.5 (ERR), §2.14.9.15 to 16 (MSH-15/16). Tables 0008 / 0357 / 0516 / 0155
  * live in `ack-tables.ts`.
  *
  * Zero runtime deps.
@@ -9530,7 +9532,7 @@ declare const meditech: DefinedProfile<{
  * - **`ZAV`**: Visit Filler: visit **additional details** (base64 XML).
  *
  * Grounded in the public **Vue PACS 12.2.8 HL7 Interface Specifications**
- * (Philips, document HA1669 Rev A), §§5.11–5.16: a publicly downloadable
+ * (Philips, document HA1669 Rev A), §§5.11 to 5.16: a publicly downloadable
  * vendor interface spec, not an invented quirk. The spec's
  * `TS` timestamps are the HL7-native `YYYYMMDDHHMMSS` form (§2.6), so this
  * profile declares **no** custom `dateFormats`: only the Z-segments.
@@ -9716,7 +9718,7 @@ declare const va: DefinedProfile<{
  * order with the DICOM study: the classic RIS/PACS ↔ HL7 bridge segment
  * defined by the IHE Radiology Technical Framework. BIP-07.
  *
- * Grounded in the public **Visage 7 – HL7 Interface Specification**
+ * Grounded in the public **Visage 7: HL7 Interface Specification**
  * (V23.00, Jun 2026, Visage Imaging GmbH), §4.4 "ORM Messages" + the ZDS
  * segment table ("Study Instance UID … contained in the first component of
  * the first field of the ZDS Segment"): a publicly downloadable vendor

package/dist/index.d.ts

@@ -496,12 +496,14 @@ declare function unterminatedStreamMessage(position: Hl7Position): Hl7ParseWarni
  */
 
 /**
- * Positional context attached to every warning and fatal error. Fields are
- * 1-indexed against the HL7 spec convention (see `RawSegment.fields` for the
- * index 0 slot convention). All fields past `segmentIndex` are optional,
- * for a top-level fatal like `EMPTY_INPUT` only `segmentIndex: 0` is
- * populated; for a tokenizer warning deep inside a subcomponent all five
- * indices may be set.
+ * Positional context attached to every warning and fatal error.
+ * `segmentIndex` counts segments from 0, so a parsed message's MSH segment is
+ * 0. The other fields are 1-indexed against the HL7 spec convention:
+ * `fieldIndex: 3` on MSH is MSH-3 and `repetitionIndex: 1` is the first
+ * repetition (see `RawSegment.fields` for the index 0 slot convention). All
+ * fields past `segmentIndex` are optional: for a top-level fatal like
+ * `EMPTY_INPUT` only `segmentIndex: 0` is populated; for a tokenizer warning
+ * deep inside a subcomponent all five indices may be set.
  *
  * @remarks
  * With `exactOptionalPropertyTypes: true`, do not pass `fieldIndex: undefined`
@@ -1445,7 +1447,7 @@ declare function parsePl(rep: RawRepetition, enc: EncodingCharacters): PL;
  * Usage examples (the literal OBX-5 string ⇒ what this parses):
  *   `>^100`        ⇒ greater-than 100        → { comparator: ">", num1: 100 }
  *   `<^10`         ⇒ less-than 10            → { comparator: "<", num1: 10 }
- *   `^100^-^200`   ⇒ range 100–200          → { num1: 100, separatorOrSuffix: "-", num2: 200 }
+ *   `^100^-^200`   ⇒ range 100 to 200        → { num1: 100, separatorOrSuffix: "-", num2: 200 }
  *   `^1^:^128`     ⇒ titer/ratio 1:128      → { num1: 1, separatorOrSuffix: ":", num2: 128 }
  *
  * Safety: `num1`/`num2` are parsed with the same strict `Number()` discipline
@@ -1599,7 +1601,7 @@ type DtmPrecision = "year" | "month" | "day" | "hour" | "minute" | "second" | "f
  * shape of the `TS` composite (`field.asTs()`) and every helper datetime.
  *
  * The parts are only populated when `valid` is `true`. `month`/`day`/… are
- * **spec-native** (`month` is 1–12, NOT the JS `Date` 0–11). `offsetMinutes`
+ * **spec-native** (`month` is 1 to 12, NOT the JS `Date` 0 to 11). `offsetMinutes`
  * is present iff `hasTimezone` is `true` and is signed minutes east of UTC
  * (`+0500` → `300`, `-0430` → `-270`). A missing offset is **flagged**
  * (`hasTimezone: false`), never resolved to UTC: the consumer decides how to
@@ -1628,15 +1630,15 @@ interface DtmParts {
     readonly precision?: DtmPrecision;
     /** Four-digit year. */
     readonly year?: number;
-    /** Month, 1–12 (spec-native, NOT JS 0–11). */
+    /** Month, 1 to 12 (spec-native, NOT JS 0 to 11). */
     readonly month?: number;
-    /** Day of month, 1–31. */
+    /** Day of month, 1 to 31. */
     readonly day?: number;
-    /** Hour, 0–23. */
+    /** Hour, 0 to 23. */
     readonly hour?: number;
-    /** Minute, 0–59. */
+    /** Minute, 0 to 59. */
     readonly minute?: number;
-    /** Second, 0–59. */
+    /** Second, 0 to 59. */
     readonly second?: number;
     /**
      * Fractional-second digits exactly as populated (no leading dot), e.g.
@@ -6156,7 +6158,7 @@ interface ProfiledMessage<P> extends Hl7Message {
 
 /**
  * Public entry point for the `@cosyte/hl7` parser: composes every
- * parser stage built across Plans 01–05 (normalize, strip MLLP, split
+ * parser stage built across Plans 01 to 05 (normalize, strip MLLP, split
  * segments, read delimiters, tokenize) and routes every Tier-2 warning
  * through a single `emitWarning` chokepoint. The four Tier-3 fatal codes
  * (`EMPTY_INPUT`, `NO_MSH_SEGMENT`, `MSH_TOO_SHORT`,
@@ -8723,7 +8725,7 @@ declare function supportsBuilderMessage(messageCode: string, triggerEvent: strin
  * - **Table 0357** Message error condition codes: https://terminology.hl7.org/CodeSystem-v2-0357.html
  * - **Table 0516** Error severity: HL7 v2 Chapter 2 §2.14.5 (ERR-4)
  * - **Table 0155** Accept/application acknowledgment conditions (MSH-15/16),
- *   HL7 v2 Chapter 2 §2.14.9.15–16
+ *   HL7 v2 Chapter 2 §2.14.9.15 to 16
  *
  * Zero runtime deps.
  */
@@ -8861,7 +8863,7 @@ type AckMode = "original" | "enhanced";
  * inbound message that carries no MSH-10 correlation id.
  *
  * Spec traceability: HL7 v2 Chapter 2 §2.9 (ack model), §2.14.8 (MSA),
- * §2.14.5 (ERR), §2.14.9.15–16 (MSH-15/16). Tables 0008 / 0357 / 0516 / 0155
+ * §2.14.5 (ERR), §2.14.9.15 to 16 (MSH-15/16). Tables 0008 / 0357 / 0516 / 0155
  * live in `ack-tables.ts`.
  *
  * Zero runtime deps.
@@ -9530,7 +9532,7 @@ declare const meditech: DefinedProfile<{
  * - **`ZAV`**: Visit Filler: visit **additional details** (base64 XML).
  *
  * Grounded in the public **Vue PACS 12.2.8 HL7 Interface Specifications**
- * (Philips, document HA1669 Rev A), §§5.11–5.16: a publicly downloadable
+ * (Philips, document HA1669 Rev A), §§5.11 to 5.16: a publicly downloadable
  * vendor interface spec, not an invented quirk. The spec's
  * `TS` timestamps are the HL7-native `YYYYMMDDHHMMSS` form (§2.6), so this
  * profile declares **no** custom `dateFormats`: only the Z-segments.
@@ -9716,7 +9718,7 @@ declare const va: DefinedProfile<{
  * order with the DICOM study: the classic RIS/PACS ↔ HL7 bridge segment
  * defined by the IHE Radiology Technical Framework. BIP-07.
  *
- * Grounded in the public **Visage 7 – HL7 Interface Specification**
+ * Grounded in the public **Visage 7: HL7 Interface Specification**
  * (V23.00, Jun 2026, Visage Imaging GmbH), §4.4 "ORM Messages" + the ZDS
  * segment table ("Study Instance UID … contained in the first component of
  * the first field of the ZDS Segment"): a publicly downloadable vendor

package/dist/index.mjs

@@ -101,7 +101,7 @@ function readDelimiters(firstSegment) {
   if (chars.length !== 4 && chars.length !== 5) {
     throw new Hl7ParseError(
       FATAL_CODES.INVALID_ENCODING_CHARACTERS,
-      `MSH-2 encoding characters must be 4 (v2.1\u2013v2.6) or 5 (v2.7+ adds truncation) characters (got ${String(chars.length)}).`,
+      `MSH-2 encoding characters must be 4 (v2.1 to v2.6) or 5 (v2.7+ adds truncation) characters (got ${String(chars.length)}).`,
       fatalPosition,
       snip
     );
@@ -14899,7 +14899,7 @@ async function* parseStream(source, optionsOrProfile) {
 }
 
 // src/index.ts
-var VERSION = "0.1.0";
+var VERSION = "0.1.2";
 
 export { ACK_CODES, ACK_CONDITIONS, AMBIGUOUS_DATE_ORDER, BUILTIN_DATE_FALLBACKS, DEFAULT_ENCODING_CHARACTERS, ERR_CONDITION_CODES, ERR_CONDITION_CODE_SYSTEM, ERR_SEVERITIES, FATAL_CODES, FINDING_CODES, Field, namespace_exports as HL7, Hl7Message, Hl7ParseError, JSON_SCHEMA_DIALECT, KNOWN_CODING_SYSTEMS, KNOWN_SEGMENTS, MESSAGE_STRUCTURE_DEFINITIONS, PREDICATE_CONNECTORS, PREDICATE_VERBS, PROFILE_LEVELS, ProfileDefinitionError, SCHEMA_EMIT_TARGETS, STRUCTURE_FINDING_CODES, STRUCTURE_NOT_VALIDATED_REASONS, STRUCTURE_REGISTRY_PROVENANCE, SUPPORTED_BUILDER_MESSAGES, SUPPORTED_DATE_TOKENS, SUPPORTED_OVERLAY_MESSAGES, SchemaTargetError, Segment, TYPED_BUILDER_COVERAGE, USAGE_CODES, VERSION, WARNING_CODES, ackNoCorrelationId, alternateCodingSystemOf, analyzeMessageStructure, batchCountMismatch, batchMissingTrailer, buildAck, buildAdt, buildDft, buildMdm, buildMessage, buildOrm, buildOru, buildSiu, buildVxu, canonicalCharset, codingSystem, codingSystemOf, conformance_exports as conformance, decodeText, defineConformanceProfile, defineProfile, detectAckMode, downgradePositiveAck, dtmToDate, duplicateRequiredSegment, emitMessageSchema, encodeCe, encodeComposite, encodeCompositeReps, encodeCwe, encodeCx, encodeHd, encodeNm, encodePl, encodeText, encodeTs, encodeXad, encodeXcn, encodeXpn, encodeXtn, encodingMismatch, extraFields, fieldWhitespaceTrimmed, findMessageStructureDefinition, formatDtm, getDefaultProfile, interpretAck, isPositiveAck, isSchemaEmitTarget, mergeMissingPriorOrSurvivor, messageJsonSchema, messageZodSource, missingExpectedGroup, missingRequiredField, missingRequiredSegment, mllpFramingStripped, outOfOrderSegment, parseCe, parseCwe, parseCx, parseDtm, parseHL7, parseHd, parseNm, parsePath, parsePl, parseSn, parseStream, parseTs, parseXad, parseXcn, parseXpn, parseXtn, pickMrn, profiles, reescape, renderText, resolveCharset, resolvePath, segmentCase, setDefaultProfile, splitBatch, supportsBuilderMessage, text_exports as text, timestampFallbackFormat, toDate, toISO, toObject, unescape, unknownCharset, unknownEscapeSequence, unknownSegment, unsupportedCharset, unterminatedEscapeSequence, unterminatedStreamMessage, usageOutcomes, validateAgainstProfile, validateMessageStructure, versionMismatch };
 //# sourceMappingURL=index.mjs.map