Interface ClientBuilderMessageOptions

Client Builder Options

Remarks

Used to specific default paramaters around building an HL7 message if that is so desired. It also sets up checking of input values to make sure they match up to the proper HL7 specification.

Since

1.0.0

interface ClientBuilderMessageOptions {
    date?: string;
    messageHeader?: MSH;
    newLine?: string;
    parsing?: boolean;
    separatorComponent?: string;
    separatorEscape?: string;
    separatorField?: string;
    separatorRepetition?: string;
    separatorSubComponent?: string;
    specification?: any;
    text?: string;
}

Hierarchy (view full)

Properties

date? messageHeader? newLine? parsing? separatorComponent? separatorEscape? separatorField? separatorRepetition? separatorSubComponent? specification? text?

Properties

Optionaldate

date?: string

The date type for the date field. Usually generated at the time of the class being initialized.

Since

1.0.0

Default

14

OptionalmessageHeader

messageHeader?: MSH

MSH Header Options

Since

1.0.0

OptionalnewLine

newLine?: string

At the end of each line, add this as the new line character.

Since

1.0.0

Default

\r

Optionalparsing

parsing?: boolean

Parsing a message?

Since

1.0.0

Default

false

OptionalseparatorComponent

separatorComponent?: string

The character used to separate different components.

Since

1.0.0

Default

^

OptionalseparatorEscape

separatorEscape?: string

The character used to escape characters that need it in order for the computer to interpret the string correctly.

Since

1.0.0

Default

\\

OptionalseparatorField

separatorField?: string

The character used for separating fields.

Since

1.0.0

Default

|

OptionalseparatorRepetition

separatorRepetition?: string

The character used for repetition field/values pairs.

Since

1.0.0

Default

~

OptionalseparatorSubComponent

separatorSubComponent?: string

The character used to have subcomponents seperated.

Since

1.0.0

Default

&

Optionalspecification

specification?: any

The HL7 spec we are going to be creating. This will be formatted into the MSH header by default.

Since

1.0.0

Default

2.7 via class new HL7_2_7()

Optionaltext

text?: string

The HL7 string that we are going to parse.

Default

""

Settings

Member Visibility

On This Page

Properties