HL7PlusMessage

AllSegments

SortedList

Returns a SortedList(of Integer, HL7PlusSegment) of all segments in the HL7PlusMessage object. The Integer key for the SortedList will be the Index of the HL7PlusSegment within the message beginning with the MSH segment which MUST always be #1.

ForceTrailingFieldDelimiter

Boolean

Default = False. If True the Value property of all HL7PlusSegment objects will include a trailing Field Delimiter character.

IntegerTag

Integer

General purpose numeric Tag for use any way you like

KeepEmptyFields

Boolean

Default = False. If True the Value property of all HL7PlusSegment objects will NOT trim empty HL7 fields, if False it will.

KeepEmptyComponents

Boolean

Default = False. If True the Value property of all HL7PlusField objects will NOT trim empty HL7 components, if False it will.

KeepEmptySubComponents

Boolean

Default = False. If True the Value property of all HL7PlusComponent objects will NOT trim empty SubComponents, if False it will.

MessageValueIsValid

Boolean

Evaluates the Value of the HL7 message to determine if it contains invalid data.

Parameter 1: OPTIONAL blnEvaluateMSH (Boolean = False)

Programming Note: This read-only property will perform 2 (or 3) different checks when queried.

1.It evaluates the HL7 message for basic errors like No Segments, 1st Segment not MSH, only 1 Segment (all valid HL7 messages have more than 1 segment).

2.It will query the ValueIsValid Property of all HL7PlusSegment objects in the message.

3.IF blnEvaluateMSH is True it will look at the MSH segment and verify that there IS DATA (it does not evaluate the data itself) in MSH_MessageDate, MSH_MessageType, MSH_MessageControlID, and MSH_HL7Version. See the MSH Segment Shortcut Properties below.

IF the property returns False, you can find error details in LastException

ParentHL7Controller

HL7PlusController

Returns the HL7PlusController object used to create the object.

RawLoadedHL7String

String

If the message object was "loaded" with an entire HL7 message string (as from the LoadHL7MessageString() method, or from one of the HL7+ File Objects) this value will contain the RAW string value used to create the message. This value will remain unchanged for the life of the object.

SourceFileIndex

Integer

If the message object was "loaded" with one of the HL7+ File Objects this value will contain the ordinal position of the HL7 message within the file beginning with #1

SourceFileName

String

If the message object was "loaded" with one of the HL7+ File Objects this value will contain the full path/filename of the source file

Tag

String

General purpose string Tag for use any way you like.

Value

String

Get / Set the entire HL7 message value. Setting Value to "" is the same as calling the Clear() method. Setting Value to a full HL7 message string is the same as calling the LoadHL7MessageString() method.

Method:

AddEmptySegment(strSegmentName)

Paramters:

1: strSegmentName (String)

Return Value:

HL7PlusSegment object (or nothing if an error occurs)

Description:

Adds a new segment to the HL7PlusMessage object. The segment will be added at the end of the message.

Programming Note: The FIRST segment added to a HL7PlusMessage MUST be the MSH segment

Method:

AddSegmentString(strSegmentValue)

Paramters:

1: strSegmentValue (String) - A full or partial HL7 Segment String Value.

Return Value:

HL7PlusSegment object (or nothing if an error occurs)

Description:

Adds a full or partially formed HL7PlusSegment to the HL7PlusMessage object. The segment will be added at the end of the message.

Programming Note: The FIRST segment added to a HL7PlusMessage MUST be the MSH segment

Programming Note: Calling AddSegmentString("PID") is functionally equivalent to calling AddEmptySegment("PID")

Method:

Clear()

Paramters:

None

Return Value:

Boolean

Description:

Clears the HL7PlusMessage object for reuse.

Method:

Copy()

Paramters:

None

Return Value:

HL7PlusMessage

Description:

Returns a copy of the HL7PlusMessage object or Nothing if ParentController.IsRunnable is False.

Method:

GetAllSegments(strSegmentName)

Paramters:

1: strSegmentName (String) - The 3 character name of the segment you wish to retrieve a list of

Return Value:

List (of HL7PlusSegment)

Description:

Retrieves a list of all occurrences of HL7PlusSegment objects named strSegmentName or an empty List if there are none.

Example: GetAllSegments("OBX") would retrieve a List object containing all of the OBX segments in the message.

Method:

GetChildSegments(oParentSegment, strChildSegmentName) + 1 overload

GetChildSegments(oParentSegment, oListOfChildNames)

Paramters:

1: oParentSegment (HL7PlusSegment) - The HL7PlusSegment Parent

2: strChildSegmentName (String) - The 3 character name of the child segment you wish to retrieve a list of.

2: oListOfChildNames ( List (of String) ) - A List of 3 character names of the child segment you wish to retrieve a list of.

Return Value:

List (of HL7PlusSegment)

Description:

Retrieves a List of all occurrences of HL7PlusSegment objects named strSegmentName which occur in the message AFTER oParentSegment and BEFORE another HL7PlusSegment with the same name.

Method:

GetEncodingCharacters()

Paramters:

None

Return Value:

String

Description:

Returns the encoding characters (ComponentDelimiter + RepeatDelimiter + EscapeDelimiter + SubComponentDelimiter)

Method:

GetParentSegment(oChildSegment, strParentSegmentName)

Paramters:

1: oChildSegment (HL7PlusSegment) - The HL7PlusSegment Child

2: strParentSegmentName (String) - The 3 character name of the parent segment you wish to retrieve.

Return Value:

HL7PlusSegment

Description:

Returns the first occurrence of a segment named strParentSegmentName ABOVE oChildSegment ordinally in the HL7 message (or Nothing if not found)

Method:

GetSegment(Index) + 1 overload

GetSegment(strSegmentName, Optional intSegmentInstance = 1)

Paramters:

1: Index - (Integer) - The ordinal position of the segment in the HL7 message

1: strSegmentName - (String) - The 3 character NAME of the segment you wish to retrieve

2: intSegmentInstance (Integer) - The instance in the message you wish to retrieve.

Return Value:

HL7PlusSegment (or Nothing if not found)

Description:

Returns a HL7PlusSegment object within the message

Example 1: If you wish to get the 3rd OBR segment in a message you would call GetSegment("OBR", 3).

Example 2: If you want the 4th segment in the message call GetSegment(4).

Example 3: If you want 1st OBX segment call GetSegment("OBX").

Example 4: If you want the MSH segment call GetSegment("MSH") OR GetSegment(1)

Method:

HasChildSegments(oParentSegment, strChildSegmentName)

Paramters:

1: oParentSegment (HL7PlusSegment) - The HL7PlusSegment Parent

2: strChildSegmentName (String) - The 3 character name of the child segment you wish know about.

Return Value:

Boolean

Description:

Determine if oParentSegment has a child segment named strChildSegmentName.

Method:

HasParentSegment(oChildSegment, strParentSegmentName)

Paramters:

1: oChildSegment (HL7PlusSegment) - The HL7PlusSegment Child

2: strParentSegmentName (String) - The 3 character name of the parent segment you wish to know about.

Return Value:

Boolean

Description:

Determine if oChildSegment has a parent segment named strParentSegmentName.

Method:

InsertSegmentAfter(ReferenceSegment, strSegmentValue)

Paramters:

1: ReferenceSegment (HL7PlusSegment) - The HL7PlusSegment Parent

2: strSegmentValue (String) - Must be AT least the 3 character name of the parent segment you wish to add, but can also be a full or partially formed HL7 Segment string value.

Return Value:

HL7PlusSegment

Description:

Adds a HL7PlusSegment to the message AFTER ReferenceSegment

Example: The following 2 statements accomplish roughly the same thing.

InsertSegmentAfter(obMyMSH,"EVN") inserts an empty EVN segment immediately obMyMSH.

InsertSegmentAfter(obMyMSH,"EVN|A08|||00102|00002") inserts a partially populated EVN segment immediately AFTER obMyMSH.

Method:

InsertSegmentBefore(ReferenceSegment, strSegmentValue)

Paramters:

1: ReferenceSegment (HL7PlusSegment) - The HL7PlusSegment Child

2: strSegmentValue (String) - Must be AT least the 3 character name of the parent segment you wish to add, but can also be a full or partially formed HL7 Segment string value.

Return Value:

HL7PlusSegment

Description:

Adds a HL7PlusSegment to the message BEFORE ReferenceSegment

Example: The following 2 statements accomplish roughly the same thing.

InsertSegmentBefore(obMyPID,"EVN") inserts an empty EVN segment immediately BEFORE obMyPID.

InsertSegmentBefore(obMyPID,"EVN|A08|||00102|00002") inserts a partially populated EVN segment immediately BEFORE obMyPID.

Method:

LoadHL7MessageString(strHL7Message)

Paramters:

1: strHL7Message (String) - a full or partially formed HL7 message string

Return Value:

Boolean - Success or Failure

Description:

Populates a HL7PlusMessage object with a full or partially formed HL7 message in strHL7Message.

Method:

MakeHL7ControlID()

Paramters:

None

Return Value:

String

Description:

Creates a HL7 compliant unique control ID for MSH field 10.1

Programming Note: Calls ParentController.MakeHL7ControlID()

Method:

SaveToFile(strFileName, Optional blnIncludeBOMEOM = False, Optional blnAppendToFile = True)

Paramters:

1: strFileName (String) - The full path / filename to save the HL7 message to

2: OPTIONAL blnIncludeBOMEOM (Boolean) - Whether to include the enveloping characters (BOM and EOM).

3: OPTIONAL blnAppendToFile (Boolean) - If False the file will be created/overwritten. If True the message will be appended to the file (or created if the file does not exist)

Return Value:

Boolean

Description:

Spools a HL7 message to disk

Method:

SetANSIEncoding()

Paramters:

None

Return Value:

None

Description:

Sets all of the encoding characters in a message to their ANSI default values.

Programming Note: Defined in the ANSI Encoding Characters section of the HL7PlusUtilities object

Method:

SetMSHValues(oMSHInfo)

Paramters:

1: oMSHInfo (HL7PLusMSHInfo)

Return Value:

None

Description:

Sets the values in the MSH segment to the corresponding values in oMSHInfo.

Programming Note: Follows the same rules as creating a message with NewHL7PlusMessage(oMSHInfo). See the HL7PlusMSHInfo section for more information.