COREHL7 API Online Help - Region 4: [CORE HL7 MSSQL]
|
|
There are two (2) major operations that return a special Result Class to contain data about the operation beyond just success and failure.
The return from the VerifySchemaIsPresent() method in the COREHL7MSSQLSchema object is the COREMSSQLHL7VerifySchemaResult object.
AND
The return from the ImportHL7Message() method in the COREMSSQLHL7Importer object is the COREMSSQLHL7ImportResult object.
Public Properties:
Property Name
|
Data Type
|
Exception Handling
|
Uses the described in Region 1.
|
COREHL7APIColumnIsPresent
|
bool (read only) Will indicate whether the is present in the <prefix>_HL7Data table.
|
FixSchemaInstructions
|
string (read only) IF Success == false BUT the problem is a simple one this property will contain a SQL Script which can help fix the issue(s).
|
HL7DataTableExists
|
bool (read only) Will indicate whether the <prefix>_HL7DataTable exists or not.
|
HL7DefinitionValue
|
string (read only) will be the XML string value of the COREHL7Definition object used to create the HL7 Schema stored in the table.
|
Schema_VendorID
|
string (read only) will be the value of the Schema_VendorID data column in the single-row table
|
Schema_VendorName
|
string (read only) will be the value of the Schema_VendorName data column in the single-row table
|
SchemaMasterRecordExists
|
bool (read only) Will indicate whether the table exists AND has the required single record.
|
Success
|
bool Will indicate whether the VerifySchema() operation was successful and the HL7 Schema exists in the database.
|
Tag
|
See the CORETag object - General purpose Tag object for custom programming code
|
Public Methods:
Method
|
Return Value
|
Exception Handling
|
Uses the described in Region 1.
|
There are no other public methods in this class
|
|
Public Properties:
Property Name
|
Data Type
|
Exception Handling
|
Uses the described in Region 1.
|
LoadCount
|
int (read only) Will be the number of times the HL7 Message has been loaded into the database.
|
MessageID
|
string (read only) Will be the MessageID (GUID) which was assigned to the HL7 message in the database.
|
OperationStarted
|
DateTime (read only) The system date when the import operation began.
|
OperationCompleted
|
DateTime (read only) The system date when the import operation completed. (Used to calculate performance)
|
Reloaded
|
bool (read only) Indicates whether this was the first time the HL7 Message was loaded into the database.l
|
Success
|
bool Will indicate whether the ImportHL7Message() operation was successful
|
Tag
|
See the CORETag object - General purpose Tag object for custom programming code
|
TrainingCyclesCompleted
|
int (read only) Will be the number of Schema Training operations executed during the import operation.
|
Public Methods:
Method
|
Return Value
|
Exception Handling
|
Uses the described in Region 1.
|
There are no other public methods in this class
|
|
The Classes Shown Above Are SubClasses of this generic COREHL7Result class.
public class COREHL7Result
{
/*
Uses the
*/
public bool Success { get; set; } = true;
public COREHL7Result()
{
}
public COREHL7Result(bool success, COREException exception)
{
try
{
Success = success;
LastException.SetException(exception);
}
catch (Exception)
{
//do nothing
}
}
}
|
