Skip to main content
Version: v0.0.2

Interface: Build999EnvelopeSpec

Envelope spec for build999 - the ISA + GS + ST + matching trailers that wrap the 999 transaction set. Defaults are spec-conformant for a minimal 999 envelope:

  • senderQualifier / receiverQualifier default to ZZ (mutually defined).
  • usageIndicator defaults to P (production).
  • repetitionSeparator defaults to ^; componentSeparator defaults to :; segmentTerminator defaults to ~. Override for trading- partner companion-guide requirements (e.g. Medicare uses : component, BCBS some shapes use \\).
  • interchangeControlNumber is the 9-character ISA-13 value (zero- padded if needed). groupControlNumber is the GS-06 numeric string (1–9 digits). transactionSetControlNumber is the ST-02 string (4–9 digits per X12 .5).

Properties​

componentSeparator?​

readonly optional componentSeparator?: string

elementSeparator?​

readonly optional elementSeparator?: string

groupControlNumber​

readonly groupControlNumber: string

groupDate?​

readonly optional groupDate?: string

groupResponsibleAgency?​

readonly optional groupResponsibleAgency?: string

groupTime?​

readonly optional groupTime?: string

interchangeControlNumber​

readonly interchangeControlNumber: string

interchangeDate​

readonly interchangeDate: string

interchangeTime​

readonly interchangeTime: string

receiverId​

readonly receiverId: string

receiverQualifier?​

readonly optional receiverQualifier?: string

repetitionSeparator?​

readonly optional repetitionSeparator?: string

segmentTerminator?​

readonly optional segmentTerminator?: string

senderId​

readonly senderId: string

senderQualifier?​

readonly optional senderQualifier?: string

transactionSetControlNumber​

readonly transactionSetControlNumber: string

usageIndicator?​

readonly optional usageIndicator?: "P" | "T"