Class Segment

Class representing a segment with access to fields.

Index

Constructors

Methods

getComponent getField getFieldObject getFields getName getSubcomponent toString

Constructors

constructor

new Segment(line: string): Segment
Creates an instance of Segment.
Parameters
- line: string
  The raw HL7 segment line.
Returns Segment
- Defined in Segment.ts:219

Methods

getComponent

getComponent(fieldIndex: number, componentIndex: number): string
Retrieves a specific component of a field.
Parameters
- fieldIndex: number
  The field index.
- componentIndex: number
  The 1-based index of the component within the field.
Returns string
- Defined in Segment.ts:313

getField

getField(index: number): undefined | string
Retrieves a specific field by index.
Parameters
- index: number
  The field index (1-based access, but Field 0 = segment name)
Returns undefined | string
- Defined in Segment.ts:293

getFieldObject

getFieldObject(index: number): HL7Field
Retrieves a field as an HL7Field object for advanced access.
Parameters
- index: number
  The field index.
Returns HL7Field
- Defined in Segment.ts:303

getFields

getFields(): string[]
Retrieves all fields of the segment.

Returns string[]
- Defined in Segment.ts:285

getName

getName(): string
Retrieves the name of the segment.

Returns string
- Defined in Segment.ts:278

getSubcomponent

getSubcomponent(
    fieldIndex: number,
    componentIndex: number,
    subcomponentIndex: number,
): string
Retrieves a specific subcomponent of a component.
Parameters
- fieldIndex: number
  The field index.
- componentIndex: number
  The 1-based index of the component.
- subcomponentIndex: number
  The 1-based index of the subcomponent.
Returns string
- Defined in Segment.ts:329

toString

toString(): string
Converts the segment to a string in HL7 format.

Returns string
The segment as a string.
- Defined in Segment.ts:343