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.
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(): void
End Batch
+
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 @@
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.
letmessage = newMessage({ messageHeader: { msh_9_1:"ADT", msh_9_2:"A01", msh_11_1:"P"// marked for production here in the example }asyncsendMessage (message: Message | Batch | FileBatch): void { })
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.
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(name): void
Create a file to be stored.
+
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(): void
End Batch
+
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.
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 @@
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.
This individual port connections which can override the main server connection properties.
Some properties from the server build could be defaulted if not specified here.
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 @@
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.
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.
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.
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.
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 @@
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.
Batch Class
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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
Index
Constructors
Hierarchy
Index
Constructors
Properties
Sincewrite
Constructors
constructor
Parameters
Optional
props: ClientBuilderOptionsPassing the options to build the batch.
Returns Batch
Since
1.0.0
-Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add
Add a Message to the Batch
+Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add
Add a Message to the Batch
Parameters
The Message to add into the batch.
Optional
index: numberUsed 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 Batch
+end
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
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Get BHS Segment at Path
+exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Get BHS Segment at Path
Parameters
Could be 'BHS.7' or 7, and it shall get the same result.
Returns HL7Node
Since
1.0.0
Example
-get First Segment
Get the First Segment
+get First Segment
Get the First Segment
Parameters
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
-is Empty
Returns boolean
messages
Get Messages within a submitted Batch
+is Empty
Returns boolean
messages
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
-set
Set Batch Segment at Path with a Value
+set
Set Batch Segment at Path with a Value
Parameters
Where you want to set in the segment
Optional
value: anyThe value. It Can be an Array, String, or Boolean. @@ -86,7 +86,7 @@
Example
batch.set('BHS.3').set(0).set('BHS.3.1', 'abc');
-start
Start Batch
+start
Start Batch
Parameters
Optional
style: "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
-to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Create File from a Batch
+to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Create File from a Batch
Parameters
File Name
Optional
newLine: booleanProvide a New Line
Optional
location: stringWhere to save the exported file
@@ -108,5 +108,5 @@Example
You can set an
-extension
parameter on Batch to set a custom extension if you don't want to be HL7.to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
-Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
+Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class Connection
Connection Class
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class Connection
Connection Class
Description
Create a connection customer that will listen to result send to the particular port.
Since
1.0.0
-Hierarchy
Implements
Index
Constructors
Hierarchy
Implements
Index
Constructors
Methods
SinceExample
-Methods
close
Close Client Listener Instance.
+Methods
close
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
-get Port
Get Port
+get Port
Get Port
Returns number
Description
Get the port that this connection will connect to.
Since
2.0.0
-send Message
Send a HL7 Message to the Listener
+send Message
Send a HL7 Message to the Listener
Parameters
The message we need to send to the port.
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
-start
Start the connection if not auto started.
+start
Start the connection if not auto started.
Returns Promise<void>
Since
2.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class EmptyNode
Empty Node
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class EmptyNode
Empty Node
Since
1.0.0
-Implements
Index
Constructors
Implements
Index
Constructors
Accessors
Constructors
constructor
Returns EmptyNode
Accessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
read
Parameters
Returns HL7Node
set
Parameters
Optional
_value: anyReturns HL7Node
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
Constructors
constructor
Returns EmptyNode
Accessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
read
Parameters
Returns HL7Node
set
Parameters
Optional
_value: anyReturns HL7Node
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class FileBatch
File Batch Class
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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
Index
Constructors
Hierarchy
Index
Constructors
Properties
Sincewrite
Constructors
constructor
Parameters
Optional
props: ClientBuilderFileOptionsPassing the options to build the file batch.
Returns FileBatch
Since
1.0.0
-Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add
AAdd a Message or a Batch to the File
+Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add
AAdd a Message or a Batch to the File
Parameters
The Message or Batch to add into the batch.
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
-create File
Create a file to be stored.
+create File
Create a file to be stored.
Parameters
Name of the file.
Returns void
Since
1.0.0
-end
End Batch
+end
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
Parameters
Returns boolean
file Name
Get File name
+exists
Parameters
Returns boolean
file Name
Get File name
Returns string
Description
Get File name going to be created.
Since
1.2.0
-for Each
Parameters
Parameters
Returns void
Returns void
get
Get FHS Segment at Path
+for Each
Parameters
Parameters
Returns void
Returns void
get
Get FHS Segment at Path
Parameters
Could be 'FHS.7' or 7, and it shall get the same result.
Returns HL7Node
Since
1.0.0
Example
-is Empty
Returns boolean
messages
Get Messages within a submitted File Batch
+is Empty
Returns boolean
messages
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
-set
Set Batch Segment at Path with a Value
+set
Set Batch Segment at Path with a Value
Parameters
Where you want to set in the segment
Optional
value: anyThe value. It Can be an Array, String, or Boolean. @@ -84,7 +84,7 @@
Example
batch.set('BHS.3').set(0).set('BHS.3.1', 'abc');
-start
Start Batch
+start
Start Batch
Returns void
Since
1.0.0
-to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
-Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
+Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7Error
Parent Cass of HL7 Error
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class HL7Error
Parent Cass of HL7 Error
Since
1.0.0
-Hierarchy (view full)
Index
Properties
Properties
code
Settings
On This Page
Hierarchy (view full)
Index
Properties
Properties
code
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7FatalError
Used to indicate a fatal failure of a connection.
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class HL7FatalError
Used to indicate a fatal failure of a connection.
Since
1.0.0
-Hierarchy (view full)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Constructors
constructor
Parameters
Returns HL7FatalError
Properties
code
Settings
On This Page
Constructors
constructor
Parameters
Returns HL7FatalError
Properties
code
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7ParserError
Used to indicate a fatal failure of a connection.
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class HL7ParserError
Used to indicate a fatal failure of a connection.
Since
1.0.0
-Hierarchy
Index
Constructors
Constructors
constructor
Parameters
Optional
message: stringReturns HL7ParserError
Settings
On This Page
Hierarchy
Index
Constructors
Constructors
constructor
Parameters
Optional
message: stringReturns HL7ParserError
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class InboundResponse
Inbound Request
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class InboundResponse
Inbound Request
Since
1.0.0
-Index
Constructors
Index
Constructors
Methods
Constructors
constructor
Process the Inbound Response from the Server
Parameters
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
get Message
' +
Methods
get Message
' Get Message
Returns Message
Message
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class Message
Message Class
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class Message
Message Class
Since
1.0.0
-Hierarchy
Index
Constructors
Hierarchy
Index
Constructors
Properties
Example
-Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add Segment
Add a new segment to a message.
+Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
add Segment
Add a new segment to a message.
Parameters
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
-Protected
createProtected
Create a new child of a message which is a segment.
+Protected
createProtected
Create a new child of a message which is a segment.
Parameters
Segment string. Must be 3 characters long.
Not used to create a segment.
Returns HL7Node
Since
See
Segment
-exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Get HL7 Segment at Path
+exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Get HL7 Segment at Path
Parameters
Returns HL7Node
Since
1.0.0
-is Empty
Returns boolean
Protected
pathProtected
Path Core
+is Empty
Returns boolean
Protected
pathProtected
Path Core
Returns string[]
Since
1.0.0
-read
Read a path of a message.
+read
Read a path of a message.
Parameters
Returns HL7Node
Description
Could return SegmentList
Since
1.0.0
-set
Set HL7 Segment at Path with a Value
+set
Set HL7 Segment at Path with a Value
Parameters
Optional
value: anyReturns HL7Node
Since
1.0.0
-to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Create File from a Message
+to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Create File from a Message
Parameters
File Name
Optional
newLine: booleanProvide a New Line
Optional
location: stringWhere to save the exported file
@@ -65,7 +65,7 @@Example
You can set an
-extension
parameter on Batch to set a custom extension if you don't want to be HL7.to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
-Returns string
write
Parameters
Returns HL7Node
Protected
writeProtected
Write Core of the Message
+to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
+Returns string
write
Parameters
Returns HL7Node
Protected
writeProtected
Write Core of the Message
Parameters
Returns HL7Node
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class NodeBase
Node Base
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class NodeBase
Node Base
Since
1.0.0
-Hierarchy (view full)
Implements
Index
Constructors
Hierarchy (view full)
Implements
Index
Constructors
Properties
Constructors
constructor
Parameters
Returns NodeBase
Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
read
Parameters
Returns HL7Node
set
Parameters
Optional
value: anyReturns HL7Node
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
-Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
Constructors
constructor
Parameters
Returns NodeBase
Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
read
Parameters
Returns HL7Node
set
Parameters
Optional
value: anyReturns HL7Node
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
+Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class Segment
Segment
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class Segment
Segment
Since
1.0.0
-Hierarchy (view full)
Index
Properties
Hierarchy (view full)
Index
Properties
Accessors
Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
-Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
Properties
_name
Protected
parentStatic
emptyAccessors
length
Returns number
name
Returns string
path
Returns string[]
Methods
exists
Parameters
Returns boolean
for Each
Parameters
Parameters
Returns void
Returns void
get
Parameters
Returns HL7Node
is Empty
Returns boolean
to Array
Returns HL7Node[]
to Boolean
Returns boolean
to Date
Returns Date
to File
Parameters
Optional
_newLine: booleanOptional
_location: stringReturns void
to Float
Returns number
to Integer
Returns number
to Raw
Returns string
to String
Returns a string representation of an object.
+Returns string
write
Parameters
Returns HL7Node
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class default
Client Class
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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
Index
Constructors
Hierarchy
Index
Constructors
Methods
SinceExample
-Methods
close All
Close all connections
+Methods
close All
Close all connections
Returns void
Since
2.0.0
-create Connection
Connect to a listener to a specified port.
+create Connection
Connect to a listener to a specified port.
Parameters
This individual port connections which can override the main server connection properties. Some properties from the server build could be defaulted if not specified here.
The function that the client will process if and when they get a response from the server. @@ -26,11 +26,11 @@
Example
Review the InboundResponse on the properties returned.
-get Host
Get the host that we will connect to. +
get Host
Get the host that we will connect to. The port might be different from each different "connection"
Returns string
Since
1.1.0
-total Ack
Total ack in this object lifetime.
+total Ack
Total ack in this object lifetime.
Returns number
Since
2.0.0
-total Sent
Total sent messages in this object lifetime.
+total Sent
Total sent messages in this object lifetime.
Returns number
Since
2.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_1
Hl7 Specification Version 2.1
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_1
Properties
name
Name
+Constructors
constructor
Returns HL7_2_1
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.1
+checkMSH
Check MSH Header Properties for HL7 2.1
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_2
Hl7 Specification Version 2.2
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_2
Properties
name
Name
+Constructors
constructor
Returns HL7_2_2
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.2
+checkMSH
Check MSH Header Properties for HL7 2.2
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_3
Hl7 Specification Version 2.3
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_3
Properties
name
Name
+Constructors
constructor
Returns HL7_2_3
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.3
+checkMSH
Check MSH Header Properties for HL7 2.3
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_3_1
Hl7 Specification Version 2.3.1
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_3_1
Properties
name
Name
+Constructors
constructor
Returns HL7_2_3_1
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.3.1
+checkMSH
Check MSH Header Properties for HL7 2.3.1
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_4
Hl7 Specification Version 2.4
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_4
Properties
name
Name
+Constructors
constructor
Returns HL7_2_4
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.4
+checkMSH
Check MSH Header Properties for HL7 2.4
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_5
Hl7 Specification Version 2.5
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_5
Properties
name
Name
+Constructors
constructor
Returns HL7_2_5
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.5
+checkMSH
Check MSH Header Properties for HL7 2.5
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_5_1
Hl7 Specification Version 2.5.1
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_5_1
Properties
name
Name
+Constructors
constructor
Returns HL7_2_5_1
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.5.1
+checkMSH
Check MSH Header Properties for HL7 2.5.1
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_6
Hl7 Specification Version 2.6
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_6
Properties
name
Name
+Constructors
constructor
Returns HL7_2_6
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.6
+checkMSH
Check MSH Header Properties for HL7 2.6
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_7
Hl7 Specification Version 2.7
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_7
Properties
name
Name
+Constructors
constructor
Returns HL7_2_7
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.7
+checkMSH
Check MSH Header Properties for HL7 2.7
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_7_1
Hl7 Specification Version 2.7.1
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_7_1
Properties
name
Name
+Constructors
constructor
Returns HL7_2_7_1
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.7
+checkMSH
Check MSH Header Properties for HL7 2.7
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_2_8
Hl7 Specification Version 2.8
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class 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)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_2_8
Properties
name
Name
+Constructors
constructor
Returns HL7_2_8
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build HL7 MSH Segment
+Methods
buildMSH
Build HL7 MSH Segment
Parameters
Returns void
Since
1.0.0
-checkMSH
Check MSH Header Properties for HL7 2.7
+checkMSH
Check MSH Header Properties for HL7 2.7
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Class HL7_SPEC_BASE
Base Class of an HL7 Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Class HL7_SPEC_BASE
Base Class of an HL7 Specification
Since
1.0.0
-Hierarchy (view full)
Implements
Index
Constructors
Hierarchy (view full)
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Returns HL7_SPEC_BASE
Properties
name
Name
Since
1.0.0
-Methods
buildMSH
Build MSH Header
+Methods
buildMSH
Build MSH Header
Parameters
Returns void
void
Description
Add the required fields based on the spec chosen.
Since
1.0.0
-checkMSH
Check MSH Header Properties
+checkMSH
Check MSH Header Properties
Parameters
Returns boolean
boolean
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Enumeration Delimiters
Type of Segments Values
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Enumeration 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
-Index
Enumeration Members
Index
Enumeration Members
Enumeration Members
Component
Usually within each Field, seperated by ^
-Escape
The escape string used within the code.
-Field
The field of each segment. Usually separated with a |
-Repetition
Usually within each Component, seperated by &
-Segment
Usually each line of the overall HL7 Message.
-Sub Component
Usually within each Field, seperated by ~
-Settings
On This Page
Escape
The escape string used within the code.
+Field
The field of each segment. Usually separated with a |
+Repetition
Usually within each Component, seperated by &
+Segment
Usually each line of the overall HL7 Message.
+Sub Component
Usually within each Field, seperated by ~
+Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Enumeration ReadyState
State of the Connected to the Server
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Enumeration 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
-Index
Enumeration Members
Index
Enumeration Members
Enumeration Members
CLOSED
The client connection is closed.
-CLOSING
The client is closing the connection by force or by timeout
-CONNECTED
The client is connected to the server.
-CONNECTING
The client is trying to connect to the server.
-OPEN
The client is open, but not yet trying to connect to the server.
-Settings
On This Page
CLOSING
The client is closing the connection by force or by timeout
+CONNECTED
The client is connected to the server.
+CONNECTING
The client is trying to connect to the server.
+OPEN
The client is open, but not yet trying to connect to the server.
+Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function assertNumber
Assert Number on a Property
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function assertNumber
Assert Number on a Property
Since
1.0.0
Parameters
Property Object
Property Name
Min Number
Optional
max: numberMax Number
-Returns void
Settings
Returns void
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function createHL7Date
Create a valid HL7 Date.
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function createHL7Date
Create a valid HL7 Date.
Description
Custom for this package and based of HL7 specification.
Since
1.0.0
-Parameters
Optional
length: stringReturns string
Settings
Parameters
Optional
length: stringReturns string
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function decodeHexString
Decode Hex String
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function decodeHexString
Decode Hex String
Since
1.0.0
-Parameters
Returns string
Settings
Parameters
Returns string
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function escapeForRegExp
Escape for RegEx Expressing
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function escapeForRegExp
Escape for RegEx Expressing
Since
1.0.0
-Parameters
Returns string
Settings
Parameters
Returns string
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function expBackoff
Calculate exponential backoff/retry delay. +
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function expBackoff
Calculate exponential backoff/retry delay. Where attempts >= 1, exp > 1
Example
Since
1.0.0
-Parameters
Returns number
Settings
Parameters
Returns number
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function isBatch
Check to see if the message starts with Batch (BHS) header segment.
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function isBatch
Check to see if the message starts with Batch (BHS) header segment.
Since
1.0.0
-Parameters
Returns boolean
Settings
Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function isFile
Check to see if the message starts with a File Batch (FHS) header segment.
-Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function isFile
Check to see if the message starts with a File Batch (FHS) header segment.
+Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function isHL7Number
Is Number
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function isHL7Number
Is Number
Description
Custom for this package.
Since
1.0.0
-Parameters
Returns boolean
Settings
Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function isHL7String
Is String
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function isHL7String
Is String
Description
Custom for this package.
Since
1.0.0
-Parameters
Returns boolean
Settings
Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function padHL7Date
HL7 Padding for Date
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function padHL7Date
HL7 Padding for Date
Since
1.0.0
-Parameters
Returns string
Settings
Parameters
Returns string
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function randomString
Generate a random string
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function randomString
Generate a random string
Since
1.0.0
-Parameters
Returns string
Settings
Parameters
Returns string
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function validIPv4
Valid IPv4 Checker
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function validIPv4
Valid IPv4 Checker
Since
1.0.0
-Parameters
Returns boolean
Settings
Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Function validIPv6
Valid IPv6 Checker
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Function validIPv6
Valid IPv6 Checker
Since
1.0.0
-Parameters
Returns boolean
Settings
Parameters
Returns boolean
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Node HL7 Client - v2.3.1-beta.1
Class Hierarchy
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Node HL7 Client - v2.3.1
Class Hierarchy
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Node HL7 Client - v2.3.1-beta.1
Node HL7 Client
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface ClientBuilderFileOptions
Client Builder Options
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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
-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)
Index
Properties
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)
Index
Properties
SinceDefault
-Optional
extensionExtension of the file when it gets created.
+Optional
extensionExtension of the file when it gets created.
Since
1.0.0
Default
-Optional
fileThe file as a buffer passed onto the constructor
+Optional
fileThe file as a buffer passed onto the constructor
Since
1.0.0
-Optional
fullIf you are providing the full file path, please set it here.
+Optional
fullIf you are providing the full file path, please set it here.
Since
1.0.0
-Optional
locationLocation where the file will be saved. +
Optional
locationLocation 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
-Optional
newAt the end of each line, add this as the new line character.
+Optional
newAt the end of each line, add this as the new line character.
Since
1.0.0
Default
-Optional
parsingParsing a message?
+Optional
parsingParsing a message?
Since
1.0.0
Default
-Optional
separatorThe character used to separate different components.
+Optional
separatorThe character used to separate different components.
Since
1.0.0
Default
-Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
+Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
Since
1.0.0
Default
-Optional
separatorThe character used for separating fields.
+Optional
separatorThe character used for separating fields.
Since
1.0.0
Default
-Optional
separatorThe character used for repetition field/values pairs.
+Optional
separatorThe character used for repetition field/values pairs.
Since
1.0.0
Default
-Optional
separatorThe character used to have subcomponents seperated.
+Optional
separatorThe character used to have subcomponents seperated.
Since
1.0.0
Default
-Optional
specificationThe HL7 spec we are going to be creating. +
Optional
specificationThe HL7 spec we are going to be creating. This will be formatted into the MSH header by default.
Since
1.0.0
Default
-Optional
textThe HL7 string that we are going to parse.
+Optional
textThe HL7 string that we are going to parse.
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface ClientBuilderMessageOptions
Client Builder Options
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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
-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)
Index
Properties
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)
Index
Properties
SinceDefault
-Optional
messageMSH Header Options
+Optional
messageMSH Header Options
Since
1.0.0
-Optional
newAt the end of each line, add this as the new line character.
+Optional
newAt the end of each line, add this as the new line character.
Since
1.0.0
Default
-Optional
parsingParsing a message?
+Optional
parsingParsing a message?
Since
1.0.0
Default
-Optional
separatorThe character used to separate different components.
+Optional
separatorThe character used to separate different components.
Since
1.0.0
Default
-Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
+Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
Since
1.0.0
Default
-Optional
separatorThe character used for separating fields.
+Optional
separatorThe character used for separating fields.
Since
1.0.0
Default
-Optional
separatorThe character used for repetition field/values pairs.
+Optional
separatorThe character used for repetition field/values pairs.
Since
1.0.0
Default
-Optional
separatorThe character used to have subcomponents seperated.
+Optional
separatorThe character used to have subcomponents seperated.
Since
1.0.0
Default
-Optional
specificationThe HL7 spec we are going to be creating. +
Optional
specificationThe HL7 spec we are going to be creating. This will be formatted into the MSH header by default.
Since
1.0.0
Default
-Optional
textThe HL7 string that we are going to parse.
+Optional
textThe HL7 string that we are going to parse.
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface ClientBuilderOptions
Client Builder Options
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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
-date?: string;
newLine?: string;
parsing?: boolean;
separatorComponent?: string;
separatorEscape?: string;
separatorField?: string;
separatorRepetition?: string;
separatorSubComponent?: string;
specification?: any;
text?: string;
}
Hierarchy (view full)
Index
Properties
date?: string;
newLine?: string;
parsing?: boolean;
separatorComponent?: string;
separatorEscape?: string;
separatorField?: string;
separatorRepetition?: string;
separatorSubComponent?: string;
specification?: any;
text?: string;
}
Hierarchy (view full)
Index
Properties
SinceDefault
-Optional
newAt the end of each line, add this as the new line character.
+Optional
newAt the end of each line, add this as the new line character.
Since
1.0.0
Default
-Optional
parsingParsing a message?
+Optional
parsingParsing a message?
Since
1.0.0
Default
-Optional
separatorThe character used to separate different components.
+Optional
separatorThe character used to separate different components.
Since
1.0.0
Default
-Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
+Optional
separatorThe character used to escape characters that need it in order for the computer to interpret the string correctly.
Since
1.0.0
Default
-Optional
separatorThe character used for separating fields.
+Optional
separatorThe character used for separating fields.
Since
1.0.0
Default
-Optional
separatorThe character used for repetition field/values pairs.
+Optional
separatorThe character used for repetition field/values pairs.
Since
1.0.0
Default
-Optional
separatorThe character used to have subcomponents seperated.
+Optional
separatorThe character used to have subcomponents seperated.
Since
1.0.0
Default
-Optional
specificationThe HL7 spec we are going to be creating. +
Optional
specificationThe HL7 spec we are going to be creating. This will be formatted into the MSH header by default.
Since
1.0.0
Default
-Optional
textThe HL7 string that we are going to parse.
+Optional
textThe HL7 string that we are going to parse.
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface 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)
Index
Properties
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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)
Index
Properties
Default
-Optional
connectionHow long a connection attempt checked before ending the socket and attempting again. +
Optional
connectionHow 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
-Optional
encodingEncoding of the messages we expect from the HL7 message.
+Optional
encodingEncoding of the messages we expect from the HL7 message.
Default
-Optional
hostHost - You can do a FQDN or the IPv(4|6) address.
-Optional
ipv4IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.
+Optional
hostHost - You can do a FQDN or the IPv(4|6) address.
+Optional
ipv4IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.
Default
-Optional
ipv6IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.
+Optional
ipv6IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.
Default
-Optional
maxMax attempts +
Optional
maxMax 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
-Optional
maxIf we are trying to establish an initial connection to the server, let's end it after this many attempts. +
Optional
maxIf 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
-Optional
maxMax Connections this connection makes. +
Optional
maxMax Connections this connection makes. Has to be greater than 1.
Default
-Optional
maxThe number of times a connection timeout occurs until it stops attempting and just stops.
+Optional
maxThe number of times a connection timeout occurs until it stops attempting and just stops.
Since
2.1.0
Default
-port
The port we should connect to on the server.
-Optional
retryMax delay, in milliseconds, for exponential-backoff when reconnecting
+port
The port we should connect to on the server.
+Optional
retryMax delay, in milliseconds, for exponential-backoff when reconnecting
Default
-Optional
retryStep size, in milliseconds, for exponential-backoff when reconnecting
+Optional
retryStep size, in milliseconds, for exponential-backoff when reconnecting
Default
-Optional
socketAdditional options when creating the TCP socket with net.connect().
-Optional
tlsEnable TLS, or set TLS specific options like overriding the CA for +
Optional
socketAdditional options when creating the TCP socket with net.connect().
+Optional
tlsEnable TLS, or set TLS specific options like overriding the CA for self-signed certificates.
-Optional
waitWait for ACK before sending a new message. +
Optional
waitWait 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
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface 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)
Index
Properties
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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)
Index
Properties
Default
-Optional
hostHost - You can do a FQDN or the IPv(4|6) address.
-Optional
ipv4IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.
+Optional
hostHost - You can do a FQDN or the IPv(4|6) address.
+Optional
ipv4IPv4 - If this is set to true, only IPv4 address will be used and also validated upon installation from the hostname property.
Default
-Optional
ipv6IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.
+Optional
ipv6IPv6 - If this is set to true, only IPv6 address will be used and also validated upon installation from the hostname property.
Default
-Optional
maxMax attempts +
Optional
maxMax 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
-Optional
maxIf we are trying to establish an initial connection to the server, let's end it after this many attempts. +
Optional
maxIf 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
-Optional
maxThe number of times a connection timeout occurs until it stops attempting and just stops.
+Optional
maxThe number of times a connection timeout occurs until it stops attempting and just stops.
Since
2.1.0
Default
-Optional
retryMax delay, in milliseconds, for exponential-backoff when reconnecting
+Optional
retryMax delay, in milliseconds, for exponential-backoff when reconnecting
Default
-Optional
retryStep size, in milliseconds, for exponential-backoff when reconnecting
+Optional
retryStep size, in milliseconds, for exponential-backoff when reconnecting
Default
-Optional
socketAdditional options when creating the TCP socket with net.connect().
-Optional
tlsEnable TLS, or set TLS specific options like overriding the CA for +
Optional
socketAdditional options when creating the TCP socket with net.connect().
+Optional
tlsEnable TLS, or set TLS specific options like overriding the CA for self-signed certificates.
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7Node
Node Base
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface HL7Node
Node Base
Since
1.0.0
-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
Index
Properties
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
Index
Properties
Properties
exists
for Each
get
is Empty
length
name
path
read
set
to Array
to Boolean
to Date
to File
to Float
to Integer
to Raw
to String
write
Settings
On This Page
Properties
exists
for Each
get
is Empty
length
name
path
read
set
to Array
to Boolean
to Date
to File
to Float
to Integer
to Raw
to String
write
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface 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
Implemented by
Index
Methods
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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
Implemented by
Index
Methods
Methods
on
The connection has been closed manually. You have to start the connection again.
-Parameters
Returns void
Returns this
The connection is made.
-Parameters
Returns void
Returns this
The connection is being (re)established or attempting to re-connect.
-Parameters
Returns void
Returns this
The handle is open to do a manual start to connect.
-Parameters
Returns void
Returns this
The total acknowledged for this connection.
-Parameters
Parameters
Returns void
Returns this
The connection has an error.
-Parameters
Parameters
Returns void
Returns this
The total sent for this connection.
-Parameters
Parameters
Returns void
Returns this
The connection has timeout. Review "client.error" event for the reason.
-Parameters
Returns void
Returns this
Settings
On This Page
Parameters
Returns void
Returns this
The connection is made.
+Parameters
Returns void
Returns this
The connection is being (re)established or attempting to re-connect.
+Parameters
Returns void
Returns this
The handle is open to do a manual start to connect.
+Parameters
Returns void
Returns this
The total acknowledged for this connection.
+Parameters
Parameters
Returns void
Returns this
The connection has an error.
+Parameters
Parameters
Returns void
Returns this
The total sent for this connection.
+Parameters
Parameters
Returns void
Returns this
The connection has timeout. Review "client.error" event for the reason.
+Parameters
Returns void
Returns this
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_1_MSH
HL7 2.1 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-msh_10?: string;
msh_11: "D" | "P" | "T";
msh_9: string;
}
Index
Properties
msh_10?: string;
msh_11: "D" | "P" | "T";
msh_9: string;
}
Index
Properties
Properties
Optional
msh_Message Control ID
@@ -24,8 +24,8 @@Default
See
randomString if this is set to nothing or not included.
-msh_ 11
Processing ID
+msh_ 11
Processing ID
Since
1.0.0
-msh_ 9
Message Code
+msh_ 9
Message Code
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_2_MSH
HL7 2.2 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-msh_10?: string;
msh_11: "D" | "P" | "T";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
msh_10?: string;
msh_11: "D" | "P" | "T";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11
Processing ID
+msh_ 11
Processing ID
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_3_1_MSH
HL7 2.3.1 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-msh_10?: string;
msh_11_1: "D" | "P" | "T";
msh_11_2?:
| ""
| "T"
| "A"
| "I"
| "R";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
msh_10?: string;
msh_11_1: "D" | "P" | "T";
msh_11_2?:
| ""
| "T"
| "A"
| "I"
| "R";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_3_MSH
HL7 2.3 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-msh_10?: string;
msh_11_1: "D" | "P" | "T";
msh_11_2?:
| ""
| "T"
| "A"
| "I"
| "R";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
msh_10?: string;
msh_11_1: "D" | "P" | "T";
msh_11_2?:
| ""
| "T"
| "A"
| "I"
| "R";
msh_9_1: string;
msh_9_2: string;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_4_MSH
HL7 2.4 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_5_1_MSH
HL7 2.5.1 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_5_MSH
HL7 2.5 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_6_MSH
HL7 2.6 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_7_1_MSH
HL7 2.7.1 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_7_MSH
HL7 2.7 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_2_8_MSH
HL7 2.8 MSH Specification
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface 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.
-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;
}
Index
Properties
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;
}
Index
Properties
Default
See
randomString if this is set to nothing or not included.
-msh_ 11_ 1
Processing ID
+msh_ 11_ 1
Processing ID
Since
1.0.0
-Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
+Optional
msh_| ""
| "T"
| "A"
| "I"
| "R"
Processing Mode
Since
1.0.0
-msh_ 9_ 1
Message Code
+msh_ 9_ 1
Message Code
Since
1.0.0
-msh_ 9_ 2
Trigger Event
+msh_ 9_ 2
Trigger Event
Since
1.0.0
-Optional
msh_Message Structure
+Optional
msh_Message Structure
Since
2.2.0
Default
-Settings
On This Page
Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Interface HL7_SPEC
HL7 Base Interface
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Interface HL7_SPEC
HL7 Base Interface
Since
1.0.0
-buildMSH: ((mshHeader: MSH, massage: Message) => void);
checkMSH: ((options: MSH) => boolean);
name: string;
}
Implemented by
Index
Properties
buildMSH: ((mshHeader: MSH, massage: Message) => void);
checkMSH: ((options: MSH) => boolean);
name: string;
}
Implemented by
Index
Properties
Properties
buildMSH
Build MSH
-checkMSH
Check the MSH Header for this Specification
-name
Name of the HL7 Spec
-Settings
On This Page
checkMSH
Check the MSH Header for this Specification
+name
Name of the HL7 Spec
+Settings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Node HL7 Client - v2.3.1-beta.1
Index
Namespaces
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Node HL7 Client - v2.3.1
Index
Namespaces
Settings
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Namespace CORE
Index
References
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Namespace CORE
Index
References
Enumerations
Classes
References
Client
Renames and re-exports defaultSettings
On This Page
References
Client
Renames and re-exports defaultSettings
On This Page
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Namespace HL7
Index
Classes
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Namespace HL7
Index
Classes
Type Aliases
Settings
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Type Alias OutboundHandler
Outbound Handler
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Type Alias OutboundHandler
Outbound Handler
Description
Used to receive a response from the server
Since
1.0.0
-Settings
Settings
- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1-beta.1Type Alias 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
+- Preparing search index...
- The search index is not available
Node HL7 Client - v2.3.1Type Alias 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
Settings