Please enable JavaScript to view this site.

CORE HL7 API

Online Help - Region 1: [CORE HL7 API Basic]

Other CORE HL7 API Help Regions

Download the API Libraries


 

The Master Controlling Class

Object: HL7Controller

Derived Sub-Classes

HL7IPListenerController

HL7IPSenderController

 

HL7Controller Object Creation Factory

HL7Controller Object Creation Factory

 

Creating the object Example (C#)

 

In your code you will create the HL7Controller object (or any of the derived sub-classes) and pass it a single string parameter LicenseFilePathOrValue. This parameter can be either the full path/file name of a file containing a CORE API License OR it can be the actual string (xml) value that makes up a CORE API License. This means that you can store your CORE API License(s) in a database and retrieve them from there if you wish and use them to activate your HL7Controller objects. You can review Getting Started for how to create a CORE API License for your computer / server. If you need to purchase CORE API Licenses you can do so through our website or contact customer service.

 

Example Code (C#):

 

Public Properties and Methods (related to the License):

 

Property Name

Data Type

ExceptionHandling

Uses the Standard Exceptions Interface

License

COREAPILicense (read only)

LicenseIsExpired

bool (read only)

LicenseIsValid

bool (read only)

LicenseIsRunnable

bool (read only)

LicenseIsRunnableForTCPIPInbound

bool (read only) Can the license be used to receive messages over TCP/IP

LicenseIsRunnableForTCPIPOutbound

bool (read only) Can the license be used to send messages over TCP/IP

LicenseReport()

string - Returns a Text license report

RefreshLicense()

bool takes a string parameter (see the example code above)

 

Public Properties:

 

Property Name

Data Type

ExceptionHandling

Uses the Standard Exceptions Interface

BOM

Begin Message Character

ComponentDelimiter

See Encoding Characters

EOM

End of Message Character(s)

EncodingCharacters

string (read only) returns the 4 primary encoding characters

EscapeDelimiter

See Encoding Characters

FieldDelimiter

See Encoding Characters

RepeatDelimiter

See Encoding Characters

SOM

HL7 Segment Delimiter

SubComponentDelimiter

See Encoding Characters

License

COREAPILicense (read only)

Tag

CORETag Object

Utilities

COREUtilities (read only)

 

Public Methods:

 

Method

Return Value

ExceptionHandling

Uses the Standard Exceptions Interface

GetLicenseReader()

COREAPILicense - Loads a CORE HL7 API license object outside of the controllers License property

NewFileAnalyzer()

HL7FileAnalyzer object

NewHL7Message()

HL7Message object

NewMessageControlID()

string See Message Control ID

NewStringAnalyzer()

HL7StringAnalyzer object

NewVendorDefinition()

HL7Definition object

HL7Encoder()

HL7EncodingCharacters object

 

 

 

  

Keyboard Navigation

F7 for caret browsing
Hold ALT and press letter

This Info: ALT+q
Nav Header: ALT+n
Page Header: ALT+h
Topic Header: ALT+t
Topic Body: ALT+b
Exit Menu/Up: ESC