HTSQLHL7Field Class
Contents
1st Appearance: Version 1.0.6
Class Name: HTSQLHL7Field
Scope: Public - Restricted - Child Class of HTSQLHL7Message ->HTSQLHL7Segment - No public constructor.
Integer Index - The ordinal position of the field within the HL7 segment. Fields are numbered starting with ONE (1). In HL7 Field #0 is implied and is the SegmentName.
Integer Instances - In HL7 messages the Fields can repeat. Instances is the number of repeating instances the field contains. If the field is EMPTY Instances will return 0.
Boolean IsRepeatingField - Will be true if Instances is > 1.
HTSQLHL7Segment ParentSegment - Object reference to the parent segment object containing the instance.
String Value - The HL7 formatted value of the field. |
HTSQLHL7Component Component(Integer, Integer) - Returns a component object or Null if parameters are invalid. Parameter 1: Integer - componentNumber. - The ordinal position within the field "instance" of the object you wish to retrieve. Parameter 2: Integer - fieldInstance. (Optional Default = 1) - In which "instance" would you like to retrieve the component.
Valid values for Parameter 1 are a value between 1 and ComponentCount(fieldInstance) Valid values for Parameter 2 are a value between 1 and Instances
Integer ComponentCount(Integer) Parameter 1: Integer - fieldInstance. (Optional Default = 1) - Returns how many HTSQLHL7Component objects are stored in "instance" fieldInstance.
Description: In HL7 messages the fields can repeat. Instances is the number of repeating instances the field contains. If the field is EMPTY Instances will be 0. Each field "Instance" is made up of 0 or more HTSQLHL7Component objects. In example 1 below it shows a HL7 Field value where "instance" 1 and 2 are EMPTY (0 Components) while "instance" 3 has data.
Example 1 - Repeating field with data ONLY in instance #3 - Raw Value: "~~Smith^John"
Boolean ComponentExists(Integer, Integer) - True or False. Parameter 1: Integer - componentNumber. - The ordinal position within the field "instance" of the object you wish to retrieve. Parameter 2: Integer - fieldInstance. (Optional Default = 1) - In which "instance" would you like to retrieve the component.
String GetComponentValue(Integer, Integer, Integer) - The HL7 formatted value of the field. Parameter 1: Integer - componentNumber. - The ordinal position within the field "instance" of the object you wish to retrieve. Parameter 2: Integer - fieldInstance. In which "instance" would you like to retrieve the component. Parameter 3: Integer - subComponentNumber. (Optional Default = 1) From the component which sub-component value do you want. Passing 0 in this parameter will return the raw value of the component which may include sub-component data.
|
Exception Handling: Follows the Common Exceptions Interface.
