HS.Message.PatientFetchRequestAsync
persistent class HS.Message.PatientFetchRequestAsync extends HS.Message.ECRFetchRequest
SQL Table Name: HS_Message.PatientFetchRequestAsync
Property Inventory
- ECRTarget
- EdgeSession
- Gateway
- GatewayOperations
- InstanceGUID
- ReturnGateway
- Sequence
- Token
- UseParallelFetch
Method 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 ECRTarget as Ens.DataType.ConfigName [ InitialExpression = "HS.Gateway.ECR.Manager" ];
Destination for any ECR requests we service - passed in from target on web service
Property methods: ECRTargetDisplayToLogical(), ECRTargetGet(), ECRTargetGetStored(), ECRTargetIsValid(), ECRTargetLogicalToDisplay(), ECRTargetLogicalToOdbc(), ECRTargetNormalize(), ECRTargetParseConfigNameSpec(), ECRTargetSet()
property EdgeSession as %Integer;
If UseParallelFetch is true, this is set by the ECR process
Property methods: EdgeSessionDisplayToLogical(), EdgeSessionGet(), EdgeSessionGetStored(), EdgeSessionIsValid(), EdgeSessionLogicalToDisplay(), EdgeSessionNormalize(), EdgeSessionSet(), EdgeSessionXSDToLogical()
property Gateway as HS.Types.EndPoint;
the gateway where the request is being sent
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property GatewayOperations as Ens.DataType.ConfigName [ InitialExpression = "GATEWAY" ];
Name of the Gateway Remote Operations component in this production - passed in from target on web service
Should be the name of a business host that performs actual communications with the Access Gateway Web service, via SOAP messages.
Property methods: GatewayOperationsDisplayToLogical(), GatewayOperationsGet(), GatewayOperationsGetStored(), GatewayOperationsIsValid(), GatewayOperationsLogicalToDisplay(), GatewayOperationsLogicalToOdbc(), GatewayOperationsNormalize(), GatewayOperationsParseConfigNameSpec(), GatewayOperationsSet()
property InstanceGUID as %String;
For UseParallelFetch, this is the instance GUID of the access gateway
We check this on the edge to determine if we're on the same instance
Property methods: InstanceGUIDDisplayToLogical(), InstanceGUIDGet(), InstanceGUIDGetStored(), InstanceGUIDIsValid(), InstanceGUIDLogicalToDisplay(), InstanceGUIDLogicalToOdbc(), InstanceGUIDNormalize(), InstanceGUIDSet()
property ReturnGateway as HS.Types.EndPoint;
the (access) gateway where the data will get returned
Property methods: ReturnGatewayDisplayToLogical(), ReturnGatewayGet(), ReturnGatewayGetStored(), ReturnGatewayIsValid(), ReturnGatewayLogicalToDisplay(), ReturnGatewayLogicalToOdbc(), ReturnGatewayNormalize(), ReturnGatewaySet()
property Sequence as %Integer;
the sequence number assigned to this async fetch batch, on the return gateway
Property methods: SequenceDisplayToLogical(), SequenceGet(), SequenceGetStored(), SequenceIsValid(), SequenceLogicalToDisplay(), SequenceNormalize(), SequenceSet(), SequenceXSDToLogical()
property Token as %String);
The token used to store the patient in the viewer cache
This will be null if we're only aggregating, and not using the viewer
Property methods: TokenDisplayToLogical(), TokenGet(), TokenGetStored(), TokenIsValid(), TokenLogicalToDisplay(), TokenLogicalToOdbc(), TokenNormalize(), TokenSet()
property UseParallelFetch as %Boolean [ InitialExpression = 0 ];
This is copied from the access gateway production setting
Property methods: UseParallelFetchDisplayToLogical(), UseParallelFetchGet(), UseParallelFetchGetStored(), UseParallelFetchIsValid(), UseParallelFetchLogicalToDisplay(), UseParallelFetchLogicalToXSD(), UseParallelFetchNormalize(), UseParallelFetchSet(), UseParallelFetchXSDToLogical()
Methods
method ApplyFilters()
Inherited Members
Inherited Properties
- %ClearFields
- %id
- %seriesCount
- %seriesNames
- %source
- AdditionalInfo
- AssigningAuthority
- AuthBy
- AuthRole
- AuthType
- BTGReason
- BreakTheGlass
- ClinicalTypes
- Consent
- CustomAuditInfo
- Facility
- Filters
- HSCoreVersion
- HSMinVersion
- Identifiers
- IncludeTimeZoneOffsets
- MPIID
- MRN
- RequestId
- RequestingForProxyID
- RequestingForProxyUserID
- RequestingGateway
- RequestingUser
- RequestingUserRoles
- SAMLData
- Signature
- Type
- UseFilters
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %CompareContents()
- %ComposeOid()
- %ConstructClone()
- %CreateModelInstance()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DeleteModel()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DrawHTMLForm()
- %DrawHTMLTable()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetContentType()
- %GetJSValidationCode()
- %GetLock()
- %GetParameter()
- %GetPropertyInfo()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %InvokeAction()
- %IsA()
- %IsModified()
- %IsNull()
- %IsReadOnly()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnCopyDataFromModel()
- %OnCopyDataToModel()
- %OnDeleteFinally()
- %OnDeleteModel()
- %OnDeleteSource()
- %OnDetermineClass()
- %OnGetPropertyInfo()
- %OnInvokeAction()
- %OnLoadModel()
- %OnNewSource()
- %OnOpenFinally()
- %OnOpenSource()
- %OnSaveFinally()
- %OnSaveSource()
- %OnStoreModel()
- %OnSubmit()
- %OnTimeout()
- %Open()
- %OpenId()
- %OpenModel()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %ProcessSubmit()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SaveModel()
- %SerializeObject()
- %SetModified()
- %ShowContents()
- %ShowContentsHead()
- %SortBegin()
- %SortEnd()
- %SubmitHandler()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- CopyFrom()
- GetStatsDimension()
- GetUserInfo()
- NewResponse()
- RequestInfoToXMLMessage()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLMessageToRequestInfo()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
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.ECRFetchRequest)
^Ens.MessageBodyD(ID,"HS.Message.ECRFetchRequest.AdditionalInfo",n) |
= | AdditionalInfo(n) |
Storage Model: Storage (HS.Message.ECRFetchRequest)
^Ens.MessageBodyD(ID,"HS.Message.ECRFetchRequest.CustomAuditInfo",n) |
= | CustomAuditInfo(n) |
Storage Model: Storage (HS.Message.ECRFetchRequest)
^Ens.MessageBodyD(ID,"ECRFetchRequest") |
= | AuthBy
AuthType
BTGReason
MRN
AssigningAuthority
Filters
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
Facility
RequestingUser
RequestingUserRoles
Signature
UseFilters
RequestingForProxyUserID
RequestingForProxyID
MPIID
SAMLData
Identifiers
IncludeTimeZoneOffsets
AuthRole
|
Storage Model: Storage (HS.Message.PatientFetchRequestAsync)
^Ens.MessageBodyD(ID,"HS.Message.PatientFetchRequestAsync.AdditionalInfo",n) |
= | AdditionalInfo(n) |
Storage Model: Storage (HS.Message.PatientFetchRequestAsync)
^Ens.MessageBodyD(ID,"PatientFetchRequestAsync") |
= | Gateway
ReturnGateway
Sequence
Token
ECRTarget
GatewayOperations
AggregateOnly
UseParallelFetch
EdgeSession
InstanceGUID
|