HL7PlusController Object

Class Name:

HL7PlusController

HL7+ Category:

Unrestricted

Description:

The parent object for all of the HL7+ restricted object classes.

 

HL7PlusController.IsRunnable Property

 

Property Name

Data Type

Description

IsRunnable

Boolean

Read OnlyThis property is the beating heart of the HL7+ Components. This property MUST be True or you cannot use any of the Restricted HL7+ Component object classes, or any of the Restricted Methods in the Partially Restricted object classes. When this property is referenced the HL7PlusController object will query the HL7+ Client Windows Service which will reply (if it's running) with the current status of your HL7+ Installation. See Troubleshooting Problems for more information about why IsRunnable may be returning False and how to fix.

 

 

Other Public Properties

Property Name

Data Type

Description

ExampleHL7MessageString

String

Read OnlyAn embedded example HL7 message string

ExampleHL7MessageAltString

String

Read OnlyAn embedded example HL7 message string which uses Non-Ansi Encoding Characters

Expired

Boolean

Read OnlyWill be True if ExpiresOn is > the current date / time.

NOTE: IF .IsRunnable is False Expired will always be True.

ExpiresOn

Date

Read OnlyThe expiration date of the HL7+ Installation (If a DEMO installation the DEMO expiry, else the HL7+ Subscription expiry date).

NOTE: IF .IsRunnable is False this property will always return a PAST date. The property is not set correctly unless .IsRunnable is True.

HL7Now

String

Read OnlyReturns a HL7 formatted date-time string for the current system date/time down to the second with time-zone offset

RegistrationErrorMessage

String

Read OnlyIF .IsRunnable is False this property will contain an error message string, else it will contain an empty string ("").

 

Note: When a new HL7PlusController object is created these values are set to the ANSI default values defined in the HL7PlusUtilities object.

 

Property Name

Data Type

Description

BOM

String

The HL7 BOM (Beginning of Message) character (Default is Hex 0B)

EOM

String

The HL7 EOM (End of Message) character (Default is Hex 1C-0D)

SegmentDelimiter

String

The HL7 SOM (Segment Delimiter) character (Default is Hex 0D (Carriage Return) )

FieldDelimiter

String

The HL7 Field Delimiter (Default [ | ] )

ComponentDelimiter

String

The HL7 Component Delimiter (Default [ ^ ] )

RepeatDelimiter

String

The HL7 Repeat Delimiter (Default [ ~ ] )

EscapeDelimiter

String

The HL7 Escape Delimiter (Default [ \ ] ) *See Escape Your Data

SubComponentDelimiter

String

The HL7 SubComponent Delimiter (Default [ & ] )

 

 

 

HL7PlusUtiities Properties Public Methods

 

Method:

MakeHL7ControlID()

Paramters:

None

Return Value:

String

Description:

Creates a HL7 compliant unique control ID for MSH field 10.1

Programming Note: The returned value consists of a DateTime stamp down to the millisecond + a 5 digit rolling sequential number

 

Method:

NewHL7PlusDNSLookUp()

Paramters:

None

Return Value:

HL7PlusDNSLookUp object

Description:

Will return Nothing if IsRunnable is False.

 

Method:

NewHL7PlusFileAnalyzer()

Paramters:

None

Return Value:

HL7PlusFileAnalyzer object

Description:

Will return Nothing if IsRunnable is False.

 

Method:

NewHL7PlusFileInfo() + 1 overload

NewHL7PlusFileInfo(strFileName)

Paramters:

1: strFileName (String) - The full path / file name

Return Value:

HL7PlusFileInfo object - NOTE: this object is Partially Restricted.

Description:

Since the object is Partially Restricted the object will be created whether IsRunnable is True or not.

 

Method:

NewHL7PlusFileWatcher(strFileName)

Paramters:

1: strFileName (String) - The full path / file name

Return Value:

HL7PlusFileWatcher object - NOTE: this object is Unrestricted.

Description:

Since the object is Unrestricted the object will be created whether IsRunnable is True or not.

 

Method:

NewHL7PlusFolderAnalyzer(strFolderPath)

Paramters:

1: strFolderPath (String) - The full path

Return Value:

HL7PlusFolderAnalyzer object - NOTE: this object is Restricted.

Description:

Since the object is Restricted the object will be created ONLY if IsRunnable is True.

 

Method:

NewHL7PlusFolderInfo() + 1 overload

NewHL7PlusFolderInfo(strFolderPath)

Paramters:

1: strFolderPath (String) - The full path

Return Value:

HL7PlusFolderInfo object - NOTE: this object is Partially Restricted.

Description:

Since the object is Partially Restricted the object will be created whether IsRunnable is True or not.

 

Method:

NewHL7PlusInterWeb() + 1 overload

NewHL7PlusInterWeb(strWebURL, Optional intTimeOut = 15, Optional obProxy = Nothing)

Paramters:

1: strWebURL (String) - The internet web URL string

2: intTimeOut (Integer) OPTIONAL - The action timeout in seconds (default = 15)

3: obProxy (System.Net.WebProxy) OPTIONAL - A webproxy object (default = Nothing)

Return Value:

HL7PlusInterWeb object - NOTE: this object is Restricted.

Description:

Since the object is Restricted the object will be created ONLY if IsRunnable is True.

 

Method:

NewHL7PlusLogFile()

Paramters:

None

Return Value:

HL7PlusLogFile object - NOTE: this object is Partially Restricted.

Description:

Since the object is Partially Restricted the object will be created whether IsRunnable is True or not.

 

Method:

NewHL7PlusMessage() + 2 overloads

NewHL7PlusMessage(obMSHInfo)

NewHL7PlusMessage(strHL7Message)

Paramters:

1: obMSHInfo (HL7PlusMSHInfo) - A populated HL7PlusMSHInfo object

1: strHL7Message (String) - A full or partially populated HL7 message string

Return Value:

HL7PlusMessage object - NOTE: this object is Restricted.

Description:

Since the object is Restricted the object will be created ONLY if IsRunnable is True.

 

Method:

NewHL7PlusServiceController(strServiceName)

Paramters:

1: strServiceName (String) - The NAME of the MS Windows Service

Return Value:

HL7PlusServiceController object - NOTE: this object is Restricted

Description:

Since the object is Restricted the object will be created ONLY if IsRunnable is True with ONE exception see the HL7PlusServiceController object for more information.

 

Method:

NewHL7PlusStringAnalyzer() + 1 overload

NewHL7PlusStringAnalyzer(StringOfHL7Messages)

Paramters:

1: StringOfHL7Messages (String) - A String value which can contain multiple fully formed HL7 messages.

Return Value:

HL7PlusStringAnalyzer object - NOTE: this object is Restricted.

Description:

Work with Strings which contain multiple HL7 messages. Since the object is Restricted the object will be created ONLY if IsRunnable is True.

 

Method:

NewHL7PlusUtilities()

Paramters:

None

Return Value:

HL7PlusUtilities object - NOTE: this object is Unrestricted.

Description:

Since the object is Unrestricted the object will be created whether IsRunnable is True or not.

 

Method:

NewXMLPlusDocument()

Paramters:

None

Return Value:

XMLPlus object - NOTE: this object is Unrestricted.

Description:

Since the object is Unrestricted the object will be created whether IsRunnable is True or not.

 

 

 

How it's usedExceptions and Error Handling

 

This object class uses our standard HL7PlusException Class interface for error handling wherever possible.

 

See the HL7PlusException Implementation Reference

 

 

Creating a HL7PlusMessage ObjectObject Creation

 

*All example code is in Visual Basic.Net

 

'---Declare at the Class or Global level

Private MyController As New HL7PlusController

 

  Friend Function MyClassCode() As Boolean

      Try

          With MyController

              If Not .IsRunnable Then

                  '--Everyone out of the pool until this is fixed

                  MessageBox.Show(.RegistrationErrorMessage, "Error")

                  Return False

              End If

          End With

          '.....Code....

          '.....Code....

          '.....Code....

          '.....Code....

          Return True

      Catch ex As Exception

          MessageBox.Show(ex.Message, "Error")

          Return False

      End Try

  End Function

 

Example Code (VB.Net)Example Code 1. A very simple test.

 

A simple test. Can you use the HL7+ Components?

*All example code is in Visual Basic.Net

While the test code below is fine, it's not really ideal. See Example Code 2 for a better way.

 

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

      Try

          Dim o As New HL7PlusController

          Dim sMsg As String = ""

          With o

              If Not .IsRunnable Then

                   sMsg = "Not runnable." & Environment.NewLine & Environment.NewLine &

                      "Error Message=" & o.RegistrationErrorMessage

                  MessageBox.Show(sMsg)

                  Return

              End If

               sMsg = "Yes the components are runnable. Now we can move forward to test some other objects."

               sMsg &= Environment.NewLine & Environment.NewLine & "Installation Name = " & o.InstallationName & Environment.NewLine &

                  "Expires: " & o.ExpiresOn.ToShortDateString

              MessageBox.Show(sMsg, "Success")

          End With

      Catch ex As Exception

          MessageBox.Show(ex.Message)

      End Try

End Sub

 

 

Example Code (VB.Net)Example Code 2. A better simple test.

 

A simple test (improved). Can you use the HL7+ Components?

*All example code is in Visual Basic.Net

A better way is to create your HL7PlusController object once at the class level and then use it throughout your class methods, etc as needed

 

Imports HL7PlusMC451

Public Class Form1

  Private MyController As New HL7PlusController

 

  Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

      Try

          Dim sMsg As String = ""

          With MyController

              If Not .IsRunnable Then

                   sMsg = "Not runnable." & Environment.NewLine & Environment.NewLine &

                      "Error Message=" & .RegistrationErrorMessage

                  MessageBox.Show(sMsg)

                  Return

              End If

               sMsg = "Yes the components are runnable. Now we can move forward to test some other objects."

               sMsg &= Environment.NewLine & Environment.NewLine & "Installation Name = " & .InstallationName & Environment.NewLine &

                  "Expires: " & .ExpiresOn.ToShortDateString

              MessageBox.Show(sMsg, "Success")

          End With

      Catch ex As Exception

          MessageBox.Show(ex.Message)

      End Try

  End Sub

End Class

 

 

HL7+ - Putting HL7 to work for you!
© 2018 HermeTech International
(a Division of TransWorld Scribes)