Home > Class Reference > HSLIB namespace > HS.Push.Registry.Recipient


persistent class HS.Push.Registry.Recipient extends %Library.Persistent, HS.Util.DataModel.Adaptor, %XML.Adaptor, HS.Util.CopyFrom

SQL Table Name: HS_Push_Registry.Recipient

Used for system recipients, and extended by the person.user registry for user type recipients

Property Inventory

Method Inventory


parameter RESOURCE;
For users as recipients, security is managed in HS.Registry.User.Person. For recipients in general (e.g., systems), hub management is required.
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 Active as %Boolean [ InitialExpression = 1 ];
Set to True to prevent recipient from being selected
Property methods: ActiveDisplayToLogical(), ActiveGet(), ActiveGetStored(), ActiveIsValid(), ActiveLogicalToDisplay(), ActiveLogicalToXSD(), ActiveNormalize(), ActiveSet(), ActiveXSDToLogical()
property Description as %String;
Description of clinician
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Name as %String;
Recipient Name
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIdxExists(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Roles as list of %String (MAXLEN = 64);
%HS* domains, copied from Security.Users Include special consent-group roles (HSGROUP*) Roles assigned to the recipient
Property methods: RolesBuildValueArray(), RolesCollectionToDisplay(), RolesCollectionToOdbc(), RolesDisplayToCollection(), RolesDisplayToLogical(), RolesGet(), RolesGetObject(), RolesGetObjectId(), RolesGetStored(), RolesGetSwizzled(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesOdbcToCollection(), RolesSet(), RolesSetObject(), RolesSetObjectId()
property Type as %String (DISPLAYLIST = ",System,Clinician,User", VALUELIST = ",S,C,U", ZENREADONLY = 1);
Whether a Receiving System or Clinician
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()


method GetExistingData(Output pId As %String) as %Status [ Language = objectscript ]
classmethod ListReceivingSystemsClose(ByRef qHandle As %Binary) as %Status [ Language = objectscript ]
classmethod ListReceivingSystemsExecute(ByRef qHandle As %Binary, pActiveOnly As %Boolean = 1, pName As %String = "", pDelivery As %Boolean) as %Status [ Language = objectscript ]
classmethod ListReceivingSystemsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status [ Language = objectscript ]


query ListReceivingSystems(pActiveOnly As %String, pName As %String = "", pDelivery As %Boolean = 0)
Selects ID As %String, Name As %String, Description As %String, Active As %Boolean
List receiving systems via web service call


index (NameIdx on Type,Name);
Name index
Index methods: NameIdxExists()

Inherited Members

Inherited Properties

Inherited Methods


Storage Model: Storage (HS.Push.Registry.Recipient)



FeedbackOpens in a new window