Table Of Contents

This document is split into the following sections:

Library Description: SOAP specification for dynamic distributed realtime medical communication

Services

The following table lists the Services defined in "Hl7Intf":

HL7 The main Server interface that is used once connection is established
HL7Admin Admin functions for server
HL7Register Allows Key Registration

Operations defined by "HL7"

The following table lists the Operations defined in "HL7":

ServerAlive Used as a quite Check to see if server is running
SendHL7Message Post an encrypted HL7 Message for processing. Will return HL7 Response or an error
SendPITMessage Processes PIT message. Converted to HL7 and a HL7 ack is returned
SendSMIMEMessage
GetServerTime Allows Time synchonization.
PracticeHD Returns the values of the HL7 HD that identifies this practice
TimeZone

"HL7.ServerAlive" Method

Pascal Syntax:

function HL7.ServerAlive(: Boolean);

C# Syntax:

public Boolean HL7.ServerAlive();

"HL7.SendHL7Message" Method

Pascal Syntax:

function HL7.SendHL7Message(const HL7Message: String: String);

C# Syntax:

public String HL7.SendHL7Message(String HL7Message);

"HL7.SendPITMessage" Method

Pascal Syntax:

function HL7.SendPITMessage(const APITMessage: String: String);

C# Syntax:

public String HL7.SendPITMessage(String APITMessage);

"HL7.SendSMIMEMessage" Method

Pascal Syntax:

function HL7.SendSMIMEMessage(const ASMIMEMessage: String: String);

C# Syntax:

public String HL7.SendSMIMEMessage(String ASMIMEMessage);

"HL7.GetServerTime" Method

Pascal Syntax:

function HL7.GetServerTime(: DateTime);

C# Syntax:

public DateTime HL7.GetServerTime();

"HL7.PracticeHD" Method

Pascal Syntax:

procedure HL7.PracticeHD(NamespaceID: String; UniversalID: String; UniversalIDType: String);

C# Syntax:

public void HL7.PracticeHD(out String NamespaceID, out String UniversalID, out String UniversalIDType);

"HL7.TimeZone" Method

Pascal Syntax:

function HL7.TimeZone(: String);

C# Syntax:

public String HL7.TimeZone();

Operations defined by "HL7Admin"

The following table lists the Operations defined in "HL7Admin":

ServerType
Active
Display_Name
PracticeID
Version_Number
Providers
Locations
Encryption
Connections
PKI_Individual_Keys
PublicKeyName_PGP
PublicKey_PGP
PublicKey_PGP_FingerPrint
PublicKeyName_GNUPG
PublicKey_GNUPG
PublicKey_GNUPG_FingerPrint
PublicKeyName_PKI
Email_Address
EMail_Enveloping_Formats
DataVersion

"HL7Admin.ServerType" Method

Pascal Syntax:

function HL7Admin.ServerType(: ServerType);

C# Syntax:

public ServerType HL7Admin.ServerType();

"HL7Admin.Active" Method

Pascal Syntax:

function HL7Admin.Active(: Boolean);

C# Syntax:

public Boolean HL7Admin.Active();

"HL7Admin.Display_Name" Method

Pascal Syntax:

function HL7Admin.Display_Name(: String);

C# Syntax:

public String HL7Admin.Display_Name();

"HL7Admin.PracticeID" Method

Pascal Syntax:

function HL7Admin.PracticeID(: HD);

C# Syntax:

public HD HL7Admin.PracticeID();

"HL7Admin.Version_Number" Method

Pascal Syntax:

function HL7Admin.Version_Number(: Integer);

C# Syntax:

public Integer HL7Admin.Version_Number();

"HL7Admin.Providers" Method

Pascal Syntax:

function HL7Admin.Providers(: Providers);

C# Syntax:

public Providers HL7Admin.Providers();

"HL7Admin.Locations" Method

Pascal Syntax:

function HL7Admin.Locations(: Locations);

C# Syntax:

public Locations HL7Admin.Locations();

"HL7Admin.Encryption" Method

Pascal Syntax:

function HL7Admin.Encryption(: EncryptionTypes);

C# Syntax:

public EncryptionTypes HL7Admin.Encryption();

"HL7Admin.Connections" Method

Pascal Syntax:

function HL7Admin.Connections(: Connections);

C# Syntax:

public Connections HL7Admin.Connections();

"HL7Admin.PKI_Individual_Keys" Method

Pascal Syntax:

function HL7Admin.PKI_Individual_Keys(: StringList);

C# Syntax:

public StringList HL7Admin.PKI_Individual_Keys();

"HL7Admin.PublicKeyName_PGP" Method

Pascal Syntax:

function HL7Admin.PublicKeyName_PGP(: String);

C# Syntax:

public String HL7Admin.PublicKeyName_PGP();

"HL7Admin.PublicKey_PGP" Method

Pascal Syntax:

function HL7Admin.PublicKey_PGP(: String);

C# Syntax:

public String HL7Admin.PublicKey_PGP();

"HL7Admin.PublicKey_PGP_FingerPrint" Method

Pascal Syntax:

function HL7Admin.PublicKey_PGP_FingerPrint(: String);

C# Syntax:

public String HL7Admin.PublicKey_PGP_FingerPrint();

"HL7Admin.PublicKeyName_GNUPG" Method

Pascal Syntax:

function HL7Admin.PublicKeyName_GNUPG(: String);

C# Syntax:

public String HL7Admin.PublicKeyName_GNUPG();

"HL7Admin.PublicKey_GNUPG" Method

Pascal Syntax:

function HL7Admin.PublicKey_GNUPG(: String);

C# Syntax:

public String HL7Admin.PublicKey_GNUPG();

"HL7Admin.PublicKey_GNUPG_FingerPrint" Method

Pascal Syntax:

function HL7Admin.PublicKey_GNUPG_FingerPrint(: String);

C# Syntax:

public String HL7Admin.PublicKey_GNUPG_FingerPrint();

"HL7Admin.PublicKeyName_PKI" Method

Pascal Syntax:

function HL7Admin.PublicKeyName_PKI(: String);

C# Syntax:

public String HL7Admin.PublicKeyName_PKI();

"HL7Admin.Email_Address" Method

Pascal Syntax:

function HL7Admin.Email_Address(: String);

C# Syntax:

public String HL7Admin.Email_Address();

"HL7Admin.EMail_Enveloping_Formats" Method

Pascal Syntax:

function HL7Admin.EMail_Enveloping_Formats(: EMailFormats);

C# Syntax:

public EMailFormats HL7Admin.EMail_Enveloping_Formats();

"HL7Admin.DataVersion" Method

Pascal Syntax:

function HL7Admin.DataVersion(: String);

C# Syntax:

public String HL7Admin.DataVersion();

Operations defined by "HL7Register"

The following table lists the Operations defined in "HL7Register":

RegisterPGPKey ASCII encoded public Key
RegisterGNUPGKey ASCII encoded Public Key
RegisterPKIKey Only need Keyname as keys on LDAP
SetupConnectionForPractice

"HL7Register.RegisterPGPKey" Method

Pascal Syntax:

function HL7Register.RegisterPGPKey(const KeyName: String; const PublicKey: String; const Registrant_Name: String; const Contact_Phone_Number: String: String);

C# Syntax:

public String HL7Register.RegisterPGPKey(String KeyName, String PublicKey, String Registrant_Name, String Contact_Phone_Number);

"HL7Register.RegisterGNUPGKey" Method

Pascal Syntax:

function HL7Register.RegisterGNUPGKey(const KeyName: String; const PublicKey: String; const Registrant_Name: String; const Contact_Phone_Number: String: String);

C# Syntax:

public String HL7Register.RegisterGNUPGKey(String KeyName, String PublicKey, String Registrant_Name, String Contact_Phone_Number);

"HL7Register.RegisterPKIKey" Method

Pascal Syntax:

function HL7Register.RegisterPKIKey(const KeyName: String; const Registrant_Name: String; const Contact_Phone_Number: String: String);

C# Syntax:

public String HL7Register.RegisterPKIKey(String KeyName, String Registrant_Name, String Contact_Phone_Number);

"HL7Register.SetupConnectionForPractice" Method

Pascal Syntax:

function HL7Register.SetupConnectionForPractice(const NamespaceID: String; const UniversalID: String; const UniversalIDType: String; const Version: Integer; const CertificateAuthority: HD: Boolean);

C# Syntax:

public Boolean HL7Register.SetupConnectionForPractice(String NamespaceID, String UniversalID, String UniversalIDType, Int32 Version, HD CertificateAuthority);

Event Sinks

The following table lists the Event Sinks defined in "Hl7Intf":

Structs

The following table lists the Structs defined in "Hl7Intf":

Provider HL7XCN clone
Address XAD Clone
ServerContact Contact details
HD HL7 HD Clone

Enums

The following table lists the Enums defined in "Hl7Intf":

ServerType Describes the main role for this server
EncryptionType Types of encryption supported
EmailFormat
Protocol

Hl7Intf Arrays

The following table lists the Arrays defined in "Hl7Intf":

Providers A list of Providers on this Server
Locations A list of practice addresses
EncryptionTypes A list of encryption supported
Connections A List of contact parameters
StringList
EMailFormats Email formats supported

Hl7Intf Exceptions

The following table lists the Exceptions defined in "Hl7Intf":