Skip to main content


persistent class HS.Registry.Person.User.WebServices.Containers.QueryItem extends %Library.Persistent, %XML.Adaptor, HS.Util.CopyFrom

SQL Table Name: HS_Registry_Person_User_WebServices_Containers.QueryItem

Property 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 AccessToken as %String;
This is populated in the query response, if the query finds a user/clinician It is needed if the API user wants to issue updates, and expires after 15 minutes
Property methods: AccessTokenDisplayToLogical(), AccessTokenGet(), AccessTokenGetStored(), AccessTokenIsValid(), AccessTokenLogicalToDisplay(), AccessTokenLogicalToOdbc(), AccessTokenNormalize(), AccessTokenSet()
property Active as %Boolean [ InitialExpression = 1 ];
This can be set to 0 to allow a fetch of inactive users. Note that it is possible to have multiple inactive users with the same deterministic identifier(s) - in this case, it will return the first one it encounters.
Property methods: ActiveDisplayToLogical(), ActiveGet(), ActiveGetStored(), ActiveIsValid(), ActiveLogicalToDisplay(), ActiveLogicalToXSD(), ActiveNormalize(), ActiveSet(), ActiveXSDToLogical()
property AssigningAuthorityName as %String;
Property methods: AssigningAuthorityNameDisplayToLogical(), AssigningAuthorityNameGet(), AssigningAuthorityNameGetStored(), AssigningAuthorityNameIsValid(), AssigningAuthorityNameLogicalToDisplay(), AssigningAuthorityNameLogicalToOdbc(), AssigningAuthorityNameNormalize(), AssigningAuthorityNameSet()
property Domain as %String;
Property methods: DomainDisplayToLogical(), DomainGet(), DomainGetStored(), DomainIsValid(), DomainLogicalToDisplay(), DomainLogicalToOdbc(), DomainNormalize(), DomainSet()
property Identifier as %String;
Property methods: IdentifierDisplayToLogical(), IdentifierGet(), IdentifierGetStored(), IdentifierIsValid(), IdentifierLogicalToDisplay(), IdentifierLogicalToOdbc(), IdentifierNormalize(), IdentifierSet()
property InternalID as %String;
This is populated in the query response, if the query finds a user/clinician
Property methods: InternalIDDisplayToLogical(), InternalIDGet(), InternalIDGetStored(), InternalIDIsValid(), InternalIDLogicalToDisplay(), InternalIDLogicalToOdbc(), InternalIDNormalize(), InternalIDSet()
property LoginID as %String;
Property methods: LoginIDDisplayToLogical(), LoginIDGet(), LoginIDGetStored(), LoginIDIsValid(), LoginIDLogicalToDisplay(), LoginIDLogicalToOdbc(), LoginIDNormalize(), LoginIDSet()
property QueryType as %String;
Query type can be: U - User. Pass in the UserID L - Login. Pass in the LoginID and Domain I - Identifier (generic clinician identifiers). Pass in the AssigningAuthorityName and the Identifier.
Property methods: QueryTypeDisplayToLogical(), QueryTypeGet(), QueryTypeGetStored(), QueryTypeIsValid(), QueryTypeLogicalToDisplay(), QueryTypeLogicalToOdbc(), QueryTypeNormalize(), QueryTypeSet()
property UserID as %String;
Property methods: UserIDDisplayToLogical(), UserIDGet(), UserIDGetStored(), UserIDIsValid(), UserIDLogicalToDisplay(), UserIDLogicalToOdbc(), UserIDNormalize(), UserIDSet()


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.User.WebServices.Containers.QueryItem)

FeedbackOpens in a new tab