Skip to main content

HS.InteropTools.HL7.Compare.Message

persistent class HS.InteropTools.HL7.Compare.Message extends %Library.Persistent

SQL Table Name: HS_InteropTools_HL7_Compare.Message

Message Class holds a pointer to the EnsLib.HL7.Message and parsed hash values for each of the segment fields

Property Inventory

Method Inventory

Properties

property ControlID as %String;
Property methods: ControlIDDisplayToLogical(), ControlIDGet(), ControlIDGetStored(), ControlIDIsValid(), ControlIDLogicalToDisplay(), ControlIDLogicalToOdbc(), ControlIDNormalize(), ControlIDSet()
property DocumentType as %String;
ie 2.3.1:ORUR01
Property methods: DocumentTypeDisplayToLogical(), DocumentTypeGet(), DocumentTypeGetStored(), DocumentTypeIsValid(), DocumentTypeLogicalToDisplay(), DocumentTypeLogicalToOdbc(), DocumentTypeNormalize(), DocumentTypeSet()
property Encoding as %String;
Property methods: EncodingDisplayToLogical(), EncodingGet(), EncodingGetStored(), EncodingIsValid(), EncodingLogicalToDisplay(), EncodingLogicalToOdbc(), EncodingNormalize(), EncodingSet()
property EnsMessage as EnsLib.HL7.Message;
Property methods: EnsMessageGet(), EnsMessageGetObject(), EnsMessageGetObjectId(), EnsMessageGetStored(), EnsMessageGetSwizzled(), EnsMessageIsValid(), EnsMessageNewObject(), EnsMessageSet(), EnsMessageSetObject(), EnsMessageSetObjectId(), EnsMessageUnSwizzle()
property Filtered as %Boolean [ InitialExpression = 0 ];
Property methods: FilteredDisplayToLogical(), FilteredGet(), FilteredGetStored(), FilteredIsValid(), FilteredLogicalToDisplay(), FilteredNormalize(), FilteredSet()
property Hash as %String;
Property methods: HashDisplayToLogical(), HashGet(), HashGetStored(), HashIsValid(), HashLogicalToDisplay(), HashLogicalToOdbc(), HashNormalize(), HashSet()
property Mate as %Integer;
Generated Target Message related to the source, for re-processing purposes to be able to replace item
Property methods: MateDisplayToLogical(), MateGet(), MateGetStored(), MateIsValid(), MateLogicalToDisplay(), MateNormalize(), MateSet()
property PlainHash as %String);
Property methods: PlainHashDisplayToLogical(), PlainHashGet(), PlainHashGetStored(), PlainHashIsValid(), PlainHashLogicalToDisplay(), PlainHashLogicalToOdbc(), PlainHashNormalize(), PlainHashSet()
property ReceivingApplication as %String);
Property methods: ReceivingApplicationDisplayToLogical(), ReceivingApplicationGet(), ReceivingApplicationGetStored(), ReceivingApplicationIsValid(), ReceivingApplicationLogicalToDisplay(), ReceivingApplicationLogicalToOdbc(), ReceivingApplicationNormalize(), ReceivingApplicationSet()
property ReceivingFacility as %String);
Property methods: ReceivingFacilityDisplayToLogical(), ReceivingFacilityGet(), ReceivingFacilityGetStored(), ReceivingFacilityIsValid(), ReceivingFacilityLogicalToDisplay(), ReceivingFacilityLogicalToOdbc(), ReceivingFacilityNormalize(), ReceivingFacilitySet()
property RunIdentifier as %String [ InitialExpression = $J ];
Property methods: RunIdentifierDisplayToLogical(), RunIdentifierGet(), RunIdentifierGetStored(), RunIdentifierIsValid(), RunIdentifierLogicalToDisplay(), RunIdentifierLogicalToOdbc(), RunIdentifierNormalize(), RunIdentifierSet()
relationship Segments as array of Segment [ InitialExpression = $listbuild("HS.InteropTools.HL7.Compare.Segment","Message",+$this,"children",1,1) , Transient , Inverse = Message , Cardinality = children ];
Property methods: SegmentsGet(), SegmentsGetObject(), SegmentsGetObjectId(), SegmentsGetSwizzled(), SegmentsIsEmpty(), SegmentsIsValid(), SegmentsNewObject(), SegmentsRClose(), SegmentsRExec(), SegmentsRFetch(), SegmentsRelate(), SegmentsSQLCompute(), SegmentsSet(), SegmentsUnRelate()
property SendingApplication as %String);
Property methods: SendingApplicationDisplayToLogical(), SendingApplicationGet(), SendingApplicationGetStored(), SendingApplicationIsValid(), SendingApplicationLogicalToDisplay(), SendingApplicationLogicalToOdbc(), SendingApplicationNormalize(), SendingApplicationSet()
property SendingFacility as %String);
Property methods: SendingFacilityDisplayToLogical(), SendingFacilityGet(), SendingFacilityGetStored(), SendingFacilityIsValid(), SendingFacilityLogicalToDisplay(), SendingFacilityLogicalToOdbc(), SendingFacilityNormalize(), SendingFacilitySet()
property ServiceOperation as %String);
Concatenation of Service and Operation names used primarily with production validation to match messaages
Property methods: ServiceOperationDisplayToLogical(), ServiceOperationGet(), ServiceOperationGetStored(), ServiceOperationIsValid(), ServiceOperationLogicalToDisplay(), ServiceOperationLogicalToOdbc(), ServiceOperationNormalize(), ServiceOperationSet()
property SessionID as %Integer;
For Update cases where we know the session id, easier to track
Property methods: SessionIDDisplayToLogical(), SessionIDGet(), SessionIDGetStored(), SessionIDIsValid(), SessionIDLogicalToDisplay(), SessionIDNormalize(), SessionIDSet()

Methods

method %OnAddToSaveSet(depth As %Library.Integer = 3, insert As %Library.Integer = 0, callcount As %Library.Integer = 0) as %Status
Inherited description: This callback method is invoked when the current object is added to the SaveSet, either because %Save() was invoked on this object or on an object that references this object. %OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking %AddToSaveSet or remove objects by calling %RemoveFromSaveSet.

If this method returns an error status then %Save() will fail and the transaction will be rolled back.

method %OnNew(pValue="") as %Status
Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Indexes

index ($Message on ) [Extent, Type = bitmap];
index (ControlIDIndex on ControlID,RunIdentifier);
Index methods: ControlIDIndexExists()
index (FilteredIndex on Filtered) [Type = bitmap];
index (HashIndex on Hash);
Index methods: HashIndexExists()
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
index (MateIndex on Mate);
Index methods: MateIndexExists()
index (RunIdentifierIndex on RunIdentifier) [Type = bitmap];
index (SOSIndex on RunIdentifier,ServiceOperation,SessionID) [Data = Filtered];
Index for ServiceOperationSession processing
Index methods: SOSIndexExists()
index (ServiceOperationIndex on ServiceOperation);
Index methods: ServiceOperationIndexExists()
index (SessionIDIndex on SessionID);
Index methods: SessionIDIndexExists()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.InteropTools.HL7.Compare.Message)

^HS.IT.Comp.MessageD(ID)
=
%%CLASSNAME
Encoding
SendingApplication
SendingFacility
ReceivingApplication
ReceivingFacility
DocumentType
ControlID
Hash
PlainHash
SessionID
RunIdentifier
Filtered
Stream
EnsMessage
ServiceOperation
Mate
FeedbackOpens in a new tab