Skip to main content


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

SQL Table Name: HS_Message.SearchAndFetchRequest

Property Inventory


parameter RESPONSECLASSNAME = HS.Message.SearchAndFetchResponse;
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.


property AllowIncompleteResult as %String (DISPLAYLIST = ",Allow,Disallow", VALUELIST = ",allow,disallow");
If any of the fetches return an error, do we return an error, or the aggregation of all of the sucessful fetches. If not null, this value overrides the setting of the same name in HS.Gateway.Access.QueryProcess.
Property methods: AllowIncompleteResultDisplayToLogical(), AllowIncompleteResultGet(), AllowIncompleteResultGetStored(), AllowIncompleteResultIsValid(), AllowIncompleteResultLogicalToDisplay(), AllowIncompleteResultLogicalToOdbc(), AllowIncompleteResultNormalize(), AllowIncompleteResultSet()
property AnalyticsID as %String;
For search by Analytics ID - only valid in "user" searchmode, with consent
Property methods: AnalyticsIDDisplayToLogical(), AnalyticsIDGet(), AnalyticsIDGetStored(), AnalyticsIDIsValid(), AnalyticsIDLogicalToDisplay(), AnalyticsIDLogicalToOdbc(), AnalyticsIDNormalize(), AnalyticsIDSet()
property AssigningAuthority as %String;
Assigning Authority for the MRN
Property methods: AssigningAuthorityDisplayToLogical(), AssigningAuthorityGet(), AssigningAuthorityGetStored(), AssigningAuthorityIsValid(), AssigningAuthorityLogicalToDisplay(), AssigningAuthorityLogicalToOdbc(), AssigningAuthorityNormalize(), AssigningAuthoritySet()
property CallCompositeView as %Boolean [ InitialExpression = 1 ];
Flag indicating whether or not to call composite view to get demographics while searching for patient later Default as 1 and only gets disabled in very specific cases (in push notification cases to avoid racing condition at MPI engine)
Property methods: CallCompositeViewDisplayToLogical(), CallCompositeViewGet(), CallCompositeViewGetStored(), CallCompositeViewIsValid(), CallCompositeViewLogicalToDisplay(), CallCompositeViewLogicalToXSD(), CallCompositeViewNormalize(), CallCompositeViewSet(), CallCompositeViewXSDToLogical()
property CustomOperation as %String;
Custom operation for document creation
Property methods: CustomOperationDisplayToLogical(), CustomOperationGet(), CustomOperationGetStored(), CustomOperationIsValid(), CustomOperationLogicalToDisplay(), CustomOperationLogicalToOdbc(), CustomOperationNormalize(), CustomOperationSet()
property Filters as HS.Types.Filters;
Optional filters
Property methods: FiltersGet(), FiltersGetObject(), FiltersGetObjectId(), FiltersGetStored(), FiltersGetSwizzled(), FiltersIsEmpty(), FiltersIsValid(), FiltersNewObject(), FiltersSet(), FiltersSetObject(), FiltersSetObjectId(), FiltersUnSwizzle()
property Format as %String [ InitialExpression = "SDA" ];
Currently supported: SDA, HTML, PDF, CUSTOM, and all of the entries in the XML Summary Type Registry. (HealthShare Management Portal > Registry > Other Management > XML Summary Types)
PDF is only supported if an XSL-FO renderer is installed, such as RenderX or FOP.
Property methods: FormatDisplayToLogical(), FormatGet(), FormatGetStored(), FormatIsValid(), FormatLogicalToDisplay(), FormatLogicalToOdbc(), FormatNormalize(), FormatSet()
property IgnoreSecondaryMPI as %Boolean [ InitialExpression = 0 ];
Once the request gets to the Hub do we also want to query the secondary MPI operations if this is coming in from another system we do not want to query out.
Property methods: IgnoreSecondaryMPIDisplayToLogical(), IgnoreSecondaryMPIGet(), IgnoreSecondaryMPIGetStored(), IgnoreSecondaryMPIIsValid(), IgnoreSecondaryMPILogicalToDisplay(), IgnoreSecondaryMPILogicalToXSD(), IgnoreSecondaryMPINormalize(), IgnoreSecondaryMPISet(), IgnoreSecondaryMPIXSDToLogical()
property IncludeTimeZoneOffsets as %Integer [ InitialExpression = 0 ];
A flag to govern whether time zone offsets will be present in data fetched from an edge gateway
Property methods: IncludeTimeZoneOffsetsDisplayToLogical(), IncludeTimeZoneOffsetsGet(), IncludeTimeZoneOffsetsGetStored(), IncludeTimeZoneOffsetsIsValid(), IncludeTimeZoneOffsetsLogicalToDisplay(), IncludeTimeZoneOffsetsNormalize(), IncludeTimeZoneOffsetsSet(), IncludeTimeZoneOffsetsXSDToLogical()
property MPIID as %String;
The master/patient index id If this is specified, it will be used instead of the Assigning Authority and MRN
Property methods: MPIIDDisplayToLogical(), MPIIDGet(), MPIIDGetStored(), MPIIDIsValid(), MPIIDLogicalToDisplay(), MPIIDLogicalToOdbc(), MPIIDNormalize(), MPIIDSet()
property MRN as %String;
This patient's MRN (from the above assigning authority)
Property methods: MRNDisplayToLogical(), MRNGet(), MRNGetStored(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property ReportClass as %String;
ReportClass is used for HTML and PDF formats. It identifies a Zen report to apply to the SDA.
Property methods: ReportClassDisplayToLogical(), ReportClassGet(), ReportClassGetStored(), ReportClassIsValid(), ReportClassLogicalToDisplay(), ReportClassLogicalToOdbc(), ReportClassNormalize(), ReportClassSet()
property ReportCode as %String [ InitialExpression = "%HS_STD" ];
Alternatively, a Report code can be specified to look up the Zen report to apply to SDA or Summary SDA
Property methods: ReportCodeDisplayToLogical(), ReportCodeGet(), ReportCodeGetStored(), ReportCodeIsValid(), ReportCodeLogicalToDisplay(), ReportCodeLogicalToOdbc(), ReportCodeNormalize(), ReportCodeSet()
property ReturnSDAQuickStream as %Boolean [ InitialExpression = 0 ];
If true, return a quickstream of the SDA generated
Property methods: ReturnSDAQuickStreamDisplayToLogical(), ReturnSDAQuickStreamGet(), ReturnSDAQuickStreamGetStored(), ReturnSDAQuickStreamIsValid(), ReturnSDAQuickStreamLogicalToDisplay(), ReturnSDAQuickStreamLogicalToXSD(), ReturnSDAQuickStreamNormalize(), ReturnSDAQuickStreamSet(), ReturnSDAQuickStreamXSDToLogical()
property SSN as %String (MAXLEN = 220);
Patient's social security or government id (allow long string as hashed SSN can be 100 chars or more)
Property methods: SSNDisplayToLogical(), SSNGet(), SSNGetStored(), SSNIsValid(), SSNLogicalToDisplay(), SSNLogicalToOdbc(), SSNNormalize(), SSNSet()
property SearchMode as %String (DISPLAYLIST = ",User,Admin", VALUELIST = ",user,admin") [ InitialExpression = "user" ];
Search modes user - regular patient lookup, admin - mpi patient lookup no consent applied
Property methods: SearchModeDisplayToLogical(), SearchModeGet(), SearchModeGetStored(), SearchModeIsValid(), SearchModeLogicalToDisplay(), SearchModeLogicalToOdbc(), SearchModeNormalize(), SearchModeSet()
property TranslationProfile as %String;
The name (uppercase code) of a translation profile to use when exporting the data
Property methods: TranslationProfileDisplayToLogical(), TranslationProfileGet(), TranslationProfileGetStored(), TranslationProfileIsValid(), TranslationProfileLogicalToDisplay(), TranslationProfileLogicalToOdbc(), TranslationProfileNormalize(), TranslationProfileSet()
property WaitPeriod as %Integer [ InitialExpression = 50000 ];
How long to wait for fetch operations to complete (in milliseconds)
Property methods: WaitPeriodDisplayToLogical(), WaitPeriodGet(), WaitPeriodGetStored(), WaitPeriodIsValid(), WaitPeriodLogicalToDisplay(), WaitPeriodNormalize(), WaitPeriodSet(), WaitPeriodXSDToLogical()
property WaitTimeoutError as %Boolean [ InitialExpression = 1 ];
If the wait period expires and some requests are still pending, do we abort them and return an error status for those requests
Property methods: WaitTimeoutErrorDisplayToLogical(), WaitTimeoutErrorGet(), WaitTimeoutErrorGetStored(), WaitTimeoutErrorIsValid(), WaitTimeoutErrorLogicalToDisplay(), WaitTimeoutErrorLogicalToXSD(), WaitTimeoutErrorNormalize(), WaitTimeoutErrorSet(), WaitTimeoutErrorXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods


Gray indicates storage defined by superclasses.

Storage Model: Storage (Ens.MessageBody)


Storage Model: Storage (HS.Util.EnsRequest)


Storage Model: Storage (HS.Message.SearchAndFetchRequest)


Storage Model: Storage (HS.Message.SearchAndFetchRequest)


Storage Model: Storage (HS.Message.SearchAndFetchRequest)

FeedbackOpens in a new tab