Skip to main content

HS.Message.ECRFetchRequest

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

SQL Table Name: HS_Message.ECRFetchRequest

Property Inventory

Parameters

parameter RESPONSECLASSNAME = HS.Message.ECRFetchResponse;
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 AssigningAuthority as HS.HC.DataType.AssignAuthName;
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 Filters as HS.Types.Filters;
Optional filters. If none, set Filters="" for max performance
Property methods: FiltersGet(), FiltersGetObject(), FiltersGetObjectId(), FiltersGetStored(), FiltersGetSwizzled(), FiltersIsEmpty(), FiltersIsValid(), FiltersNewObject(), FiltersSet(), FiltersSetObject(), FiltersSetObjectId(), FiltersUnSwizzle()
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 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 (MAXLEN = 220);
Patient MPI ID
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 UseFilters as %Integer [ InitialExpression = 0 ];
Enable Filters. This is for performance, but you must set this to 1 if you wish to use the Filters, else they will be ignored
Property methods: UseFiltersDisplayToLogical(), UseFiltersGet(), UseFiltersGetStored(), UseFiltersIsValid(), UseFiltersLogicalToDisplay(), UseFiltersNormalize(), UseFiltersSet(), UseFiltersXSDToLogical()

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

Subclasses

FeedbackOpens in a new tab