Skip to main content

HS.Message.PatientBatchFetchRequestAsync

persistent class HS.Message.PatientBatchFetchRequestAsync extends HS.Util.EnsRequest, HS.Types.PatientInfo, HS.Types.RequestInfo

SQL Table Name: HS_Message.PatientBatchFetchRequestAsync

Property Inventory

Method Inventory

Parameters

parameter RESPONSECLASSNAME = Ens.Response;
Default response class
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 AggregateOnly as %Boolean [ InitialExpression = 0 ];
Are we just aggregating, or are we also inserting data into the viewer If this is set to 0, in addition to aggregating data, it will insert it into the viewer cache. If you only want to aggregate, set this to 1
Property methods: AggregateOnlyDisplayToLogical(), AggregateOnlyGet(), AggregateOnlyGetStored(), AggregateOnlyIsValid(), AggregateOnlyLogicalToDisplay(), AggregateOnlyLogicalToXSD(), AggregateOnlyNormalize(), AggregateOnlySet(), AggregateOnlyXSDToLogical()
property ConsentApplied as %Boolean [ InitialExpression = 0 ];
Have any MRNs been filtered out by consent
Property methods: ConsentAppliedDisplayToLogical(), ConsentAppliedGet(), ConsentAppliedGetStored(), ConsentAppliedIsValid(), ConsentAppliedLogicalToDisplay(), ConsentAppliedLogicalToXSD(), ConsentAppliedNormalize(), ConsentAppliedSet(), ConsentAppliedXSDToLogical()
property Requests as list of HS.Message.PatientFetchRequestAsync;
Property methods: RequestsBuildValueArray(), RequestsCollectionToDisplay(), RequestsCollectionToOdbc(), RequestsDisplayToCollection(), RequestsGet(), RequestsGetObject(), RequestsGetObjectId(), RequestsGetStored(), RequestsGetSwizzled(), RequestsIsValid(), RequestsOdbcToCollection(), RequestsSet(), RequestsSetObject(), RequestsSetObjectId()
property SessionId as %String (MAXLEN = 128);
Session ID for filing data
Property methods: SessionIdDisplayToLogical(), SessionIdGet(), SessionIdGetStored(), SessionIdIsValid(), SessionIdLogicalToDisplay(), SessionIdLogicalToOdbc(), SessionIdNormalize(), SessionIdSet()

Methods

classmethod OnDeleteHandler(pID) as %Status

Triggers

trigger OnDeleteSQL (BEFORE event DELETE);

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.PatientBatchFetchRequestAsync)

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

Storage Model: Storage (HS.Message.PatientBatchFetchRequestAsync)

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

Storage Model: Storage (HS.Message.PatientBatchFetchRequestAsync)

^Ens.MessageBodyD(ID,"PatientBatchFetchRequestAsync")
=
AuthBy
AuthType
BTGReason
RequestingUser
RequestingUserRoles
RequestingForProxyUserID
RequestingForProxyID
Signature
RequestId
RequestingGateway
Type
BreakTheGlass
ClinicalTypes
Consent
Requests
SessionId
Facility
AssigningAuthority
FirstName
MPIID
ControlledIDList
Identifiers
DOB
Street
City
State
Zip
SSN
Telephone
BusinessPhone
Race
CityOfBirth
DriversLicenseNumber
MothersMaidenSurname
BirthOrder
BirthPlace
MaritalStatus
ReligiousAffiliation
EthnicGroup
Language
VIP
Telecoms
Addresses
LastName
MRN
MiddleName
Prefix
Sex
Suffix
Names
AggregateOnly
SAMLData
CustomClassName
CustomXMLString
CommunicationPreference
CreatedBy
CreatedOn
LastEnteredBy
LastEnteredOn
DeathTime
FathersName
MothersName
SpousesName
DeathStatus
Extension
ConsentApplied
County
Country
SexDescription
AuthRole

Subclasses

FeedbackOpens in a new tab