Class HL7Parser

Namespace

EDIParser

Assembly

EDIParser.dll

Parses HL7 messages using delimiter values defined in the MSH segment.

public sealed class HL7Parser : Parser, IComponent, IDisposable

Inheritance

object

MarshalByRefObject

Component

Parser

HL7Parser

Implements

IComponent

IDisposable

Inherited Members

Parser.ParsedSegment

Parser.ValueIndexer

Parser.IgnoreMissingItem

Parser.ConserveMemory

Parser.SegmentParsingOption

Parser.FieldSeparator

Parser.ComponentSeparator

Parser.SubComponentSeparator

Parser.RepetitionSeparator

Parser.Segments

Parser.GetValue(string)

Parser.GetValue(string, int)

Parser.GetValue(string, int, int)

Parser.SetValue(string, string)

Parser.SetValue(string, string, int)

Parser.SetValue(string, string, int, int)

Parser.Message()

Component.Dispose()

Component.ToString()

Component.Container

Component.Site

Component.Disposed

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

The parser is initialized with standard HL7 delimiters: carriage return for segments, | for fields, ^ for components, ~ for repetitions, \ for escapes, and & for subcomponents.

By default, delimiter values are read from the MSH segment before parsing.

Constructors

HL7Parser()

Initializes a new instance of the HL7Parser class using the standard HL7 delimiters.

public HL7Parser()

Properties

CheckMSHSeparator

Gets or sets a value indicating whether delimiter characters should be read from the MSH segment before parsing.

public bool CheckMSHSeparator { get; set; }

Property Value

bool

true to detect separators from MSH-1 and MSH-2; otherwise, false to use the currently configured delimiters.

EscapeChar

Gets or sets the HL7 escape character.

public string EscapeChar { get; set; }

Property Value

string

SegmentSeparator

Gets or sets the delimiter used to separate HL7 segments.

public override string SegmentSeparator { get; set; }

Property Value

string

Remarks

The parser may automatically switch between carriage return and carriage-return/line-feed separators based on the source message.

Methods

ParseMsg(string)

Parses an HL7 message and populates the parser object model.

public override void ParseMsg(string msg)

Parameters

msg string

The HL7 message to parse.

Remarks

When CheckMSHSeparator is enabled, the field, component, repetition, escape, and subcomponent delimiters are read from the initial MSH segment.

The MSH field delimiter and encoding characters are temporarily replaced with parser tokens so that MSH can be represented consistently within the normal field object model.

The parser detects whether the source message uses carriage return or carriage-return/line-feed segment separators.

Exceptions

ArgumentNullException

Thrown when msg is null.

ArgumentException

Thrown when the message is too short to contain the MSH delimiter definition.

Exception

Thrown when the configured segment separator cannot be found in the message.