Skip to main content

HS.Message.ViewerDocumentFetchRequest

persistent class HS.Message.ViewerDocumentFetchRequest extends HS.Message.ECRFetchRequest

SQL Table Name: HS_Message.ViewerDocumentFetchRequest

Property Inventory

Parameters

parameter RESPONSECLASSNAME = HS.Message.PatientFetchResponse;
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 Gateway as HS.Types.EndPoint;
Property methods: GatewayDisplayToLogical(), GatewayGet(), GatewayGetStored(), GatewayIsValid(), GatewayLogicalToDisplay(), GatewayLogicalToOdbc(), GatewayNormalize(), GatewaySet()
property HomeCommunity as %String;
Coded entry for HomeCommunityOID
Property methods: HomeCommunityDisplayToLogical(), HomeCommunityGet(), HomeCommunityGetStored(), HomeCommunityIsValid(), HomeCommunityLogicalToDisplay(), HomeCommunityLogicalToOdbc(), HomeCommunityNormalize(), HomeCommunitySet()
property HomeCommunityOID as %String;
The OID value for the Home Community
Property methods: HomeCommunityOIDDisplayToLogical(), HomeCommunityOIDGet(), HomeCommunityOIDGetStored(), HomeCommunityOIDIsValid(), HomeCommunityOIDLogicalToDisplay(), HomeCommunityOIDLogicalToOdbc(), HomeCommunityOIDNormalize(), HomeCommunityOIDSet()
property Query as %Boolean [ InitialExpression = 0 ];
This property is set only when the request is being created by the HS.UI.IHE.DocumentViewerQuery class to support document display for Query based Edges
Property methods: QueryDisplayToLogical(), QueryGet(), QueryGetStored(), QueryIsValid(), QueryLogicalToDisplay(), QueryLogicalToXSD(), QueryNormalize(), QuerySet(), QueryXSDToLogical()

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

Storage Model: Storage (HS.Message.ViewerDocumentFetchRequest)

^Ens.MessageBodyD(ID,"ViewerDocumentFetchRequest")
=
Gateway
HomeCommunity
HomeCommunityOID
Query
FeedbackOpens in a new tab