Skip to main content


persistent class HS.IHE.PIX.Manager.DomainsOfInterest extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_IHE_PIX_Manager.DomainsOfInterest

Map OID to facility / endpoint

Property Inventory

Method Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
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 AllDomains as %Boolean [ InitialExpression = 1 ];
If true, any domain update will be sent and the Domains list will be ignored
Property methods: AllDomainsDisplayToLogical(), AllDomainsGet(), AllDomainsGetStored(), AllDomainsIsValid(), AllDomainsLogicalToDisplay(), AllDomainsLogicalToXSD(), AllDomainsNormalize(), AllDomainsSet(), AllDomainsXSDToLogical()
property ConsumerID as %String) [ Required ];
Code for OID of the Consumer interested in notification ie PIXv3ConsumerDevice
Property methods: ConsumerIDDisplayToLogical(), ConsumerIDGet(), ConsumerIDGetStored(), ConsumerIDIsValid(), ConsumerIDLogicalToDisplay(), ConsumerIDLogicalToOdbc(), ConsumerIDNormalize(), ConsumerIDSet()
property Domains as list of %String (STORAGEDEFAULT = "array");
Code for OID of the Domain as in External, CGH, etc
Property methods: DomainsBuildValueArray(), DomainsCollectionToDisplay(), DomainsCollectionToOdbc(), DomainsDisplayToCollection(), DomainsDisplayToLogical(), DomainsGet(), DomainsGetObject(), DomainsGetObjectId(), DomainsGetStored(), DomainsGetSwizzled(), DomainsIsValid(), DomainsLogicalToDisplay(), DomainsLogicalToOdbc(), DomainsNormalize(), DomainsOdbcToCollection(), DomainsSet(), DomainsSetObject(), DomainsSetObjectId()
property RegisteredPatientsOnly as %Boolean [ InitialExpression = 0 ];
If true, send all domain updates if and only if the patient has an MRN in one of the Assigning Authorities listed in Domains
Property methods: RegisteredPatientsOnlyDisplayToLogical(), RegisteredPatientsOnlyGet(), RegisteredPatientsOnlyGetStored(), RegisteredPatientsOnlyIsValid(), RegisteredPatientsOnlyLogicalToDisplay(), RegisteredPatientsOnlyLogicalToXSD(), RegisteredPatientsOnlyNormalize(), RegisteredPatientsOnlySet(), RegisteredPatientsOnlyXSDToLogical()


classmethod ConsumerFound(pConsumer, pID) as %Boolean
classmethod ConsumersToNotify(pDomain As %String, ByRef pConsumerOIDs As %String, ByRef pRegisteredOnlyConsumers As %String) as %Status
classmethod IDForConsumer(pConsumer) as %String
classmethod RegisteredOnlyConsumers(pIdentifiers As %Library.ListOfDataTypes, ByRef pRegisteredOnlyConsumers As %String) as %Status
Given a list of identifiers, outputs a list of consumer IDs for consumers. Returns a consumer ID if at least one domain from the list of identifiers matches a domain from the consumer's Domains property, and the consumer has RegisteredPatientsOnly=1.
This method should be called before ConsumersToNotify, with pRegisteredConsumers should be passed as input to the latter method.


query AvailableConsumers()
SQL Query:
select OIDMapCode from HS_registry_service.abstract_oidmapcode where abstract->devicefunction='PIXv3.Consumer' or abstract->devicefunction='PIXv2.Consumer' and element_key='Device'
query QueryConsumers()
SQL Query:
SELECT %ID,ConsumerID FROM DomainsOfInterest


index ($DomainsOfInterest on ) [Extent, Type = bitmap];
index (AllDomainsIndex on AllDomains) [Type = bitmap];
index (DomainsIndex on Domains(ELEMENTS));
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.IHE.PIX.Manager.DomainsOfInterest)


Storage Model: Storage (HS.IHE.PIX.Manager.DomainsOfInterest)

FeedbackOpens in a new tab