Skip to main content


serial class HS.IHE.XUA.SAMLData extends %Library.SerialObject, %XML.Adaptor

Base class for results from HS.IHE.XUA.Processor and its subclasses. The results from this class should be used in the service to populate requests sent to other components.

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 BreakTheGlass as %Boolean;
Property methods: BreakTheGlassDisplayToLogical(), BreakTheGlassGet(), BreakTheGlassIsValid(), BreakTheGlassLogicalToDisplay(), BreakTheGlassLogicalToXSD(), BreakTheGlassNormalize(), BreakTheGlassSet(), BreakTheGlassXSDToLogical()
property ClientSystemType as %String);
Australian specific properties
Property methods: ClientSystemTypeDisplayToLogical(), ClientSystemTypeGet(), ClientSystemTypeIsValid(), ClientSystemTypeLogicalToDisplay(), ClientSystemTypeLogicalToOdbc(), ClientSystemTypeNormalize(), ClientSystemTypeSet()
property HSRoles as %String);
Comma delimited string of roles
Property methods: HSRolesDisplayToLogical(), HSRolesGet(), HSRolesIsValid(), HSRolesLogicalToDisplay(), HSRolesLogicalToOdbc(), HSRolesNormalize(), HSRolesSet()
property IDType as %String);
Australian specific properties
Property methods: IDTypeDisplayToLogical(), IDTypeGet(), IDTypeIsValid(), IDTypeLogicalToDisplay(), IDTypeLogicalToOdbc(), IDTypeNormalize(), IDTypeSet()
property IHINumber as %String;
Australian specific properties
Property methods: IHINumberDisplayToLogical(), IHINumberGet(), IHINumberIsValid(), IHINumberLogicalToDisplay(), IHINumberLogicalToOdbc(), IHINumberNormalize(), IHINumberSet()
property Issuer as %String);
Content of Issuer element in SAML Assertion
Property methods: IssuerDisplayToLogical(), IssuerGet(), IssuerIsValid(), IssuerLogicalToDisplay(), IssuerLogicalToOdbc(), IssuerNormalize(), IssuerSet()
property LoginDomain as %String (MAXLEN = 255);
Property methods: LoginDomainDisplayToLogical(), LoginDomainGet(), LoginDomainIsValid(), LoginDomainLogicalToDisplay(), LoginDomainLogicalToOdbc(), LoginDomainNormalize(), LoginDomainSet()
property NPI as %String;
National Provider Identifier
Property methods: NPIDisplayToLogical(), NPIGet(), NPIIsValid(), NPILogicalToDisplay(), NPILogicalToOdbc(), NPINormalize(), NPISet()
property Organization as %String (MAXLEN = 255);
The name of the organization
Property methods: OrganizationDisplayToLogical(), OrganizationGet(), OrganizationIsValid(), OrganizationLogicalToDisplay(), OrganizationLogicalToOdbc(), OrganizationNormalize(), OrganizationSet()
property OrganizationID as %String);
Australian specific properties US spelling which matches Organization inherited from HS.IHE.XUA.SAMLData (HPI-O)
Property methods: OrganizationIDDisplayToLogical(), OrganizationIDGet(), OrganizationIDIsValid(), OrganizationIDLogicalToDisplay(), OrganizationIDLogicalToOdbc(), OrganizationIDNormalize(), OrganizationIDSet()
property OrganizationOID as %String (MAXLEN = 255);
OID from SAML assertion
Property methods: OrganizationOIDDisplayToLogical(), OrganizationOIDGet(), OrganizationOIDIsValid(), OrganizationOIDLogicalToDisplay(), OrganizationOIDLogicalToOdbc(), OrganizationOIDNormalize(), OrganizationOIDSet()
property PurposeOfUse as HS.IHE.XUA.PurposeOfUse;
Property methods: PurposeOfUseGet(), PurposeOfUseGetSwizzled(), PurposeOfUseIsValid(), PurposeOfUseNewObject(), PurposeOfUseSet()
property RHIO as %String (MAXLEN = 255);
OIDMap entry for User's RHIO
Property methods: RHIODisplayToLogical(), RHIOGet(), RHIOIsValid(), RHIOLogicalToDisplay(), RHIOLogicalToOdbc(), RHIONormalize(), RHIOSet()
property SAMLInfo as array of %String);
Anything stored in the SAMLInfo array will be passed from message to message
Property methods: SAMLInfoBuildValueArray(), SAMLInfoCollectionToDisplay(), SAMLInfoCollectionToOdbc(), SAMLInfoDisplayToCollection(), SAMLInfoDisplayToLogical(), SAMLInfoGet(), SAMLInfoGetObject(), SAMLInfoGetObjectId(), SAMLInfoGetSwizzled(), SAMLInfoIsValid(), SAMLInfoLogicalToDisplay(), SAMLInfoLogicalToOdbc(), SAMLInfoNormalize(), SAMLInfoOdbcToCollection(), SAMLInfoSet(), SAMLInfoSetObject(), SAMLInfoSetObjectId()
property Subject as %String);
Content of Subject element in SAML Assertion
Property methods: SubjectDisplayToLogical(), SubjectGet(), SubjectIsValid(), SubjectLogicalToDisplay(), SubjectLogicalToOdbc(), SubjectNormalize(), SubjectSet()
property SubjectSPProvidedID as %String);
SPProvidedID attribute of Subject element in SAML Assertion, if it exists
Property methods: SubjectSPProvidedIDDisplayToLogical(), SubjectSPProvidedIDGet(), SubjectSPProvidedIDIsValid(), SubjectSPProvidedIDLogicalToDisplay(), SubjectSPProvidedIDLogicalToOdbc(), SubjectSPProvidedIDNormalize(), SubjectSPProvidedIDSet()
property Token as %String);
Property methods: TokenDisplayToLogical(), TokenGet(), TokenIsValid(), TokenLogicalToDisplay(), TokenLogicalToOdbc(), TokenNormalize(), TokenSet()
property UseRoleForAudit as %Boolean;
Australian specific properties
Property methods: UseRoleForAuditDisplayToLogical(), UseRoleForAuditGet(), UseRoleForAuditIsValid(), UseRoleForAuditLogicalToDisplay(), UseRoleForAuditLogicalToXSD(), UseRoleForAuditNormalize(), UseRoleForAuditSet(), UseRoleForAuditXSDToLogical()
property UserName as %String);
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()
property Working as %String [ MultiDimensional ];
Items stored in the working array are not carried forward, they are just temporary slots to hold information from method to method
Property methods: WorkingDisplayToLogical(), WorkingGet(), WorkingIsValid(), WorkingLogicalToDisplay(), WorkingLogicalToOdbc(), WorkingNormalize(), WorkingSet()


method CopySAMLInfoToXMLMessage(ByRef pXMLMessage As HS.Message.XMLMessage = "", pPrefix As %String = "SAML:") as %Status
no need to do this in the new version as we are passing the whole object

Inherited Members

Inherited Methods


FeedbackOpens in a new tab