The HL7 V2 Messaging Object Model

Classes

BaseThe base V2 object

DictTableItemA specific entry in an HL7 Table

DictTableDefinition of a table

DictDataTypeDefinition of a data type

DictComponentDefinition of a component

DictStructureDefinition of a structure

DictDataElementInformation about a data element definition

DictSegmentFieldInformation about a particular field in a Segment

DictSegmentInformation pertaining to a segment

DictSegmentGroupAn Entry for a group in a Segment Map

DictMessageStructureStructure ID - required for XML encoding

ContentA class that represents a section of a complex content in an escaped field.

DataObjectCommon ancestor for all Messages, Segments, Fields, Components

CellThe common Component lays down common content management for the subcomponent, component and DataElement classes.

The cell may have actual contents if it doesn't have children. When the cell has contents, the content is stored internally as a sequence of content parts. The content parts may consist of a single null (for ""), or a sequence of Text, Escape and Binary Parts in any order.

The internal representation enables the full content of any valid HL7 message to be stored, but these features (escapes, binary content) are not widely used, and the internal content storage API is not a convenient form to work with simple content - which is the majority of cases.

For this reason, the content of a cell can be accessed in a number of ways:

  • using simple typed accessors such as asDate, asInteger, asString etc.
  • getting the RawContent (but this is potentially dangerous, see the documentation for RawContent)
  • examaning the contents directly using the Contents and ContentCount properties. This is usually overkill except where the content has escapes such as \H\, \.br\, \X..\ or similar
The simple typed accessors and RawContent check that there is no escape or binary content. Errors will be raised if these exist.

ComponentEncapsulates a component

DataElementEncapsulates a Data Element (or Field)

SegmentEncapsulates a Segment

MessageEncapsulates a single logical HL7Message.

To read an existing message, create an HL7Message and then decode a source message.

To create a reply, create an HL7Message, and then use BuildAsReply.

To create a new message, create a message, set it's version, and then add the segments that you require and populate them with values. When finished, call Encode


© Kestral Computing P/L 2000 - 2003. HL7Connect v2.00-063 generated on 30-Nov 2015.
Keywords: HL7Connect.V2