Skip to main content


persistent class HS.Message.PrefetchRequest extends HS.Util.EnsRequest

SQL Table Name: HS_Message.PrefetchRequest

This can be used where one or more edges are of CacheType NotifyAndQuery or ExpireAndQuery, to tell the system that someone is planning to fetch the record, so that it will queue it up for an external query via the background QueryTask. When invoked externally, the caller will usually send just the MPIID and a priority If the MPIID is not known, then can send the facility, MRN, and assigning authority, and the system will look up the MPIID. This message is also used internally, once we have identified all of the records associated with the MPIID. For each record, it is sent to the appropriate edge, along with the facility, MRN, and assigning authority

Property Inventory


parameter XMLIGNORENULL = inputonly;
Inherited description: 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.


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 Gateway as HS.Types.EndPoint;
the gateway where the request is being sent (used internally as we pass the request along)
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property MPIID as %String;
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 Priority as %Integer [ InitialExpression = 1 ];
This should be a single digit between 1 and 9, which will be used to determine the order in which the background query task fetches these. 1 is the best priority.
Property methods: PriorityDisplayToLogical(), PriorityGet(), PriorityGetStored(), PriorityIsValid(), PriorityLogicalToDisplay(), PriorityNormalize(), PrioritySet(), PriorityXSDToLogical()

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

FeedbackOpens in a new tab