Home > Class Reference > HSLIB namespace > HS.Message.ECRQueryRequest

HS.Message.ECRQueryRequest

persistent class HS.Message.ECRQueryRequest extends HS.Util.EnsRequest, HS.Types.RequestInfo

SQL Table Name: HS_Message.ECRQueryRequest

Property Inventory

Parameters

parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property Activity as %Boolean;
If the context in which this request is used it for patient activity (fetching an SDA for viewing, etc.), then this will be set to True. It interacts with the ECR Manager setting ScheduleQueryRefresh
Property methods: ActivityDisplayToLogical(), ActivityGet(), ActivityGetStored(), ActivityIsValid(), ActivityLogicalToDisplay(), ActivityLogicalToXSD(), ActivityNormalize(), ActivitySet(), ActivityXSDToLogical()
property AssigningAuthority as %String;
Assigning Authority for the MRN
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityGetStored(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property Facility as HS.Types.Facility;
Facility for the record we're fetching
Property methods: FacilityDisplayToLogical(), FacilityGet(), FacilityGetStored(), FacilityIsValid(), FacilityLogicalToDisplay(), FacilityLogicalToOdbc(), FacilityNormalize(), FacilitySet()
property Identifiers as list of HS.Types.Identifier (STORAGEDEFAULT = "list");
Other identifiers with assigning authority
Property methods: IdentifiersBuildValueArray(), IdentifiersCollectionToDisplay(), IdentifiersCollectionToOdbc(), IdentifiersDisplayToCollection(), IdentifiersGet(), IdentifiersGetObject(), IdentifiersGetObjectId(), IdentifiersGetStored(), IdentifiersGetSwizzled(), IdentifiersIsValid(), IdentifiersOdbcToCollection(), IdentifiersSet(), IdentifiersSetObject(), IdentifiersSetObjectId()
property LastResponseString as %String);
This is a message returned by the external system when we last queried this record, which is being passed for this query, so that they can give us selective updates. It typically would have some sort of timestamp. For CacheType=NotifyAndQuery or ExpireAndQuery
Property methods: LastResponseStringDisplayToLogical(), LastResponseStringGet(), LastResponseStringGetStored(), LastResponseStringIsValid(), LastResponseStringLogicalToDisplay(), LastResponseStringLogicalToOdbc(), LastResponseStringNormalize(), LastResponseStringSet()
property MPIID as %String;
MPIID of the record we're fetching
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDGetStored(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property MRN as HS.Types.MRN;
Patient MRN / Identitifier
Property methods: MRNDisplayToLogical(), MRNGet(), MRNGetStored(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property Notifications as list of %String);
For a NotifyAndQuery type edge. This contains a list of all of the Notification properties that have been received on ECRUpdateRequests sent by the data source since the last time an ECRQueryRequest has been completed. This is a handswhaking mechanism to allow a NotifyAndQuery source to send only incremental updates.
Property methods: NotificationsBuildValueArray(), NotificationsCollectionToDisplay(), NotificationsCollectionToOdbc(), NotificationsDisplayToCollection(), NotificationsDisplayToLogical(), NotificationsGet(), NotificationsGetObject(), NotificationsGetObjectId(), NotificationsGetStored(), NotificationsGetSwizzled(), NotificationsIsValid(), NotificationsLogicalToDisplay(), NotificationsLogicalToOdbc(), NotificationsNormalize(), NotificationsOdbcToCollection(), NotificationsSet(), NotificationsSetObject(), NotificationsSetObjectId()
property TempAggregationKey as %String;
Used for pure query edges
Property methods: TempAggregationKeyDisplayToLogical(), TempAggregationKeyGet(), TempAggregationKeyGetStored(), TempAggregationKeyIsValid(), TempAggregationKeyLogicalToDisplay(), TempAggregationKeyLogicalToOdbc(), TempAggregationKeyNormalize(), TempAggregationKeySet()

Inherited Members

Inherited Properties

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)

^Ens.MessageBodyD(ID)
=
%%CLASSNAME

Storage Model: Storage (HS.Util.EnsRequest)

^Ens.MessageBodyD(ID,"EnsRequest")
=
HSCoreVersion
HSMinVersion
%ClearFields

Storage Model: Storage (HS.Message.ECRQueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.ECRQueryRequest.AdditionalInfo",n)
=
AdditionalInfo(n)

Storage Model: Storage (HS.Message.ECRQueryRequest)

^Ens.MessageBodyD(ID,"HS.Message.ECRQueryRequest.CustomAuditInfo",n)
=
CustomAuditInfo(n)

Storage Model: Storage (HS.Message.ECRQueryRequest)

^Ens.MessageBodyD(ID,"ECRQueryRequest")
=
AuthBy
AuthType
BTGReason
AssigningAuthority
LastResponseString
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
Facility
MRN
RequestingUser
RequestingUserRoles
Activity
SAMLData
Notifications
MPIID
Identifiers
TempAggregationKey