Class HL7Message

constructor

• new HL7Message(rawHL7: string): HL7Message

  Constructs an HL7Message instance from a raw HL7 string.

  Parameters

  • rawHL7: string

    The raw HL7 message string

  Returns HL7Message

OptionalAL1

OptionalDG1

OptionalEVN

OptionalIN1

OptionalIN2

OptionalIN3

OptionalMSH

OptionalNK1

OptionalNTE

OptionalOBR

OptionalOBX

OptionalPID

OptionalPR1

OptionalPV1

OptionalPV2

OptionalROL

get

• get(path: string): string

  Retrieves a value using path notation.

  Parameters

  • path: string

    Format: 'SEGMENT-FIELD.COMPONENT.SUBCOMPONENT' (e.g., 'PID-5.1.2')

  Returns string

  The value at the specified path

getAllSegments

• getAllSegments(name: string): Segment[]

  Retrieves all segments matching the specified name.

  Parameters

  • name: string

    The name of the segment (e.g., 'PID', 'OBX')

  Returns Segment[]

  An array of matching segments

getParsedSegments

• getParsedSegments(): { [key: string]: Segment | Segment[] }

  Retrieves the parsed structure of segments.

  Returns { [key: string]: Segment | Segment[] }

  An object with segments organized by type

getSegment

• getSegment(name: string): undefined | Segment

  Retrieves a specific segment by name. If there are multiple segments of the same type, returns the first one.

  Parameters

  • name: string

    The name of the segment

  Returns undefined | Segment

  The matching segment, or undefined if not found

getSegments

• getSegments(): Segment[]

  Retrieves all segments in the message.

  Returns Segment[]

  An array of all segments

hasSegment

• hasSegment(name: string): boolean

  Checks if a specific segment exists.

  Parameters

  • name: string

    The name of the segment

  Returns boolean

  True if the segment exists, false otherwise

set

• set(path: string, value: string): void

  Sets a value using path notation. Creates the field/component/subcomponent if it does not exist.

  Parameters

  • path: string

    Format: 'SEGMENT-FIELD.COMPONENT.SUBCOMPONENT' (e.g., 'PID-5.1.2')
  • value: string

    Value to set

  Returns void

toString

• toString(): string

  Converts the HL7 message to a formatted string.

  Returns string

  The HL7 message as a string