From 6b6953d211bffeff6b63056fabcde102b6f722ea Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 25 Jun 2024 12:02:59 +0000 Subject: [PATCH] deploy: 3b51e3b3ca4950d63769d0d7c11d2de4dc3c00be --- classes/CORE.Batch.html | 24 ++++++------- classes/CORE.Connection.html | 14 ++++---- classes/CORE.EmptyNode.html | 6 ++-- classes/CORE.FileBatch.html | 24 ++++++------- classes/CORE.HL7Error.html | 6 ++-- classes/CORE.HL7FatalError.html | 6 ++-- classes/CORE.HL7ParserError.html | 6 ++-- classes/CORE.InboundResponse.html | 8 ++--- classes/CORE.Message.html | 24 ++++++------- classes/CORE.NodeBase.html | 8 ++--- classes/CORE.Segment.html | 8 ++--- classes/CORE.default.html | 16 ++++----- classes/HL7.HL7_2_1.html | 12 +++---- classes/HL7.HL7_2_2.html | 12 +++---- classes/HL7.HL7_2_3.html | 12 +++---- classes/HL7.HL7_2_3_1.html | 12 +++---- classes/HL7.HL7_2_4.html | 12 +++---- classes/HL7.HL7_2_5.html | 12 +++---- classes/HL7.HL7_2_5_1.html | 12 +++---- classes/HL7.HL7_2_6.html | 12 +++---- classes/HL7.HL7_2_7.html | 12 +++---- classes/HL7.HL7_2_7_1.html | 12 +++---- classes/HL7.HL7_2_8.html | 12 +++---- classes/HL7.HL7_SPEC_BASE.html | 10 +++--- enums/CORE.Delimiters.html | 16 ++++----- enums/CORE.ReadyState.html | 14 ++++---- functions/CORE.assertNumber.html | 4 +-- functions/CORE.createHL7Date.html | 4 +-- functions/CORE.decodeHexString.html | 4 +-- functions/CORE.escapeForRegExp.html | 4 +-- functions/CORE.expBackoff.html | 4 +-- functions/CORE.isBatch.html | 4 +-- functions/CORE.isFile.html | 4 +-- functions/CORE.isHL7Number.html | 4 +-- functions/CORE.isHL7String.html | 4 +-- functions/CORE.padHL7Date.html | 4 +-- functions/CORE.randomString.html | 4 +-- functions/CORE.validIPv4.html | 4 +-- functions/CORE.validIPv6.html | 4 +-- hierarchy.html | 2 +- index.html | 4 +-- interfaces/CORE.ClientBuilderFileOptions.html | 32 ++++++++--------- .../CORE.ClientBuilderMessageOptions.html | 26 +++++++------- interfaces/CORE.ClientBuilderOptions.html | 24 ++++++------- interfaces/CORE.ClientListenerOptions.html | 34 +++++++++---------- interfaces/CORE.ClientOptions.html | 24 ++++++------- interfaces/CORE.HL7Node.html | 6 ++-- interfaces/CORE.IConnection.html | 18 +++++----- interfaces/HL7.HL7_2_1_MSH.html | 10 +++--- interfaces/HL7.HL7_2_2_MSH.html | 12 +++---- interfaces/HL7.HL7_2_3_1_MSH.html | 14 ++++---- interfaces/HL7.HL7_2_3_MSH.html | 14 ++++---- interfaces/HL7.HL7_2_4_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_5_1_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_5_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_6_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_7_1_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_7_MSH.html | 16 ++++----- interfaces/HL7.HL7_2_8_MSH.html | 16 ++++----- interfaces/HL7.HL7_SPEC.html | 10 +++--- modules.html | 4 +-- modules/CORE.html | 4 +-- modules/HL7.html | 4 +-- types/CORE.OutboundHandler.html | 4 +-- types/HL7.MSH.html | 4 +-- 65 files changed, 368 insertions(+), 368 deletions(-) diff --git a/classes/CORE.Batch.html b/classes/CORE.Batch.html index 1575bcb..4c5c9d7 100644 --- a/classes/CORE.Batch.html +++ b/classes/CORE.Batch.html @@ -1,9 +1,9 @@ -Batch | Node HL7 Client - v2.3.1-beta.1

Class Batch

Batch Class

+Batch | Node HL7 Client - v2.3.1

Class Batch

Batch Class

Description

Creating a Batch (BHS) which could include hundreds of MSH segments for processing. Normally used in large data processing. However, the server usually breaks down a batch MSH into single "elements" to process them and returns that the batch.

Since

1.0.0

-

Hierarchy

  • RootBase
    • Batch

Constructors

constructor +

Hierarchy

  • RootBase
    • Batch

Constructors

constructor

Properties

_name parent empty @@ -31,14 +31,14 @@

Sincewrite

Constructors

constructor

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

add

  • add(message, index?): void

  • Add a Message to the Batch

    +

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

add

  • add(message, index?): void

  • Add a Message to the Batch

    Parameters

    • message: Message

      The Message to add into the batch.

    • Optionalindex: number

      Used Internally mostly to add an MSH segment within a BHS segment at a certain index.

    Returns void

    Description

    This adds a Message (MSH) output into the batch. It also increases the count of the BTS segment as the batch final result when in end tells the receiving end how many message (MSH) segments are included.

    Since

    1.0.0

    -

end

end

  • end(): void

  • End Batch

    Returns void

    Description

    At the conclusion of building the batch, (Usually add method will be before this) will add the Batch Trailing Segment (BTS) to the end. If a message (MSH) is added after this, @@ -46,7 +46,7 @@

    SinceFileBatch for more information.

    Since

    1.0.0

    -

exists

forEach

get

exists

forEach

get

getFirstSegment

getFirstSegment

  • getFirstSegment(name): Segment

  • Get the First Segment

    Parameters

    • name: string

      The name of the segment. At max usually three characters long.

    Returns Segment

    Description

    Returns the first segment found in the Batch (BHS). @@ -65,7 +65,7 @@

    ExampleFileBatch which can hold more than one Batch groups.

    Since

    1.0.0

    -

isEmpty

messages

isEmpty

messages

  • messages(): Message[]

  • Get Messages within a submitted Batch

    Returns Message[]

    Returns an array of messages or a HL7ParserError will throw.

    Description

    This will parse the passed on "text" in the contractor options and get all the messages (MSH) segments within it and return an array of them.

    @@ -73,7 +73,7 @@

    SinceExample

    try {
     // parser the batch
     const parser = new Batch({ text: loadedMessage })
     // load the messages
     const allMessage = parser.messages()
     // loop messages
     allMessage.forEach((message: Message) => {
       const messageParsed = new Message({ text: message.toString() })
     })
    } catch (e) {
      // error here
    }
    -

set

set

start

start

  • start(style?): void

  • Start Batch

    Parameters

    • Optionalstyle: "8" | "12" | "14"

      Your options produce: YYYYMMDDHHMMSS = 14 | YYYYMMDDHHMM = 12 | YYYYMMDD = 8

    Returns void

    Description

    This allows you to override the orginial contractor BHS fields that are required. In this case, 'BHS.7' @@ -95,7 +95,7 @@

    SinceDefault Value

    YYYYMMDDHHMMSS (14)
    -

toArray

toBoolean

toDate

toFile

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddendexistsforEachgetgetFirstSegmentisEmptymessagessetstarttoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file +

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddendexistsforEachgetgetFirstSegmentisEmptymessagessetstarttoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file diff --git a/classes/CORE.Connection.html b/classes/CORE.Connection.html index 2ee29a9..cd1f342 100644 --- a/classes/CORE.Connection.html +++ b/classes/CORE.Connection.html @@ -1,7 +1,7 @@ -Connection | Node HL7 Client - v2.3.1-beta.1

Class Connection

Connection Class

+Connection | Node HL7 Client - v2.3.1

Class Connection

Connection Class

Description

Create a connection customer that will listen to result send to the particular port.

Since

1.0.0

-

Hierarchy

  • EventEmitter
    • Connection

Implements

Constructors

constructor +

Hierarchy

  • EventEmitter
    • Connection

Implements

Constructors

constructor

Methods

close getPort sendMessage @@ -14,7 +14,7 @@

SinceExample

const OB = client.createConnection({ port: 3000 }, async (res) => {})
-

Methods

close

Methods

close

  • close(): Promise<void>

  • Close Client Listener Instance.

    Returns Promise<void>

    Description

    Force close a connection. It will stop any re-connection timers. If you want to restart, your app has to restart the connection.

    @@ -22,10 +22,10 @@

    SinceExample

    OB.close()
    -

getPort

getPort

  • getPort(): number

  • Get Port

    Returns number

    Description

    Get the port that this connection will connect to.

    Since

    2.0.0

    -

sendMessage

sendMessage

  • sendMessage(message): Promise<void>

  • Send a HL7 Message to the Listener

    Parameters

    Returns Promise<void>

    Description

    This function sends a message/batch/file batch to the remote side. It has the ability, if set to auto-retry (defaulted to 1 re-connect before connection closes)

    @@ -33,6 +33,6 @@

    SinceExample


    // the OB was set from the orginial 'createConnection' method.

    let message = new Message({
     messageHeader: {
       msh_9_1: "ADT",
       msh_9_2: "A01",
       msh_11_1: "P" // marked for production here in the example
     }async sendMessage (message: Message | Batch | FileBatch): void {
    })

    await OB.sendMessage(message)
    -

start

start

Settings

Member Visibility

On This Page

constructorclosegetPortsendMessagestart
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructorclosegetPortsendMessagestart
\ No newline at end of file diff --git a/classes/CORE.EmptyNode.html b/classes/CORE.EmptyNode.html index 1150793..27481a4 100644 --- a/classes/CORE.EmptyNode.html +++ b/classes/CORE.EmptyNode.html @@ -1,6 +1,6 @@ -EmptyNode | Node HL7 Client - v2.3.1-beta.1

Class EmptyNode

Empty Node

+EmptyNode | Node HL7 Client - v2.3.1

Class EmptyNode

Empty Node

Since

1.0.0

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Accessors

length name path @@ -19,4 +19,4 @@ toRaw toString write -

Constructors

constructor

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

read

set

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructorlengthnamepathexistsforEachgetisEmptyreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file +

Constructors

constructor

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

read

set

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructorlengthnamepathexistsforEachgetisEmptyreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file diff --git a/classes/CORE.FileBatch.html b/classes/CORE.FileBatch.html index b20728e..dbeb949 100644 --- a/classes/CORE.FileBatch.html +++ b/classes/CORE.FileBatch.html @@ -1,11 +1,11 @@ -FileBatch | Node HL7 Client - v2.3.1-beta.1

Class FileBatch

File Batch Class

+FileBatch | Node HL7 Client - v2.3.1

Class FileBatch

File Batch Class

Description

Create a File Batch (FHS) which will could include many BHS/BTS segments, which could include many Message (MSH) segments to output the contents into a file on the OS. These files could then be used to send manually or read by another system to interpret the contents. This class helps in generating the particulars for that file generation to make sure that it follows the correct format.

Since

1.0.0

-

Hierarchy

  • RootBase
    • FileBatch

Constructors

constructor +

Hierarchy

  • RootBase
    • FileBatch

Constructors

constructor

Properties

_name parent empty @@ -34,25 +34,25 @@

Sincewrite

Constructors

constructor

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

add

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

add

  • add(message): void

  • AAdd a Message or a Batch to the File

    Parameters

    Returns void

    Description

    This adds a Message (MSH) output into the file batch. If there is a Batch ("BHS") already part of this file, any new Message type will be added to the first found BHS regardless if the second Batch is added last.

    Since

    1.0.0

    -

createFile

createFile

  • createFile(name): void

  • Create a file to be stored.

    Parameters

    • name: string

      Name of the file.

    Returns void

    Since

    1.0.0

    -

end

end

  • end(): void

  • End Batch

    Returns void

    Description

    At the conclusion of building the file batch, (Usually add method will be before this) will add the File Batch Trailing Segment (FTS) to the end. If a message (MSH) is added after this, that message (MSH) will get added to the first BHS found if there is one, otherwise it will just be added. This might be typical inside a file output process.

    Since

    1.0.0

    -

exists

fileName

exists

fileName

  • fileName(): string

  • Get File name

    Returns string

    Description

    Get File name going to be created.

    Since

    1.2.0

    -

forEach

get

forEach

get

isEmpty

messages

isEmpty

messages

  • messages(): Message[]

  • Get Messages within a submitted File Batch

    Returns Message[]

    Returns an array of messages or a HL7ParserError will throw.

    Description

    This will parse the passed on "text" in the contractor options and get all the messages (MSH) segments within it and return an array of them. @@ -71,7 +71,7 @@

    SinceExample

    try {
     // parser the batch
     const parser = new FileBatch({ text: loadedMessage })
     // load the messages
     const allMessage = parser.messages()
     // loop messages
     allMessage.forEach((message: Message) => {
       const messageParsed = new Message({ text: message.toString() })
     })
    } catch (e) {
      // error here
    }
    -

set

set

start

start

toArray

toBoolean

toDate

toFile

  • toFile(_name, _newLine?, _location?): void

  • Parameters

    • _name: string
    • Optional_newLine: boolean
    • Optional_location: string

    Returns void

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddcreateFileendexistsfileNameforEachgetisEmptymessagessetstarttoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file +

toArray

toBoolean

toDate

toFile

  • toFile(_name, _newLine?, _location?): void

  • Parameters

    • _name: string
    • Optional_newLine: boolean
    • Optional_location: string

    Returns void

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddcreateFileendexistsfileNameforEachgetisEmptymessagessetstarttoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file diff --git a/classes/CORE.HL7Error.html b/classes/CORE.HL7Error.html index 6ce34fa..34a068b 100644 --- a/classes/CORE.HL7Error.html +++ b/classes/CORE.HL7Error.html @@ -1,4 +1,4 @@ -HL7Error | Node HL7 Client - v2.3.1-beta.1

Class HL7Error

Parent Cass of HL7 Error

+HL7Error | Node HL7 Client - v2.3.1

Class HL7Error

Parent Cass of HL7 Error

Since

1.0.0

-

Hierarchy (view full)

Properties

code -

Properties

code

code: number

Settings

Member Visibility

On This Page

code
\ No newline at end of file +

Hierarchy (view full)

Properties

code +

Properties

code

code: number

Settings

Member Visibility

On This Page

code
\ No newline at end of file diff --git a/classes/CORE.HL7FatalError.html b/classes/CORE.HL7FatalError.html index 331b748..50bb8f6 100644 --- a/classes/CORE.HL7FatalError.html +++ b/classes/CORE.HL7FatalError.html @@ -1,5 +1,5 @@ -HL7FatalError | Node HL7 Client - v2.3.1-beta.1

Class HL7FatalError

Used to indicate a fatal failure of a connection.

+HL7FatalError | Node HL7 Client - v2.3.1

Class HL7FatalError

Used to indicate a fatal failure of a connection.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

code -

Constructors

constructor

Properties

code

code: number

Settings

Member Visibility

On This Page

constructorcode
\ No newline at end of file +

Constructors

constructor

Properties

code

code: number

Settings

Member Visibility

On This Page

constructorcode
\ No newline at end of file diff --git a/classes/CORE.HL7ParserError.html b/classes/CORE.HL7ParserError.html index b030c5e..72ae325 100644 --- a/classes/CORE.HL7ParserError.html +++ b/classes/CORE.HL7ParserError.html @@ -1,4 +1,4 @@ -HL7ParserError | Node HL7 Client - v2.3.1-beta.1

Class HL7ParserError

Used to indicate a fatal failure of a connection.

+HL7ParserError | Node HL7 Client - v2.3.1

Class HL7ParserError

Used to indicate a fatal failure of a connection.

Since

1.0.0

-

Hierarchy

  • Error
    • HL7ParserError

Constructors

constructor -

Constructors

constructor

  • new HL7ParserError(message?): HL7ParserError

  • Parameters

    • Optionalmessage: string

    Returns HL7ParserError

Settings

Member Visibility

On This Page

constructor
\ No newline at end of file +

Hierarchy

  • Error
    • HL7ParserError

Constructors

constructor +

Constructors

constructor

  • new HL7ParserError(message?): HL7ParserError

  • Parameters

    • Optionalmessage: string

    Returns HL7ParserError

Settings

Member Visibility

On This Page

constructor
\ No newline at end of file diff --git a/classes/CORE.InboundResponse.html b/classes/CORE.InboundResponse.html index dabdfb4..c95edbc 100644 --- a/classes/CORE.InboundResponse.html +++ b/classes/CORE.InboundResponse.html @@ -1,13 +1,13 @@ -InboundResponse | Node HL7 Client - v2.3.1-beta.1

Class InboundResponse

Inbound Request

+InboundResponse | Node HL7 Client - v2.3.1

Class InboundResponse

Inbound Request

Since

1.0.0

-

Constructors

constructor +

Constructors

constructor

Methods

getMessage

Constructors

constructor

  • new InboundResponse(data): InboundResponse

  • Process the Inbound Response from the Server

    Parameters

    • data: string

    Returns InboundResponse

    Description

    This takes the string of the response from the server and makes it a message. A response from a broker SHOULD always be a properly formated Hl7 message, we hope.

    Since

    1.0.0

    -

Methods

getMessage

Methods

getMessage

Settings

Member Visibility

On This Page

constructorgetMessage
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructorgetMessage
\ No newline at end of file diff --git a/classes/CORE.Message.html b/classes/CORE.Message.html index d1420bd..6e36833 100644 --- a/classes/CORE.Message.html +++ b/classes/CORE.Message.html @@ -1,6 +1,6 @@ -Message | Node HL7 Client - v2.3.1-beta.1

Class Message

Message Class

+Message | Node HL7 Client - v2.3.1

Class Message

Message Class

Since

1.0.0

-

Hierarchy

  • RootBase
    • Message

Constructors

constructor +

Hierarchy

  • RootBase
    • Message

Constructors

constructor

Properties

_name parent empty @@ -32,27 +32,27 @@

Example

If you are processing a full message, do this:

const message = new Message({text: "The HL7 Message Here"})
... output cut ...

If you are building out a message, do this:

const message = new Message({messageHeader: { ... MSH Header Required Values Here ... }});

which then you add segments with fields and values for your Hl7 message.
-

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

addSegment

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

addSegment

  • addSegment(path): Segment

  • Add a new segment to a message.

    Parameters

    • path: string

    Returns Segment

    Since

    1.0.0

    Description

    Creating a new segment adds an empty segment to the message. It could be blank, or it could have values added into it.

    Example

    const message = new Message({. the correct options here .})

    const segment = message.addSegment('PV1')
    segment.set('PV1.1', 'Value Here');

    // When doing this, it overall adds it to the 'message' object
    // when your output is the final result.

    const finalMessage = message.toString();
    -

ProtectedcreateChild

ProtectedcreateChild

  • createChild(text, _index): HL7Node
  • Protected

    Create a new child of a message which is a segment.

    Parameters

    • text: string

      Segment string. Must be 3 characters long.

    • _index: number

      Not used to create a segment.

    Returns HL7Node

    Since

    See

    Segment

    -

exists

forEach

get

exists

forEach

get

isEmpty

ProtectedpathCore

isEmpty

ProtectedpathCore

  • pathCore(): string[]
  • Protected

    Path Core

    Returns string[]

    Since

    1.0.0

    -

read

read

set

set

toArray

toBoolean

toDate

toFile

  • toFile(name, newLine?, location?, extension?): string

  • Create File from a Message

    +

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

ProtectedwriteCore

toFloat

toInteger

toRaw

toString

write

ProtectedwriteCore

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddSegmentcreateChildexistsforEachgetisEmptypathCorereadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwritewriteCore
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathaddSegmentcreateChildexistsforEachgetisEmptypathCorereadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwritewriteCore
\ No newline at end of file diff --git a/classes/CORE.NodeBase.html b/classes/CORE.NodeBase.html index 8a2e907..637cdfe 100644 --- a/classes/CORE.NodeBase.html +++ b/classes/CORE.NodeBase.html @@ -1,6 +1,6 @@ -NodeBase | Node HL7 Client - v2.3.1-beta.1

Class NodeBase

Node Base

+NodeBase | Node HL7 Client - v2.3.1

Class NodeBase

Node Base

Since

1.0.0

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_name parent empty @@ -22,5 +22,5 @@ toRaw toString write -

Constructors

constructor

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

read

set

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathexistsforEachgetisEmptyreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file +

Constructors

constructor

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

read

set

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

constructor_nameparentemptylengthnamepathexistsforEachgetisEmptyreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file diff --git a/classes/CORE.Segment.html b/classes/CORE.Segment.html index 2dec842..b726f28 100644 --- a/classes/CORE.Segment.html +++ b/classes/CORE.Segment.html @@ -1,6 +1,6 @@ -Segment | Node HL7 Client - v2.3.1-beta.1

Class Segment

Segment

+Segment | Node HL7 Client - v2.3.1

Class Segment

Segment

Since

1.0.0

-

Hierarchy (view full)

Properties

_name +

Hierarchy (view full)

Properties

_name parent empty

Accessors

length @@ -19,5 +19,5 @@ toRaw toString write -

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

_nameparentemptylengthnamepathexistsforEachgetisEmptytoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file +

Properties

_name

_name: string

Protectedparent

parent: null | NodeBase

Staticempty

empty: EmptyNode = ...

Accessors

length

name

path

Methods

exists

forEach

get

isEmpty

toArray

toBoolean

toDate

toFile

toFloat

toInteger

toRaw

toString

write

Settings

Member Visibility

On This Page

_nameparentemptylengthnamepathexistsforEachgetisEmptytoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
\ No newline at end of file diff --git a/classes/CORE.default.html b/classes/CORE.default.html index e1ecc8d..eb12a5e 100644 --- a/classes/CORE.default.html +++ b/classes/CORE.default.html @@ -1,7 +1,7 @@ -default | Node HL7 Client - v2.3.1-beta.1

Class default

Client Class

+default | Node HL7 Client - v2.3.1

Class default

Client Class

Description

The main class that starts a client connection to a valid HL7 TCP/MLLP specified server.

Since

1.0.0

-

Hierarchy

  • EventEmitter
    • default

Constructors

constructor +

Hierarchy

  • EventEmitter
    • default

Constructors

constructor

Methods

closeAll createConnection getHost @@ -14,9 +14,9 @@

SinceExample

const client = new Client({host: '0.0.0.0'})
-

Methods

closeAll

Methods

closeAll

createConnection

createConnection

  • createConnection(props, cb): Connection

  • Connect to a listener to a specified port.

    Parameters

getHost

getHost

  • getHost(): string

  • Get the host that we will connect to. The port might be different from each different "connection"

    Returns string

    Since

    1.1.0

    -

totalAck

totalAck

totalSent

totalSent

  • totalSent(): number

  • Total sent messages in this object lifetime.

    Returns number

    Since

    2.0.0

    -

Settings

Member Visibility

On This Page

constructorcloseAllcreateConnectiongetHosttotalAcktotalSent
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructorcloseAllcreateConnectiongetHosttotalAcktotalSent
\ No newline at end of file diff --git a/classes/HL7.HL7_2_1.html b/classes/HL7.HL7_2_1.html index 8bea271..51aa1d8 100644 --- a/classes/HL7.HL7_2_1.html +++ b/classes/HL7.HL7_2_1.html @@ -1,15 +1,15 @@ -HL7_2_1 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_1

Hl7 Specification Version 2.1

+HL7_2_1 | Node HL7 Client - v2.3.1

Class HL7_2_1

Hl7 Specification Version 2.1

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_2.html b/classes/HL7.HL7_2_2.html index fe9698f..42bd2c1 100644 --- a/classes/HL7.HL7_2_2.html +++ b/classes/HL7.HL7_2_2.html @@ -1,15 +1,15 @@ -HL7_2_2 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_2

Hl7 Specification Version 2.2

+HL7_2_2 | Node HL7 Client - v2.3.1

Class HL7_2_2

Hl7 Specification Version 2.2

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_3.html b/classes/HL7.HL7_2_3.html index 8873143..abb3593 100644 --- a/classes/HL7.HL7_2_3.html +++ b/classes/HL7.HL7_2_3.html @@ -1,15 +1,15 @@ -HL7_2_3 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_3

Hl7 Specification Version 2.3

+HL7_2_3 | Node HL7 Client - v2.3.1

Class HL7_2_3

Hl7 Specification Version 2.3

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_3_1.html b/classes/HL7.HL7_2_3_1.html index b44a9f6..d760c25 100644 --- a/classes/HL7.HL7_2_3_1.html +++ b/classes/HL7.HL7_2_3_1.html @@ -1,15 +1,15 @@ -HL7_2_3_1 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_3_1

Hl7 Specification Version 2.3.1

+HL7_2_3_1 | Node HL7 Client - v2.3.1

Class HL7_2_3_1

Hl7 Specification Version 2.3.1

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_4.html b/classes/HL7.HL7_2_4.html index 30027e9..926954f 100644 --- a/classes/HL7.HL7_2_4.html +++ b/classes/HL7.HL7_2_4.html @@ -1,15 +1,15 @@ -HL7_2_4 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_4

Hl7 Specification Version 2.4

+HL7_2_4 | Node HL7 Client - v2.3.1

Class HL7_2_4

Hl7 Specification Version 2.4

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_5.html b/classes/HL7.HL7_2_5.html index ff2812d..3b844f2 100644 --- a/classes/HL7.HL7_2_5.html +++ b/classes/HL7.HL7_2_5.html @@ -1,15 +1,15 @@ -HL7_2_5 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_5

Hl7 Specification Version 2.5

+HL7_2_5 | Node HL7 Client - v2.3.1

Class HL7_2_5

Hl7 Specification Version 2.5

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_5_1.html b/classes/HL7.HL7_2_5_1.html index d3900c1..a9bf5e8 100644 --- a/classes/HL7.HL7_2_5_1.html +++ b/classes/HL7.HL7_2_5_1.html @@ -1,15 +1,15 @@ -HL7_2_5_1 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_5_1

Hl7 Specification Version 2.5.1

+HL7_2_5_1 | Node HL7 Client - v2.3.1

Class HL7_2_5_1

Hl7 Specification Version 2.5.1

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_6.html b/classes/HL7.HL7_2_6.html index 9e958f5..505ee36 100644 --- a/classes/HL7.HL7_2_6.html +++ b/classes/HL7.HL7_2_6.html @@ -1,15 +1,15 @@ -HL7_2_6 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_6

Hl7 Specification Version 2.6

+HL7_2_6 | Node HL7 Client - v2.3.1

Class HL7_2_6

Hl7 Specification Version 2.6

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_7.html b/classes/HL7.HL7_2_7.html index 4195198..0802ef0 100644 --- a/classes/HL7.HL7_2_7.html +++ b/classes/HL7.HL7_2_7.html @@ -1,15 +1,15 @@ -HL7_2_7 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_7

Hl7 Specification Version 2.7

+HL7_2_7 | Node HL7 Client - v2.3.1

Class HL7_2_7

Hl7 Specification Version 2.7

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_7_1.html b/classes/HL7.HL7_2_7_1.html index 4f02407..3d97563 100644 --- a/classes/HL7.HL7_2_7_1.html +++ b/classes/HL7.HL7_2_7_1.html @@ -1,15 +1,15 @@ -HL7_2_7_1 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_7_1

Hl7 Specification Version 2.7.1

+HL7_2_7_1 | Node HL7 Client - v2.3.1

Class HL7_2_7_1

Hl7 Specification Version 2.7.1

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_2_8.html b/classes/HL7.HL7_2_8.html index 444dae9..19a7754 100644 --- a/classes/HL7.HL7_2_8.html +++ b/classes/HL7.HL7_2_8.html @@ -1,15 +1,15 @@ -HL7_2_8 | Node HL7 Client - v2.3.1-beta.1

Class HL7_2_8

Hl7 Specification Version 2.8

+HL7_2_8 | Node HL7 Client - v2.3.1

Class HL7_2_8

Hl7 Specification Version 2.8

Description

Used to indicate that the message should follow 2.7 specification for retrieval or building a message.

Since

1.0.0

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH -

Constructors

constructor

Properties

name

name: string = ''

Name

+

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/classes/HL7.HL7_SPEC_BASE.html b/classes/HL7.HL7_SPEC_BASE.html index 2ba430c..d9da27a 100644 --- a/classes/HL7.HL7_SPEC_BASE.html +++ b/classes/HL7.HL7_SPEC_BASE.html @@ -1,16 +1,16 @@ -HL7_SPEC_BASE | Node HL7 Client - v2.3.1-beta.1

Class HL7_SPEC_BASE

Base Class of an HL7 Specification

+HL7_SPEC_BASE | Node HL7 Client - v2.3.1

Class HL7_SPEC_BASE

Base Class of an HL7 Specification

Since

1.0.0

-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

name

Methods

buildMSH checkMSH

Constructors

constructor

Properties

name

name: string = ''

Name

Since

1.0.0

-

Methods

buildMSH

Methods

buildMSH

checkMSH

checkMSH

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file +

Settings

Member Visibility

On This Page

constructornamebuildMSHcheckMSH
\ No newline at end of file diff --git a/enums/CORE.Delimiters.html b/enums/CORE.Delimiters.html index 6882e1d..8d4b04d 100644 --- a/enums/CORE.Delimiters.html +++ b/enums/CORE.Delimiters.html @@ -1,17 +1,17 @@ -Delimiters | Node HL7 Client - v2.3.1-beta.1

Enumeration Delimiters

Type of Segments Values

+Delimiters | Node HL7 Client - v2.3.1

Enumeration Delimiters

Type of Segments Values

Description

Used during the class creation to give each type its own index value. This is done during the constructor phase of the classes.

Since

1.0.0

-

Enumeration Members

Component +

Enumeration Members

Component Escape Field Repetition Segment SubComponent

Enumeration Members

Component

Component: 2

Usually within each Field, seperated by ^

-

Escape

Escape: 4

The escape string used within the code.

-

Field

Field: 1

The field of each segment. Usually separated with a |

-

Repetition

Repetition: 3

Usually within each Component, seperated by &

-

Segment

Segment: 0

Usually each line of the overall HL7 Message.

-

SubComponent

SubComponent: 5

Usually within each Field, seperated by ~

-

Settings

Member Visibility

On This Page

ComponentEscapeFieldRepetitionSegmentSubComponent
\ No newline at end of file +

Escape

Escape: 4

The escape string used within the code.

+

Field

Field: 1

The field of each segment. Usually separated with a |

+

Repetition

Repetition: 3

Usually within each Component, seperated by &

+

Segment

Segment: 0

Usually each line of the overall HL7 Message.

+

SubComponent

SubComponent: 5

Usually within each Field, seperated by ~

+

Settings

Member Visibility

On This Page

ComponentEscapeFieldRepetitionSegmentSubComponent
\ No newline at end of file diff --git a/enums/CORE.ReadyState.html b/enums/CORE.ReadyState.html index a239423..6c92d7d 100644 --- a/enums/CORE.ReadyState.html +++ b/enums/CORE.ReadyState.html @@ -1,14 +1,14 @@ -ReadyState | Node HL7 Client - v2.3.1-beta.1

Enumeration ReadyState

State of the Connected to the Server

+ReadyState | Node HL7 Client - v2.3.1

Enumeration ReadyState

State of the Connected to the Server

Description

These are the states that are used to track the connecting to the server side and also during the auto-reconnect phase.

Since

1.0.0

-

Enumeration Members

CLOSED +

Enumeration Members

CLOSED CLOSING CONNECTED CONNECTING OPEN

Enumeration Members

CLOSED

CLOSED: 4

The client connection is closed.

-

CLOSING

CLOSING: 3

The client is closing the connection by force or by timeout

-

CONNECTED

CONNECTED: 1

The client is connected to the server.

-

CONNECTING

CONNECTING: 0

The client is trying to connect to the server.

-

OPEN

OPEN: 2

The client is open, but not yet trying to connect to the server.

-

Settings

Member Visibility

On This Page

CLOSEDCLOSINGCONNECTEDCONNECTINGOPEN
\ No newline at end of file +

CLOSING

CLOSING: 3

The client is closing the connection by force or by timeout

+

CONNECTED

CONNECTED: 1

The client is connected to the server.

+

CONNECTING

CONNECTING: 0

The client is trying to connect to the server.

+

OPEN

OPEN: 2

The client is open, but not yet trying to connect to the server.

+

Settings

Member Visibility

On This Page

CLOSEDCLOSINGCONNECTEDCONNECTINGOPEN
\ No newline at end of file diff --git a/functions/CORE.assertNumber.html b/functions/CORE.assertNumber.html index 987f812..e3776ac 100644 --- a/functions/CORE.assertNumber.html +++ b/functions/CORE.assertNumber.html @@ -1,7 +1,7 @@ -assertNumber | Node HL7 Client - v2.3.1-beta.1

Function assertNumber

Assert Number on a Property

+assertNumber | Node HL7 Client - v2.3.1

Function assertNumber

Assert Number on a Property

Since

1.0.0

  • assertNumber(props, name, min, max?): void

  • Parameters

    • props: Record<string, number>

      Property Object

    • name: string

      Property Name

    • min: number

      Min Number

    • Optionalmax: number

      Max Number

      -

    Returns void

Settings

Member Visibility
\ No newline at end of file +

Returns void

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.createHL7Date.html b/functions/CORE.createHL7Date.html index 46b9981..284e364 100644 --- a/functions/CORE.createHL7Date.html +++ b/functions/CORE.createHL7Date.html @@ -1,4 +1,4 @@ -createHL7Date | Node HL7 Client - v2.3.1-beta.1

Function createHL7Date

Create a valid HL7 Date.

+createHL7Date | Node HL7 Client - v2.3.1

Function createHL7Date

Create a valid HL7 Date.

Description

Custom for this package and based of HL7 specification.

Since

1.0.0

-
  • createHL7Date(date, length?): string

  • Parameters

    • date: Date
    • Optionallength: string

    Returns string

Settings

Member Visibility
\ No newline at end of file +
  • createHL7Date(date, length?): string

  • Parameters

    • date: Date
    • Optionallength: string

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.decodeHexString.html b/functions/CORE.decodeHexString.html index 594356f..6d29630 100644 --- a/functions/CORE.decodeHexString.html +++ b/functions/CORE.decodeHexString.html @@ -1,3 +1,3 @@ -decodeHexString | Node HL7 Client - v2.3.1-beta.1

Function decodeHexString

Decode Hex String

+decodeHexString | Node HL7 Client - v2.3.1

Function decodeHexString

Decode Hex String

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.escapeForRegExp.html b/functions/CORE.escapeForRegExp.html index 9096f61..1449d3c 100644 --- a/functions/CORE.escapeForRegExp.html +++ b/functions/CORE.escapeForRegExp.html @@ -1,3 +1,3 @@ -escapeForRegExp | Node HL7 Client - v2.3.1-beta.1

Function escapeForRegExp

Escape for RegEx Expressing

+escapeForRegExp | Node HL7 Client - v2.3.1

Function escapeForRegExp

Escape for RegEx Expressing

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.expBackoff.html b/functions/CORE.expBackoff.html index 5294ae9..4f80a63 100644 --- a/functions/CORE.expBackoff.html +++ b/functions/CORE.expBackoff.html @@ -1,7 +1,7 @@ -expBackoff | Node HL7 Client - v2.3.1-beta.1

Function expBackoff

Calculate exponential backoff/retry delay. +expBackoff | Node HL7 Client - v2.3.1

Function expBackoff

Calculate exponential backoff/retry delay. Where attempts >= 1, exp > 1

Example

expBackoff(1000, 30000, attempts)
  ---------------------------------
   attempts | possible delay
  ----------+----------------------
       1    | 1000 to 2000
       2    | 1000 to 4000
       3    | 1000 to 8000
       4    | 1000 to 16000
       5    | 1000 to 30000
  ---------------------------------
Attempts required before max delay is possible = Math.ceil(Math.log(high/step) / Math.log(exp))

Since

1.0.0

-
  • expBackoff(step, high, attempts, exp?): number

  • Parameters

    • step: number
    • high: number
    • attempts: number
    • exp: number = 2

    Returns number

Settings

Member Visibility
\ No newline at end of file +
  • expBackoff(step, high, attempts, exp?): number

  • Parameters

    • step: number
    • high: number
    • attempts: number
    • exp: number = 2

    Returns number

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.isBatch.html b/functions/CORE.isBatch.html index 970e920..d9f14e4 100644 --- a/functions/CORE.isBatch.html +++ b/functions/CORE.isBatch.html @@ -1,3 +1,3 @@ -isBatch | Node HL7 Client - v2.3.1-beta.1

Function isBatch

Check to see if the message starts with Batch (BHS) header segment.

+isBatch | Node HL7 Client - v2.3.1

Function isBatch

Check to see if the message starts with Batch (BHS) header segment.

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.isFile.html b/functions/CORE.isFile.html index 0c38b95..3ba2c26 100644 --- a/functions/CORE.isFile.html +++ b/functions/CORE.isFile.html @@ -1,2 +1,2 @@ -isFile | Node HL7 Client - v2.3.1-beta.1

Function isFile

Check to see if the message starts with a File Batch (FHS) header segment.

-

Settings

Member Visibility
\ No newline at end of file +isFile | Node HL7 Client - v2.3.1

Function isFile

Check to see if the message starts with a File Batch (FHS) header segment.

+

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.isHL7Number.html b/functions/CORE.isHL7Number.html index e35100b..306679b 100644 --- a/functions/CORE.isHL7Number.html +++ b/functions/CORE.isHL7Number.html @@ -1,4 +1,4 @@ -isHL7Number | Node HL7 Client - v2.3.1-beta.1

Function isHL7Number

Is Number

+isHL7Number | Node HL7 Client - v2.3.1

Function isHL7Number

Is Number

Description

Custom for this package.

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.isHL7String.html b/functions/CORE.isHL7String.html index 19504eb..7631ad6 100644 --- a/functions/CORE.isHL7String.html +++ b/functions/CORE.isHL7String.html @@ -1,4 +1,4 @@ -isHL7String | Node HL7 Client - v2.3.1-beta.1

Function isHL7String

Is String

+isHL7String | Node HL7 Client - v2.3.1

Function isHL7String

Is String

Description

Custom for this package.

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.padHL7Date.html b/functions/CORE.padHL7Date.html index 5f3080b..0cd7dce 100644 --- a/functions/CORE.padHL7Date.html +++ b/functions/CORE.padHL7Date.html @@ -1,3 +1,3 @@ -padHL7Date | Node HL7 Client - v2.3.1-beta.1

Function padHL7Date

HL7 Padding for Date

+padHL7Date | Node HL7 Client - v2.3.1

Function padHL7Date

HL7 Padding for Date

Since

1.0.0

-
  • padHL7Date(n, width, z?): string

  • Parameters

    • n: number
    • width: number
    • z: string = '0'

    Returns string

Settings

Member Visibility
\ No newline at end of file +
  • padHL7Date(n, width, z?): string

  • Parameters

    • n: number
    • width: number
    • z: string = '0'

    Returns string

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.randomString.html b/functions/CORE.randomString.html index 23582e9..14a775a 100644 --- a/functions/CORE.randomString.html +++ b/functions/CORE.randomString.html @@ -1,3 +1,3 @@ -randomString | Node HL7 Client - v2.3.1-beta.1

Function randomString

Generate a random string

+randomString | Node HL7 Client - v2.3.1

Function randomString

Generate a random string

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.validIPv4.html b/functions/CORE.validIPv4.html index bfe68d5..964e8b4 100644 --- a/functions/CORE.validIPv4.html +++ b/functions/CORE.validIPv4.html @@ -1,3 +1,3 @@ -validIPv4 | Node HL7 Client - v2.3.1-beta.1

Function validIPv4

Valid IPv4 Checker

+validIPv4 | Node HL7 Client - v2.3.1

Function validIPv4

Valid IPv4 Checker

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/CORE.validIPv6.html b/functions/CORE.validIPv6.html index 87ba40b..a3f7024 100644 --- a/functions/CORE.validIPv6.html +++ b/functions/CORE.validIPv6.html @@ -1,3 +1,3 @@ -validIPv6 | Node HL7 Client - v2.3.1-beta.1

Function validIPv6

Valid IPv6 Checker

+validIPv6 | Node HL7 Client - v2.3.1

Function validIPv6

Valid IPv6 Checker

Since

1.0.0

-

Settings

Member Visibility
\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index fd5257e..6248daf 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -Node HL7 Client - v2.3.1-beta.1

Node HL7 Client - v2.3.1-beta.1

Class Hierarchy

Settings

Member Visibility
\ No newline at end of file +Node HL7 Client - v2.3.1

Node HL7 Client - v2.3.1

Class Hierarchy

Settings

Member Visibility
\ No newline at end of file diff --git a/index.html b/index.html index 2d5b9de..0047065 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Node HL7 Client - v2.3.1-beta.1

Node HL7 Client - v2.3.1-beta.1

Node HL7 Client

+Node HL7 Client - v2.3.1

Node HL7 Client - v2.3.1

Node HL7 Client

A pure Node.js HL7 Client that allows for communication to a HL7 Broker/Server that can send properly formatted HL7 messages with ease. Separately, it can also parse and extract out any segment within an HL7 message. @@ -56,4 +56,4 @@

  • My Wife and Baby Girl.

    • License

    Licensed under MIT.

    -

    Settings

    Member Visibility

    On This Page

    Node HL7 ClientInstallTable of ContentsKeyword DefinitionsDocumentationAcknowledgementsLicense
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Node HL7 ClientInstallTable of ContentsKeyword DefinitionsDocumentationAcknowledgementsLicense
    \ No newline at end of file diff --git a/interfaces/CORE.ClientBuilderFileOptions.html b/interfaces/CORE.ClientBuilderFileOptions.html index 4c67886..4df0961 100644 --- a/interfaces/CORE.ClientBuilderFileOptions.html +++ b/interfaces/CORE.ClientBuilderFileOptions.html @@ -1,10 +1,10 @@ -ClientBuilderFileOptions | Node HL7 Client - v2.3.1-beta.1

    Interface ClientBuilderFileOptions

    Client Builder Options

    +ClientBuilderFileOptions | Node HL7 Client - v2.3.1

    Interface ClientBuilderFileOptions

    Client Builder Options

    Description

    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 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? +
    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? extension? fileBuffer? fullFilePath? @@ -23,16 +23,16 @@

    SinceDefault

    14
    -

    Optionalextension

    extension?: string

    Extension of the file when it gets created.

    +

    Optionalextension

    extension?: string

    Extension of the file when it gets created.

    Since

    1.0.0

    Default

    hl7
    -

    OptionalfileBuffer

    fileBuffer?: Buffer

    The file as a buffer passed onto the constructor

    +

    OptionalfileBuffer

    fileBuffer?: Buffer

    The file as a buffer passed onto the constructor

    Since

    1.0.0

    -

    OptionalfullFilePath

    fullFilePath?: string

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

    +

    OptionalfullFilePath

    fullFilePath?: string

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

    Since

    1.0.0

    -

    Optionallocation

    location?: string

    Location where the file will be saved. +

    Optionallocation

    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, @@ -42,49 +42,49 @@

    DefaultDefault

    ""
    -

    OptionalnewLine

    newLine?: string

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

    +

    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?

    +

    Optionalparsing

    parsing?: boolean

    Parsing a message?

    Since

    1.0.0

    Default

    false
    -

    OptionalseparatorComponent

    separatorComponent?: string

    The character used to separate different components.

    +

    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.

    +

    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.

    +

    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.

    +

    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.

    +

    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. +

    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.

    +

    Optionaltext

    text?: string

    The HL7 string that we are going to parse.

    Default

    ""
    -

    Settings

    Member Visibility

    On This Page

    dateextensionfileBufferfullFilePathlocationnewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    dateextensionfileBufferfullFilePathlocationnewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file diff --git a/interfaces/CORE.ClientBuilderMessageOptions.html b/interfaces/CORE.ClientBuilderMessageOptions.html index cdb8d23..805e890 100644 --- a/interfaces/CORE.ClientBuilderMessageOptions.html +++ b/interfaces/CORE.ClientBuilderMessageOptions.html @@ -1,10 +1,10 @@ -ClientBuilderMessageOptions | Node HL7 Client - v2.3.1-beta.1

    Interface ClientBuilderMessageOptions

    Client Builder Options

    +ClientBuilderMessageOptions | Node HL7 Client - v2.3.1

    Interface ClientBuilderMessageOptions

    Client Builder Options

    Description

    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? +
    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? @@ -20,51 +20,51 @@

    SinceDefault

    14
    -

    OptionalmessageHeader

    messageHeader?: MSH

    MSH Header Options

    +

    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.

    +

    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?

    +

    Optionalparsing

    parsing?: boolean

    Parsing a message?

    Since

    1.0.0

    Default

    false
    -

    OptionalseparatorComponent

    separatorComponent?: string

    The character used to separate different components.

    +

    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.

    +

    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.

    +

    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.

    +

    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.

    +

    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. +

    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.

    +

    Optionaltext

    text?: string

    The HL7 string that we are going to parse.

    Default

    ""
    -

    Settings

    Member Visibility

    On This Page

    datemessageHeadernewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    datemessageHeadernewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file diff --git a/interfaces/CORE.ClientBuilderOptions.html b/interfaces/CORE.ClientBuilderOptions.html index 3fbbe54..1f946f2 100644 --- a/interfaces/CORE.ClientBuilderOptions.html +++ b/interfaces/CORE.ClientBuilderOptions.html @@ -1,10 +1,10 @@ -ClientBuilderOptions | Node HL7 Client - v2.3.1-beta.1

    Interface ClientBuilderOptions

    Client Builder Options

    +ClientBuilderOptions | Node HL7 Client - v2.3.1

    Interface ClientBuilderOptions

    Client Builder Options

    Description

    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 ClientBuilderOptions {
        date?: string;
        newLine?: string;
        parsing?: boolean;
        separatorComponent?: string;
        separatorEscape?: string;
        separatorField?: string;
        separatorRepetition?: string;
        separatorSubComponent?: string;
        specification?: any;
        text?: string;
    }

    Hierarchy (view full)

    Properties

    date? +
    interface ClientBuilderOptions {
        date?: string;
        newLine?: string;
        parsing?: boolean;
        separatorComponent?: string;
        separatorEscape?: string;
        separatorField?: string;
        separatorRepetition?: string;
        separatorSubComponent?: string;
        specification?: any;
        text?: string;
    }

    Hierarchy (view full)

    Properties

    date? newLine? parsing? separatorComponent? @@ -19,49 +19,49 @@

    SinceDefault

    14
    -

    OptionalnewLine

    newLine?: string

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

    +

    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?

    +

    Optionalparsing

    parsing?: boolean

    Parsing a message?

    Since

    1.0.0

    Default

    false
    -

    OptionalseparatorComponent

    separatorComponent?: string

    The character used to separate different components.

    +

    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.

    +

    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.

    +

    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.

    +

    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.

    +

    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. +

    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.

    +

    Optionaltext

    text?: string

    The HL7 string that we are going to parse.

    Default

    ""
    -

    Settings

    Member Visibility

    On This Page

    datenewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    datenewLineparsingseparatorComponentseparatorEscapeseparatorFieldseparatorRepetitionseparatorSubComponentspecificationtext
    \ No newline at end of file diff --git a/interfaces/CORE.ClientListenerOptions.html b/interfaces/CORE.ClientListenerOptions.html index bdcd27b..c13dc9d 100644 --- a/interfaces/CORE.ClientListenerOptions.html +++ b/interfaces/CORE.ClientListenerOptions.html @@ -1,4 +1,4 @@ -ClientListenerOptions | Node HL7 Client - v2.3.1-beta.1

    Interface ClientListenerOptions

    interface ClientListenerOptions {
        autoConnect?: boolean;
        connectionTimeout?: number;
        encoding?: BufferEncoding;
        host?: string;
        ipv4?: boolean;
        ipv6?: boolean;
        maxAttempts?: number;
        maxConnectionAttempts?: number;
        maxConnections?: number;
        maxTimeout?: number;
        port: number;
        retryHigh?: number;
        retryLow?: number;
        socket?: TcpSocketConnectOpts;
        tls?: boolean | ConnectionOptions;
        waitAck?: boolean;
    }

    Hierarchy (view full)

    Properties

    autoConnect? +ClientListenerOptions | Node HL7 Client - v2.3.1

    Interface ClientListenerOptions

    interface ClientListenerOptions {
        autoConnect?: boolean;
        connectionTimeout?: number;
        encoding?: BufferEncoding;
        host?: string;
        ipv4?: boolean;
        ipv6?: boolean;
        maxAttempts?: number;
        maxConnectionAttempts?: number;
        maxConnections?: number;
        maxTimeout?: number;
        port: number;
        retryHigh?: number;
        retryLow?: number;
        socket?: TcpSocketConnectOpts;
        tls?: boolean | ConnectionOptions;
        waitAck?: boolean;
    }

    Hierarchy (view full)

    Properties

    autoConnect? connectionTimeout? encoding? host? @@ -19,62 +19,62 @@

    Default

    true
    -

    OptionalconnectionTimeout

    connectionTimeout?: number

    How long a connection attempt checked before ending the socket and attempting again. +

    OptionalconnectionTimeout

    connectionTimeout?: number

    How long a connection attempt checked before ending the socket and attempting again. Min. is 1000 (1 second) and Max. is 60000 (60 seconds.) Note: Less than 10 seconds could cause some serious issues. Use with caution.

    Default

    10000
    -

    Optionalencoding

    encoding?: BufferEncoding

    Encoding of the messages we expect from the HL7 message.

    +

    Optionalencoding

    encoding?: BufferEncoding

    Encoding of the messages we expect from the HL7 message.

    Default

    "utf-8"
    -

    Optionalhost

    host?: string

    Host - You can do a FQDN or the IPv(4|6) address.

    -

    Optionalipv4

    ipv4?: boolean

    IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.

    +

    Optionalhost

    host?: string

    Host - You can do a FQDN or the IPv(4|6) address.

    +

    Optionalipv4

    ipv4?: boolean

    IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.

    Default

    false
    -

    Optionalipv6

    ipv6?: boolean

    IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.

    +

    Optionalipv6

    ipv6?: boolean

    IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.

    Default

    false
    -

    OptionalmaxAttempts

    maxAttempts?: number

    Max attempts +

    OptionalmaxAttempts

    maxAttempts?: number

    Max attempts to send the message before an error is thrown if we are in the process of re-attempting to connect to the server. Has to be greater than 1. You cannot exceed 50.

    Default

    10
    -

    OptionalmaxConnectionAttempts

    maxConnectionAttempts?: number

    If we are trying to establish an initial connection to the server, let's end it after this many attempts. +

    OptionalmaxConnectionAttempts

    maxConnectionAttempts?: number

    If we are trying to establish an initial connection to the server, let's end it after this many attempts. The time between re-connects is determined by connectionTimeout. You cannot exceed 50.

    Since

    1.1.0

    Default

    30
    -

    OptionalmaxConnections

    maxConnections?: number

    Max Connections this connection makes. +

    OptionalmaxConnections

    maxConnections?: number

    Max Connections this connection makes. Has to be greater than 1.

    Default

    10
    -

    OptionalmaxTimeout

    maxTimeout?: number

    The number of times a connection timeout occurs until it stops attempting and just stops.

    +

    OptionalmaxTimeout

    maxTimeout?: number

    The number of times a connection timeout occurs until it stops attempting and just stops.

    Since

    2.1.0

    Default

    10
    -

    port

    port: number

    The port we should connect to on the server.

    -

    OptionalretryHigh

    retryHigh?: number

    Max delay, in milliseconds, for exponential-backoff when reconnecting

    +

    port

    port: number

    The port we should connect to on the server.

    +

    OptionalretryHigh

    retryHigh?: number

    Max delay, in milliseconds, for exponential-backoff when reconnecting

    Default

    30_000
    -

    OptionalretryLow

    retryLow?: number

    Step size, in milliseconds, for exponential-backoff when reconnecting

    +

    OptionalretryLow

    retryLow?: number

    Step size, in milliseconds, for exponential-backoff when reconnecting

    Default

    1000
    -

    Optionalsocket

    socket?: TcpSocketConnectOpts

    Additional options when creating the TCP socket with net.connect().

    -

    Optionaltls

    tls?: boolean | ConnectionOptions

    Enable TLS, or set TLS specific options like overriding the CA for +

    Optionalsocket

    socket?: TcpSocketConnectOpts

    Additional options when creating the TCP socket with net.connect().

    +

    Optionaltls

    tls?: boolean | ConnectionOptions

    Enable TLS, or set TLS specific options like overriding the CA for self-signed certificates.

    -

    OptionalwaitAck

    waitAck?: boolean

    Wait for ACK before sending a new message. +

    OptionalwaitAck

    waitAck?: boolean

    Wait for ACK before sending a new message. If this is set to false, you can send as many messages as you want but since you are not expecting any ACK from a previous message sent before sending another one. This does not stop the "total acknowledgement" counter on the @@ -82,4 +82,4 @@

    Default

    Default

    true *
    -

    Settings

    Member Visibility

    On This Page

    autoConnectconnectionTimeoutencodinghostipv4ipv6maxAttemptsmaxConnectionAttemptsmaxConnectionsmaxTimeoutportretryHighretryLowsockettlswaitAck
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    autoConnectconnectionTimeoutencodinghostipv4ipv6maxAttemptsmaxConnectionAttemptsmaxConnectionsmaxTimeoutportretryHighretryLowsockettlswaitAck
    \ No newline at end of file diff --git a/interfaces/CORE.ClientOptions.html b/interfaces/CORE.ClientOptions.html index 2566ca4..d59a48f 100644 --- a/interfaces/CORE.ClientOptions.html +++ b/interfaces/CORE.ClientOptions.html @@ -1,4 +1,4 @@ -ClientOptions | Node HL7 Client - v2.3.1-beta.1

    Interface ClientOptions

    interface ClientOptions {
        connectionTimeout?: number;
        host?: string;
        ipv4?: boolean;
        ipv6?: boolean;
        maxAttempts?: number;
        maxConnectionAttempts?: number;
        maxTimeout?: number;
        retryHigh?: number;
        retryLow?: number;
        socket?: TcpSocketConnectOpts;
        tls?: boolean | ConnectionOptions;
    }

    Hierarchy (view full)

    Properties

    connectionTimeout? +ClientOptions | Node HL7 Client - v2.3.1

    Interface ClientOptions

    interface ClientOptions {
        connectionTimeout?: number;
        host?: string;
        ipv4?: boolean;
        ipv6?: boolean;
        maxAttempts?: number;
        maxConnectionAttempts?: number;
        maxTimeout?: number;
        retryHigh?: number;
        retryLow?: number;
        socket?: TcpSocketConnectOpts;
        tls?: boolean | ConnectionOptions;
    }

    Hierarchy (view full)

    Properties

    connectionTimeout? host? ipv4? ipv6? @@ -16,42 +16,42 @@

    Default

    10000
    -

    Optionalhost

    host?: string

    Host - You can do a FQDN or the IPv(4|6) address.

    -

    Optionalipv4

    ipv4?: boolean

    IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.

    +

    Optionalhost

    host?: string

    Host - You can do a FQDN or the IPv(4|6) address.

    +

    Optionalipv4

    ipv4?: boolean

    IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.

    Default

    false
    -

    Optionalipv6

    ipv6?: boolean

    IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.

    +

    Optionalipv6

    ipv6?: boolean

    IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.

    Default

    false
    -

    OptionalmaxAttempts

    maxAttempts?: number

    Max attempts +

    OptionalmaxAttempts

    maxAttempts?: number

    Max attempts to send the message before an error is thrown if we are in the process of re-attempting to connect to the server. Has to be greater than 1. You cannot exceed 50.

    Default

    10
    -

    OptionalmaxConnectionAttempts

    maxConnectionAttempts?: number

    If we are trying to establish an initial connection to the server, let's end it after this many attempts. +

    OptionalmaxConnectionAttempts

    maxConnectionAttempts?: number

    If we are trying to establish an initial connection to the server, let's end it after this many attempts. The time between re-connects is determined by connectionTimeout. You cannot exceed 50.

    Since

    1.1.0

    Default

    30
    -

    OptionalmaxTimeout

    maxTimeout?: number

    The number of times a connection timeout occurs until it stops attempting and just stops.

    +

    OptionalmaxTimeout

    maxTimeout?: number

    The number of times a connection timeout occurs until it stops attempting and just stops.

    Since

    2.1.0

    Default

    10
    -

    OptionalretryHigh

    retryHigh?: number

    Max delay, in milliseconds, for exponential-backoff when reconnecting

    +

    OptionalretryHigh

    retryHigh?: number

    Max delay, in milliseconds, for exponential-backoff when reconnecting

    Default

    30_000
    -

    OptionalretryLow

    retryLow?: number

    Step size, in milliseconds, for exponential-backoff when reconnecting

    +

    OptionalretryLow

    retryLow?: number

    Step size, in milliseconds, for exponential-backoff when reconnecting

    Default

    1000
    -

    Optionalsocket

    socket?: TcpSocketConnectOpts

    Additional options when creating the TCP socket with net.connect().

    -

    Optionaltls

    tls?: boolean | ConnectionOptions

    Enable TLS, or set TLS specific options like overriding the CA for +

    Optionalsocket

    socket?: TcpSocketConnectOpts

    Additional options when creating the TCP socket with net.connect().

    +

    Optionaltls

    tls?: boolean | ConnectionOptions

    Enable TLS, or set TLS specific options like overriding the CA for self-signed certificates.

    -

    Settings

    Member Visibility

    On This Page

    connectionTimeouthostipv4ipv6maxAttemptsmaxConnectionAttemptsmaxTimeoutretryHighretryLowsockettls
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    connectionTimeouthostipv4ipv6maxAttemptsmaxConnectionAttemptsmaxTimeoutretryHighretryLowsockettls
    \ No newline at end of file diff --git a/interfaces/CORE.HL7Node.html b/interfaces/CORE.HL7Node.html index 3f6ed6b..3ee5a26 100644 --- a/interfaces/CORE.HL7Node.html +++ b/interfaces/CORE.HL7Node.html @@ -1,6 +1,6 @@ -HL7Node | Node HL7 Client - v2.3.1-beta.1

    Interface HL7Node

    Node Base

    +HL7Node | Node HL7 Client - v2.3.1

    Interface HL7Node

    Node Base

    Since

    1.0.0

    -
    interface HL7Node {
        exists: ((path: string | number) => boolean);
        forEach: ((callback: ((value: HL7Node, index: number) => void)) => void);
        get: ((path: string | number) => HL7Node);
        isEmpty: (() => boolean);
        length: number;
        name: string;
        path: string[];
        read: ((path: string[]) => HL7Node);
        set: ((path: string | number, value?: any) => HL7Node);
        toArray: (() => HL7Node[]);
        toBoolean: (() => boolean);
        toDate: (() => Date);
        toFile: ((name: string, newLine?: boolean, location?: string) => void);
        toFloat: (() => number);
        toInteger: (() => number);
        toRaw: (() => string);
        toString: (() => string);
        write: ((path: string[], value: string) => HL7Node);
    }

    Implemented by

    Properties

    exists +
    interface HL7Node {
        exists: ((path: string | number) => boolean);
        forEach: ((callback: ((value: HL7Node, index: number) => void)) => void);
        get: ((path: string | number) => HL7Node);
        isEmpty: (() => boolean);
        length: number;
        name: string;
        path: string[];
        read: ((path: string[]) => HL7Node);
        set: ((path: string | number, value?: any) => HL7Node);
        toArray: (() => HL7Node[]);
        toBoolean: (() => boolean);
        toDate: (() => Date);
        toFile: ((name: string, newLine?: boolean, location?: string) => void);
        toFloat: (() => number);
        toInteger: (() => number);
        toRaw: (() => string);
        toString: (() => string);
        write: ((path: string[], value: string) => HL7Node);
    }

    Implemented by

    Properties

    exists forEach get isEmpty @@ -18,4 +18,4 @@ toRaw toString write -

    Properties

    exists

    exists: ((path: string | number) => boolean)

    forEach

    forEach: ((callback: ((value: HL7Node, index: number) => void)) => void)

    get

    get: ((path: string | number) => HL7Node)

    isEmpty

    isEmpty: (() => boolean)

    length

    length: number

    name

    name: string

    path

    path: string[]

    read

    read: ((path: string[]) => HL7Node)

    set

    set: ((path: string | number, value?: any) => HL7Node)

    toArray

    toArray: (() => HL7Node[])

    toBoolean

    toBoolean: (() => boolean)

    toDate

    toDate: (() => Date)

    toFile

    toFile: ((name: string, newLine?: boolean, location?: string) => void)

    toFloat

    toFloat: (() => number)

    toInteger

    toInteger: (() => number)

    toRaw

    toRaw: (() => string)

    toString

    toString: (() => string)

    write

    write: ((path: string[], value: string) => HL7Node)

    Settings

    Member Visibility

    On This Page

    existsforEachgetisEmptylengthnamepathreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
    \ No newline at end of file +

    Properties

    exists

    exists: ((path: string | number) => boolean)

    forEach

    forEach: ((callback: ((value: HL7Node, index: number) => void)) => void)

    get

    get: ((path: string | number) => HL7Node)

    isEmpty

    isEmpty: (() => boolean)

    length

    length: number

    name

    name: string

    path

    path: string[]

    read

    read: ((path: string[]) => HL7Node)

    set

    set: ((path: string | number, value?: any) => HL7Node)

    toArray

    toArray: (() => HL7Node[])

    toBoolean

    toBoolean: (() => boolean)

    toDate

    toDate: (() => Date)

    toFile

    toFile: ((name: string, newLine?: boolean, location?: string) => void)

    toFloat

    toFloat: (() => number)

    toInteger

    toInteger: (() => number)

    toRaw

    toRaw: (() => string)

    toString

    toString: (() => string)

    write

    write: ((path: string[], value: string) => HL7Node)

    Settings

    Member Visibility

    On This Page

    existsforEachgetisEmptylengthnamepathreadsettoArraytoBooleantoDatetoFiletoFloattoIntegertoRawtoStringwrite
    \ No newline at end of file diff --git a/interfaces/CORE.IConnection.html b/interfaces/CORE.IConnection.html index b359d5e..e866983 100644 --- a/interfaces/CORE.IConnection.html +++ b/interfaces/CORE.IConnection.html @@ -1,10 +1,10 @@ -IConnection | Node HL7 Client - v2.3.1-beta.1

    Interface IConnection

    interface IConnection {
        on(name: "close", cb: (() => void)): this;
        on(name: "connect", cb: (() => void)): this;
        on(name: "connection", cb: (() => void)): this;
        on(name: "open", cb: (() => void)): this;
        on(name: "client.acknowledged", cb: ((number: number) => void)): this;
        on(name: "client.error", cb: ((err: any) => void)): this;
        on(name: "client.sent", cb: ((number: number) => void)): this;
        on(name: "client.timeout", cb: (() => void)): this;
    }

    Hierarchy

    • EventEmitter
      • IConnection

    Implemented by

    Methods

    on +IConnection | Node HL7 Client - v2.3.1

    Interface IConnection

    interface IConnection {
        on(name: "close", cb: (() => void)): this;
        on(name: "connect", cb: (() => void)): this;
        on(name: "connection", cb: (() => void)): this;
        on(name: "open", cb: (() => void)): this;
        on(name: "client.acknowledged", cb: ((number: number) => void)): this;
        on(name: "client.error", cb: ((err: any) => void)): this;
        on(name: "client.sent", cb: ((number: number) => void)): this;
        on(name: "client.timeout", cb: (() => void)): this;
    }

    Hierarchy

    • EventEmitter
      • IConnection

    Implemented by

    Methods

    on

    Methods

    on

    • on(name, cb): this

    • The connection has been closed manually. You have to start the connection again.

      -

      Parameters

      • name: "close"
      • cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(name, cb): this

    • The connection is made.

      -

      Parameters

      • name: "connect"
      • cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(name, cb): this

    • The connection is being (re)established or attempting to re-connect.

      -

      Parameters

      • name: "connection"
      • cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(name, cb): this

    • The handle is open to do a manual start to connect.

      -

      Parameters

      • name: "open"
      • cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(name, cb): this

    • The total acknowledged for this connection.

      -

      Parameters

      • name: "client.acknowledged"
      • cb: ((number: number) => void)
          • (number): void

          • Parameters

            • number: number

            Returns void

      Returns this

    • on(name, cb): this

    • The connection has an error.

      -

      Parameters

      • name: "client.error"
      • cb: ((err: any) => void)
          • (err): void

          • Parameters

            • err: any

            Returns void

      Returns this

    • on(name, cb): this

    • The total sent for this connection.

      -

      Parameters

      • name: "client.sent"
      • cb: ((number: number) => void)
          • (number): void

          • Parameters

            • number: number

            Returns void

      Returns this

    • on(name, cb): this

    • The connection has timeout. Review "client.error" event for the reason.

      -

      Parameters

      • name: "client.timeout"
      • cb: (() => void)
          • (): void

          • Returns void

      Returns this

    Settings

    Member Visibility

    On This Page

    on
    \ No newline at end of file +

    Parameters

    • name: "close"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The connection is made.

    +

    Parameters

    • name: "connect"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The connection is being (re)established or attempting to re-connect.

    +

    Parameters

    • name: "connection"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The handle is open to do a manual start to connect.

    +

    Parameters

    • name: "open"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

  • on(name, cb): this

  • The total acknowledged for this connection.

    +

    Parameters

    • name: "client.acknowledged"
    • cb: ((number: number) => void)
        • (number): void

        • Parameters

          • number: number

          Returns void

    Returns this

  • on(name, cb): this

  • The connection has an error.

    +

    Parameters

    • name: "client.error"
    • cb: ((err: any) => void)
        • (err): void

        • Parameters

          • err: any

          Returns void

    Returns this

  • on(name, cb): this

  • The total sent for this connection.

    +

    Parameters

    • name: "client.sent"
    • cb: ((number: number) => void)
        • (number): void

        • Parameters

          • number: number

          Returns void

    Returns this

  • on(name, cb): this

  • The connection has timeout. Review "client.error" event for the reason.

    +

    Parameters

    • name: "client.timeout"
    • cb: (() => void)
        • (): void

        • Returns void

    Returns this

    • Settings

    Member Visibility

    On This Page

    on
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_1_MSH.html b/interfaces/HL7.HL7_2_1_MSH.html index 1498648..b083676 100644 --- a/interfaces/HL7.HL7_2_1_MSH.html +++ b/interfaces/HL7.HL7_2_1_MSH.html @@ -1,4 +1,4 @@ -HL7_2_1_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_1_MSH

    HL7 2.1 MSH Specification

    +HL7_2_1_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_1_MSH

    HL7 2.1 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_1_MSH {
            msh_10?: string;
        msh_11: "D" | "P" | "T";
        msh_9: string;
    }

    Properties

    msh_10? +
    interface HL7_2_1_MSH {
        msh_10?: string;
        msh_11: "D" | "P" | "T";
        msh_9: string;
    }

    Properties

    msh_10? msh_11 msh_9

    Properties

    Optionalmsh_10

    msh_10?: string

    Message Control ID

    @@ -24,8 +24,8 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11

    msh_11: "D" | "P" | "T"

    Processing ID

    +

    msh_11

    msh_11: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    msh_9

    msh_9: string

    Message Code

    +

    msh_9

    msh_9: string

    Message Code

    Since

    1.0.0

    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11msh_9
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11msh_9
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_2_MSH.html b/interfaces/HL7.HL7_2_2_MSH.html index b2fc0b5..39ea07a 100644 --- a/interfaces/HL7.HL7_2_2_MSH.html +++ b/interfaces/HL7.HL7_2_2_MSH.html @@ -1,4 +1,4 @@ -HL7_2_2_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_2_MSH

    HL7 2.2 MSH Specification

    +HL7_2_2_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_2_MSH

    HL7 2.2 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_2_MSH {
            msh_10?: string;
        msh_11: "D" | "P" | "T";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? +
    interface HL7_2_2_MSH {
        msh_10?: string;
        msh_11: "D" | "P" | "T";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? msh_11 msh_9_1 msh_9_2 @@ -25,10 +25,10 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11

    msh_11: "D" | "P" | "T"

    Processing ID

    +

    msh_11

    msh_11: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11msh_9_1msh_9_2
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11msh_9_1msh_9_2
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_3_1_MSH.html b/interfaces/HL7.HL7_2_3_1_MSH.html index 5bd867e..e328db3 100644 --- a/interfaces/HL7.HL7_2_3_1_MSH.html +++ b/interfaces/HL7.HL7_2_3_1_MSH.html @@ -1,4 +1,4 @@ -HL7_2_3_1_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_3_1_MSH

    HL7 2.3.1 MSH Specification

    +HL7_2_3_1_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_3_1_MSH

    HL7 2.3.1 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_3_1_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? +
    interface HL7_2_3_1_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -26,12 +26,12 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_3_MSH.html b/interfaces/HL7.HL7_2_3_MSH.html index fd9ca7e..9939753 100644 --- a/interfaces/HL7.HL7_2_3_MSH.html +++ b/interfaces/HL7.HL7_2_3_MSH.html @@ -1,4 +1,4 @@ -HL7_2_3_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_3_MSH

    HL7 2.3 MSH Specification

    +HL7_2_3_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_3_MSH

    HL7 2.3 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_3_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? +
    interface HL7_2_3_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -26,12 +26,12 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_4_MSH.html b/interfaces/HL7.HL7_2_4_MSH.html index 651b978..f8d34f7 100644 --- a/interfaces/HL7.HL7_2_4_MSH.html +++ b/interfaces/HL7.HL7_2_4_MSH.html @@ -1,4 +1,4 @@ -HL7_2_4_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_4_MSH

    HL7 2.4 MSH Specification

    +HL7_2_4_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_4_MSH

    HL7 2.4 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_4_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_4_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -27,17 +27,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_5_1_MSH.html b/interfaces/HL7.HL7_2_5_1_MSH.html index 09459bc..d3fd8b9 100644 --- a/interfaces/HL7.HL7_2_5_1_MSH.html +++ b/interfaces/HL7.HL7_2_5_1_MSH.html @@ -1,4 +1,4 @@ -HL7_2_5_1_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_5_1_MSH

    HL7 2.5.1 MSH Specification

    +HL7_2_5_1_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_5_1_MSH

    HL7 2.5.1 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_5_1_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_5_1_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -27,17 +27,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_5_MSH.html b/interfaces/HL7.HL7_2_5_MSH.html index dab3819..9396e1c 100644 --- a/interfaces/HL7.HL7_2_5_MSH.html +++ b/interfaces/HL7.HL7_2_5_MSH.html @@ -1,4 +1,4 @@ -HL7_2_5_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_5_MSH

    HL7 2.5 MSH Specification

    +HL7_2_5_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_5_MSH

    HL7 2.5 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_5_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_5_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -27,17 +27,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_6_MSH.html b/interfaces/HL7.HL7_2_6_MSH.html index 5e99d63..29c3f3f 100644 --- a/interfaces/HL7.HL7_2_6_MSH.html +++ b/interfaces/HL7.HL7_2_6_MSH.html @@ -1,4 +1,4 @@ -HL7_2_6_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_6_MSH

    HL7 2.6 MSH Specification

    +HL7_2_6_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_6_MSH

    HL7 2.6 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_6_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_6_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -27,17 +27,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_7_1_MSH.html b/interfaces/HL7.HL7_2_7_1_MSH.html index de4b170..e618336 100644 --- a/interfaces/HL7.HL7_2_7_1_MSH.html +++ b/interfaces/HL7.HL7_2_7_1_MSH.html @@ -1,4 +1,4 @@ -HL7_2_7_1_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_7_1_MSH

    HL7 2.7.1 MSH Specification

    +HL7_2_7_1_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_7_1_MSH

    HL7 2.7.1 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_7_1_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_7_1_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -26,17 +26,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_7_MSH.html b/interfaces/HL7.HL7_2_7_MSH.html index e0e0618..1ef4a1c 100644 --- a/interfaces/HL7.HL7_2_7_MSH.html +++ b/interfaces/HL7.HL7_2_7_MSH.html @@ -1,4 +1,4 @@ -HL7_2_7_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_7_MSH

    HL7 2.7 MSH Specification

    +HL7_2_7_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_7_MSH

    HL7 2.7 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_7_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_7_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -26,17 +26,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_2_8_MSH.html b/interfaces/HL7.HL7_2_8_MSH.html index 837cff5..babe9d8 100644 --- a/interfaces/HL7.HL7_2_8_MSH.html +++ b/interfaces/HL7.HL7_2_8_MSH.html @@ -1,4 +1,4 @@ -HL7_2_8_MSH | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_2_8_MSH

    HL7 2.8 MSH Specification

    +HL7_2_8_MSH | Node HL7 Client - v2.3.1

    Interface HL7_2_8_MSH

    HL7 2.8 MSH Specification

    Description

    Only the required ones are listed below for typescript validation to pass.

    Since

    1.0.0

    Example

    To make it easier on having to fill this out each time, you may do this in your code:

    @@ -11,7 +11,7 @@

    Example

    so this way your code is much neater.

    -

    interface HL7_2_8_MSH {
            msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? +
    interface HL7_2_8_MSH {
        msh_10?: string;
        msh_11_1: "D" | "P" | "T";
        msh_11_2?:
            | ""
            | "T"
            | "A"
            | "I"
            | "R";
        msh_9_1: string;
        msh_9_2: string;
        msh_9_3?: string;
    }

    Properties

    msh_10? msh_11_1 msh_11_2? msh_9_1 @@ -26,17 +26,17 @@

    Default

    See

    randomString if this is set to nothing or not included.

    -

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    +

    msh_11_1

    msh_11_1: "D" | "P" | "T"

    Processing ID

    Since

    1.0.0

    -

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    +

    Optionalmsh_11_2

    msh_11_2?:
        | ""
        | "T"
        | "A"
        | "I"
        | "R"

    Processing Mode

    Since

    1.0.0

    -

    msh_9_1

    msh_9_1: string

    Message Code

    +

    msh_9_1

    msh_9_1: string

    Message Code

    Since

    1.0.0

    -

    msh_9_2

    msh_9_2: string

    Trigger Event

    +

    msh_9_2

    msh_9_2: string

    Trigger Event

    Since

    1.0.0

    -

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    +

    Optionalmsh_9_3

    msh_9_3?: string

    Message Structure

    Since

    2.2.0

    Default

    If not specified, it will be the combo of 9.1 and 9.2 with an underscore.
    -

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    msh_10msh_11_1msh_11_2msh_9_1msh_9_2msh_9_3
    \ No newline at end of file diff --git a/interfaces/HL7.HL7_SPEC.html b/interfaces/HL7.HL7_SPEC.html index 66e3d39..0de6255 100644 --- a/interfaces/HL7.HL7_SPEC.html +++ b/interfaces/HL7.HL7_SPEC.html @@ -1,9 +1,9 @@ -HL7_SPEC | Node HL7 Client - v2.3.1-beta.1

    Interface HL7_SPEC

    HL7 Base Interface

    +HL7_SPEC | Node HL7 Client - v2.3.1

    Interface HL7_SPEC

    HL7 Base Interface

    Since

    1.0.0

    -
    interface HL7_SPEC {
        buildMSH: ((mshHeader: MSH, massage: Message) => void);
        checkMSH: ((options: MSH) => boolean);
        name: string;
    }

    Implemented by

    Properties

    buildMSH +
    interface HL7_SPEC {
        buildMSH: ((mshHeader: MSH, massage: Message) => void);
        checkMSH: ((options: MSH) => boolean);
        name: string;
    }

    Implemented by

    Properties

    buildMSH checkMSH name

    Properties

    buildMSH

    buildMSH: ((mshHeader: MSH, massage: Message) => void)

    Build MSH

    -

    checkMSH

    checkMSH: ((options: MSH) => boolean)

    Check the MSH Header for this Specification

    -

    name

    name: string

    Name of the HL7 Spec

    -

    Settings

    Member Visibility

    On This Page

    buildMSHcheckMSHname
    \ No newline at end of file +

    checkMSH

    checkMSH: ((options: MSH) => boolean)

    Check the MSH Header for this Specification

    +

    name

    name: string

    Name of the HL7 Spec

    +

    Settings

    Member Visibility

    On This Page

    buildMSHcheckMSHname
    \ No newline at end of file diff --git a/modules.html b/modules.html index 36d8501..06530d6 100644 --- a/modules.html +++ b/modules.html @@ -1,3 +1,3 @@ -Node HL7 Client - v2.3.1-beta.1

    Node HL7 Client - v2.3.1-beta.1

    Index

    Namespaces

    CORE +Node HL7 Client - v2.3.1

    Node HL7 Client - v2.3.1

    Index

    Namespaces

    CORE HL7 -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/modules/CORE.html b/modules/CORE.html index dbfb0ad..6072122 100644 --- a/modules/CORE.html +++ b/modules/CORE.html @@ -1,4 +1,4 @@ -CORE | Node HL7 Client - v2.3.1-beta.1

    Namespace CORE

    References

    Client +CORE | Node HL7 Client - v2.3.1

    Namespace CORE

    References

    Client

    Enumerations

    Delimiters ReadyState

    Classes

    Batch @@ -34,4 +34,4 @@ randomString validIPv4 validIPv6 -

    References

    Client

    Renames and re-exports default

    Settings

    Member Visibility

    On This Page

    Client
    \ No newline at end of file +

    References

    Client

    Renames and re-exports default

    Settings

    Member Visibility

    On This Page

    Client
    \ No newline at end of file diff --git a/modules/HL7.html b/modules/HL7.html index 39daa85..688a72a 100644 --- a/modules/HL7.html +++ b/modules/HL7.html @@ -1,4 +1,4 @@ -HL7 | Node HL7 Client - v2.3.1-beta.1

    Namespace HL7

    Index

    Classes

    HL7_2_1 +HL7 | Node HL7 Client - v2.3.1

    Namespace HL7

    Index

    Classes

    HL7_2_1 HL7_2_2 HL7_2_3 HL7_2_3_1 @@ -23,4 +23,4 @@ HL7_2_8_MSH HL7_SPEC

    Type Aliases

    MSH -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/types/CORE.OutboundHandler.html b/types/CORE.OutboundHandler.html index f835740..5d48f3d 100644 --- a/types/CORE.OutboundHandler.html +++ b/types/CORE.OutboundHandler.html @@ -1,4 +1,4 @@ -OutboundHandler | Node HL7 Client - v2.3.1-beta.1

    Type Alias OutboundHandler

    OutboundHandler: ((res: InboundResponse) => Promise<void> | void)

    Outbound Handler

    +OutboundHandler | Node HL7 Client - v2.3.1

    Type Alias OutboundHandler

    OutboundHandler: ((res: InboundResponse) => Promise<void> | void)

    Outbound Handler

    Description

    Used to receive a response from the server

    Since

    1.0.0

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file diff --git a/types/HL7.MSH.html b/types/HL7.MSH.html index dd09c30..091c7a9 100644 --- a/types/HL7.MSH.html +++ b/types/HL7.MSH.html @@ -1,3 +1,3 @@ -MSH | Node HL7 Client - v2.3.1-beta.1

    Type Alias MSH

    MSH:
        | HL7_2_1_MSH
        | HL7_2_2_MSH
        | HL7_2_3_MSH
        | HL7_2_3_1_MSH
        | HL7_2_4_MSH
        | HL7_2_5_MSH
        | HL7_2_5_1_MSH
        | HL7_2_6_MSH
        | HL7_2_7_MSH
        | HL7_2_7_1_MSH
        | HL7_2_8_MSH

    MSH Unions

    +MSH | Node HL7 Client - v2.3.1

    Type Alias MSH

    MSH:
        | HL7_2_1_MSH
        | HL7_2_2_MSH
        | HL7_2_3_MSH
        | HL7_2_3_1_MSH
        | HL7_2_4_MSH
        | HL7_2_5_MSH
        | HL7_2_5_1_MSH
        | HL7_2_6_MSH
        | HL7_2_7_MSH
        | HL7_2_7_1_MSH
        | HL7_2_8_MSH

    MSH Unions

    Since

    1.0.0

    -

    Settings

    Member Visibility
    \ No newline at end of file +

    Settings

    Member Visibility
    \ No newline at end of file