Skip to main content


persistent class HS.Registry.Person.UserFacility extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Registry_Person.UserFacility

Property Inventory

Method Inventory


parameter DSINTERVAL = 5;
Inherited description: DSINTERVAL is the number of seconds between one DSTIME value and the next. The DSTIME value for DSINTERVAL > 0 is computed from $ZTIMESTAMP and is the number of seconds from day 0, time 0 to the nearest interval, rounded down. Using an interval has the effect of grouping all DSTIME entries for the class in some number of seconds.
parameter DSTIME = AUTO;
Inherited description: If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value for each object will be recorded in a global, ^OBJ.DSTIME:
^OBJ.DSTIME(ExtentName,DSTIME,objectID) = filing operation
For DSTIME=AUTO the DSTIME value is recorded in ^OBJ.DSTIME and is set by the consumer of DSTIME data.
Refer to %DeepSee documentation for more information on how DSTIME is used by %DeepSee.
The filing operations are:

If the DSTIME parameter is set to MANUAL then the user is responsible for journaling object filing operations. If DSTIME is set to "CONDITIONAL", the user is expected to define the parameter DSCONDITION setting it to an expression which will determine if the actions performed when DSTIME is set to AUTO will execute or not
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 FacilityCode as %String (MAXLEN = 256);
Facility Code, IDKEY to Facility Table. MAXLEN taken from HS.Facility.Config.
Property methods: FacilityCodeDisplayToLogical(), FacilityCodeGet(), FacilityCodeGetStored(), FacilityCodeIsValid(), FacilityCodeLogicalToDisplay(), FacilityCodeLogicalToOdbc(), FacilityCodeNormalize(), FacilityCodeSet()
property PrimaryFlag as %Boolean;
One facilioty for the user is designated as primary
Property methods: PrimaryFlagDisplayToLogical(), PrimaryFlagGet(), PrimaryFlagGetStored(), PrimaryFlagIsValid(), PrimaryFlagLogicalToDisplay(), PrimaryFlagLogicalToXSD(), PrimaryFlagNormalize(), PrimaryFlagSet(), PrimaryFlagXSDToLogical()
property Roles as list of %String (MAXLEN = 64);
Aditional Roles assigned to the user by that facility
Property methods: RolesBuildValueArray(), RolesCollectionToDisplay(), RolesCollectionToOdbc(), RolesDisplayToCollection(), RolesDisplayToLogical(), RolesGet(), RolesGetObject(), RolesGetObjectId(), RolesGetStored(), RolesGetSwizzled(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesOdbcToCollection(), RolesSet(), RolesSetObject(), RolesSetObjectId()
relationship UserClinician as HS.Registry.Person.User [ Required , Inverse = Facilities , Cardinality = parent ];
Property methods: UserClinicianCheck(), UserClinicianDelete(), UserClinicianGet(), UserClinicianGetObject(), UserClinicianGetObjectId(), UserClinicianGetStored(), UserClinicianGetSwizzled(), UserClinicianIsValid(), UserClinicianNewObject(), UserClinicianOnDelete(), UserClinicianRClose(), UserClinicianRExec(), UserClinicianRFetch(), UserClinicianRelate(), UserClinicianSQLCompute(), UserClinicianSet(), UserClinicianSetObject(), UserClinicianSetObjectId(), UserClinicianUnRelate(), UserClinicianUnSwizzle()


classmethod DeleteData(id As %String, concurrency As %Integer = -1) as %Status
Delete after validating (none currently)
classmethod GetPrimFac(pUserName, Output pFacility)
Called as a generated field from HS.IHE.ATNA.Repository.Aggregation
classmethod ListUserFacilitiesClose(ByRef qHandle As %Binary) as %Status
classmethod ListUserFacilitiesExecute(ByRef qHandle As %Binary, pRegistryId As %String) as %Status
classmethod ListUserFacilitiesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod PrimaryFacility(pUserId As %String) as %String
Returns the primary facility for a user


query ListUserFacilities(pRegistryId As %String)
Selects ID As %String, Facility As %String, PrimaryFlag As %Boolean
List login IDs via web service call


index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (HS.Registry.Person.UserFacility)

FeedbackOpens in a new tab