Home > Class Reference > ENSLIB namespace > EnsLib.HL7.Parser

EnsLib.HL7.Parser

class EnsLib.HL7.Parser extends %Library.RegisteredObject

This is the HL7 v2.x file format parser

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property %CharCount as %Integer;
Property methods: %CharCountDisplayToLogical(), %CharCountGet(), %CharCountIsValid(), %CharCountLogicalToDisplay(), %CharCountNormalize(), %CharCountSet()
property %CurrentDocument as EnsLib.EDI.Document;
The current Document
Property methods: %CurrentDocumentGet(), %CurrentDocumentGetSwizzled(), %CurrentDocumentIsValid(), %CurrentDocumentNewObject(), %CurrentDocumentSet()
property %CurrentParentSegIndex as %String;
The segment position within the current parent Document
Property methods: %CurrentParentSegIndexDisplayToLogical(), %CurrentParentSegIndexGet(), %CurrentParentSegIndexIsValid(), %CurrentParentSegIndexLogicalToDisplay(), %CurrentParentSegIndexLogicalToOdbc(), %CurrentParentSegIndexNormalize(), %CurrentParentSegIndexSet()
property %CurrentParents [ InitialExpression = 0 , MultiDimensional ];
List of enclosing parent objects ordered from outermost to immediate As EnsLib.EDI.Document
Property methods: %CurrentParentsDisplayToLogical(), %CurrentParentsGet(), %CurrentParentsIsValid(), %CurrentParentsLogicalToDisplay(), %CurrentParentsLogicalToOdbc(), %CurrentParentsNormalize(), %CurrentParentsSet()
property %EndBlock as %String;
EndBlock character(s) to look for as message end marker
Property methods: %EndBlockDisplayToLogical(), %EndBlockGet(), %EndBlockIsValid(), %EndBlockLogicalToDisplay(), %EndBlockLogicalToOdbc(), %EndBlockNormalize(), %EndBlockSet()
property %LineCount as %Integer;
Property methods: %LineCountDisplayToLogical(), %LineCountGet(), %LineCountIsValid(), %LineCountLogicalToDisplay(), %LineCountNormalize(), %LineCountSet()
property %LookaheadLine as %String;
Lookahead line left over from previous document parse
Property methods: %LookaheadLineDisplayToLogical(), %LookaheadLineGet(), %LookaheadLineIsNewDisplayToLogical(), %LookaheadLineIsNewGet(), %LookaheadLineIsNewIsValid(), %LookaheadLineIsNewLogicalToDisplay(), %LookaheadLineIsNewNormalize(), %LookaheadLineIsNewSet(), %LookaheadLineIsValid(), %LookaheadLineLogicalToDisplay(), %LookaheadLineLogicalToOdbc(), %LookaheadLineNormalize(), %LookaheadLineSet(), %LookaheadLineTerminatorDisplayToLogical(), %LookaheadLineTerminatorGet(), %LookaheadLineTerminatorIsValid(), %LookaheadLineTerminatorLogicalToDisplay(), %LookaheadLineTerminatorLogicalToOdbc(), %LookaheadLineTerminatorNormalize(), %LookaheadLineTerminatorSet()
property %LookaheadLineIsNew as %Boolean;
Lookahead buffer for line terminator of unframed MSH
Property methods: %LookaheadLineIsNewDisplayToLogical(), %LookaheadLineIsNewGet(), %LookaheadLineIsNewIsValid(), %LookaheadLineIsNewLogicalToDisplay(), %LookaheadLineIsNewNormalize(), %LookaheadLineIsNewSet()
property %LookaheadLineTerminator as %String;
Lookahead buffer for line terminator of unframed MSH
Property methods: %LookaheadLineTerminatorDisplayToLogical(), %LookaheadLineTerminatorGet(), %LookaheadLineTerminatorIsValid(), %LookaheadLineTerminatorLogicalToDisplay(), %LookaheadLineTerminatorLogicalToOdbc(), %LookaheadLineTerminatorNormalize(), %LookaheadLineTerminatorSet()
property %NumChildren as %Integer [ MultiDimensional ];
List of counts of nested documents, ordered from outer to innermost
Property methods: %NumChildrenDisplayToLogical(), %NumChildrenGet(), %NumChildrenIsValid(), %NumChildrenLogicalToDisplay(), %NumChildrenNormalize(), %NumChildrenSet()
property %ParentIds as %String;
List of enclosing parent objects ordered from immediate to outermost
Property methods: %ParentIdsDisplayToLogical(), %ParentIdsGet(), %ParentIdsIsValid(), %ParentIdsLogicalToDisplay(), %ParentIdsLogicalToOdbc(), %ParentIdsNormalize(), %ParentIdsSet()
property %SegmentCount as %Integer;
Count of Segments tallied during parse
Property methods: %SegmentCountDisplayToLogical(), %SegmentCountGet(), %SegmentCountIsValid(), %SegmentCountLogicalToDisplay(), %SegmentCountNormalize(), %SegmentCountSet()
property %ServiceInterface as EnsLib.EDI.ServiceInterface;
The config provider
Property methods: %ServiceInterfaceGet(), %ServiceInterfaceGetSwizzled(), %ServiceInterfaceIsValid(), %ServiceInterfaceNewObject(), %ServiceInterfaceSet()
property %Stream as %IO.I.CharacterStream;
Property methods: %StreamGet(), %StreamGetSwizzled(), %StreamIsValid(), %StreamNewObject(), %StreamSet()
property %inFraming as %String;
pre-parse of Framing setting
Property methods: %inFramingDisplayToLogical(), %inFramingGet(), %inFramingIsValid(), %inFramingLogicalToDisplay(), %inFramingLogicalToOdbc(), %inFramingNormalize(), %inFramingSet()
property %outFraming as %String;
Framing to use on output if input framing is "Flexible"
Property methods: %outFramingDisplayToLogical(), %outFramingGet(), %outFramingIsValid(), %outFramingLogicalToDisplay(), %outFramingLogicalToOdbc(), %outFramingNormalize(), %outFramingSet()
property DefCharEncoding as %String;
Default Character Encoding to use when reading or writing HL7 messages.

If MSH field 18 (Character Set) is empty, this encoding will be used. Choices you can use for this setting include:

  • Native - use the default character encoding of the installed locale of the Ensemble server
  • latin1 - the ISO Latin1 8-bit encoding; this is the default
  • ISO-8859-1 - the ISO Latin1 8-bit encoding
  • UTF-8 - the Unicode 8-bit encoding
  • Unicode - the Unicode 16-bit encoding (Little-Endian)
  • UnicodeBig - the Unicode 16-bit encoding (Big-Endian)
  • Any other NLS definitions installed on this Ensemble server
  • @<ttable> - <ttable> means a raw InterSystems character translation table name. A prefix of '@' means to use the named table.
Putting ! before the encoding name will force the use of the named encoding and will ignore any value found in MSH:18.

Property methods: DefCharEncodingDisplayToLogical(), DefCharEncodingGet(), DefCharEncodingIsValid(), DefCharEncodingLogicalToDisplay(), DefCharEncodingLogicalToOdbc(), DefCharEncodingNormalize(), DefCharEncodingSet()
property Done as %Boolean [ Calculated , ReadOnly ];
Property methods: DoneDisplayToLogical(), DoneGet(), DoneIsValid(), DoneLogicalToDisplay(), DoneNormalize()
property Framing as %String;
See your HL7 Config Items for a description of accepted values.
Property methods: FramingDisplayToLogical(), FramingGet(), FramingIsValid(), FramingLogicalToDisplay(), FramingLogicalToOdbc(), FramingNormalize(), FramingSet()
property IgnoreBlankLines as %Boolean;
Don't consider a blank line to indicate the end of a document
Property methods: IgnoreBlankLinesDisplayToLogical(), IgnoreBlankLinesGet(), IgnoreBlankLinesIsValid(), IgnoreBlankLinesLogicalToDisplay(), IgnoreBlankLinesNormalize(), IgnoreBlankLinesSet()
property ReadTimeout as %Numeric (MINVAL = -1) [ InitialExpression = 5 ];