Interface ClientBuilderFileOptions

Client Builder Options

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.

1.0.0

interface ClientBuilderFileOptions {
    date?: string;
    extension?: string;
    fileBuffer?: Buffer;
    fullFilePath?: string;
    location?: string;
    newLine?: string;
    parsing?: boolean;
    separatorComponent?: string;
    separatorEscape?: string;
    separatorField?: string;
    separatorRepetition?: string;
    separatorSubComponent?: string;
    specification?: any;
    text?: string;
}

Hierarchy (view full)

Properties

date?: string

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

1.0.0

14
extension?: string

Extension of the file when it gets created.

1.0.0

hl7
fileBuffer?: Buffer

The file as a buffer passed onto the constructor

1.0.0

fullFilePath?: string

If you are providing the full file path, please set it here.

1.0.0

location?: string

Location where the file will be saved. If this is not set, the files will get save it in the same directory of the executing file that is calling the function. If running this package inside a DOCKER/KUBERNETES node, if the container is destroyed and the files are not saved on a folder mounted outside the node, the files will be lost on restart.

1.0.0

""
newLine?: string

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

1.0.0

\r
parsing?: boolean

Parsing a message?

1.0.0

false
separatorComponent?: string

The character used to separate different components.

1.0.0

^
separatorEscape?: string

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

1.0.0

\\
separatorField?: string

The character used for separating fields.

1.0.0

|
separatorRepetition?: string

The character used for repetition field/values pairs.

1.0.0

~
separatorSubComponent?: string

The character used to have subcomponents seperated.

1.0.0

&
specification?: any

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

1.0.0

2.7 via class new HL7_2_7()
text?: string

The HL7 string that we are going to parse.

""