Online Help - Region 1: [CORE HL7 API Basic] |
Object: HL7EncodingCharacters
NOTE: No public entry point. Created only through a Controller object.
Description: Object for maintaining, setting, and retrieving all of the Control Characters used in HL7
IMPORTANT: The only time you should ever have to concern yourselves with HL7 Control Characters is when they DIFFER from the ANSI HL7 Standards which is why every time you set up a new HL7 interface with a trading partner you make sure that any deviations from ANSI standards have been agreed upon.
Creating the Object (C#)
//Where oController is an active Controller object
HL7EncodingCharacters enc = oController.HL7Encoder();
//OR Where oMessage is an open HL7Message object
HL7EncodingCharacters enc2 = oMessage.MyEncoder();
When you create any of the Controller Objects they have an internal HL7EncodingCharacters object which is set to the ANSI Default values. You can retrieve the controllers HL7EncodingCharacters object as shown in the code above. Likewise whenever you create a new HL7Message object by calling a .NewHL7Message() method on a controller object the resulting HL7Message object will have INHERITED it's own HL7EncodingCharacters object which is cloned from the controller object that created it.
Property Name |
Data Type |
ExceptionHandling |
Uses the Standard Exceptions Interface |
ParentController |
HL7Controller (read only) |
Message Envelope Characters |
|
BOM |
string |
EOM |
string |
SOM |
string - Also called the Segment Delimiter |
Encoding Character - Individual Properties |
|
FieldDelimiter |
string |
ComponentDelimiter |
string |
RepeatDelimiter |
string |
EscapeDelimiter |
string |
SubComponentDelimiter |
string |
Encoding Characters - Group Property |
|
EncodingCharacters |
string (read only) - Returns the 4 "Encoding Characters" as defined by HL7. ComponentDelimiter + RepeatDelimiter + EscapeDelimiter + SubComponentDelimiter |
Method |
Return Value |
ExceptionHandling |
Uses the Standard Exceptions Interface |
Copy() |
HL7EncodingCharacters - Returns a copy of the object |
IsAnsi() |
bool - Indicates whether the object contains ANSI Standard Values |
Reset() |
void - Resets the object to ParentController values. Can also pass HL7Message object and will reset to that object's values |
ResetToAnsiDefault() |
void - Resets the object properties to ANSI Standard Values |
SetEncodingCharacters() |
bool - Takes a 4 character string and sets the individual properties in EncodingCharacters above. Parameter should be: ComponentDelimiter + RepeatDelimiter + EscapeDelimiter + SubComponentDelimiter |
