HS.Types.RequestInfo
class HS.Types.RequestInfo extends HS.Types.AuthorizationInfo, HS.Util.CopyFrom, %Library.RegisteredObject, %XML.Adaptor, %ZEN.DataModel.ObjectDataModel
Property Inventory
- AdditionalInfo
- BreakTheGlass
- ClinicalTypes
- Consent
- CustomAuditInfo
- RequestId
- RequestingForProxyID
- RequestingForProxyUserID
- RequestingGateway
- RequestingUser
- RequestingUserRoles
- SAMLData
- Signature
- Type
Method Inventory
Parameters
parameter DOMAIN = HS;
Inherited description: Localization domain.
DataModel classes that wish to support localization must provide a value for this
within subclasses.
parameter XMLIGNOREINVALIDTAG = 1;
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.
Properties
property AdditionalInfo as array of HS.Types.AdditionalInfoItem;
Additional request information
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property BreakTheGlass as %Boolean (ZENHIDDEN = 1) [ InitialExpression = 0 ];
Enabling this may be in violation of federal law ... check with your lawyers
Property methods: BreakTheGlassDisplayToLogical(), BreakTheGlassGet(), BreakTheGlassIsValid(), BreakTheGlassLogicalToDisplay(), BreakTheGlassLogicalToXSD(), BreakTheGlassNormalize(), BreakTheGlassSet(), BreakTheGlassXSDToLogical()
property ClinicalTypes as %String);
Clinical types
Property methods: ClinicalTypesDisplayToLogical(), ClinicalTypesGet(), ClinicalTypesIsValid(), ClinicalTypesLogicalToDisplay(), ClinicalTypesLogicalToOdbc(), ClinicalTypesNormalize(), ClinicalTypesSet()
property Consent as %String);
Consent information
Property methods: ConsentDisplayToLogical(), ConsentGet(), ConsentIsValid(), ConsentLogicalToDisplay(), ConsentLogicalToOdbc(), ConsentNormalize(), ConsentSet()
property CustomAuditInfo as array of %String);
Data passed in here will be copied to CustomPairs when audited
Property methods: CustomAuditInfoBuildValueArray(), CustomAuditInfoCollectionToDisplay(), CustomAuditInfoCollectionToOdbc(), CustomAuditInfoDisplayToCollection(), CustomAuditInfoDisplayToLogical(), CustomAuditInfoGet(), CustomAuditInfoGetObject(), CustomAuditInfoGetObjectId(), CustomAuditInfoGetSwizzled(), CustomAuditInfoIsValid(), CustomAuditInfoLogicalToDisplay(), CustomAuditInfoLogicalToOdbc(), CustomAuditInfoNormalize(), CustomAuditInfoOdbcToCollection(), CustomAuditInfoSet(), CustomAuditInfoSetObject(), CustomAuditInfoSetObjectId()
property RequestId as %String (MAXLEN = 128, ZENHIDDEN = 1);
Request Audit ID *** Must always be set and passed around ***
Property methods: RequestIdDisplayToLogical(), RequestIdGet(), RequestIdIsValid(), RequestIdLogicalToDisplay(), RequestIdLogicalToOdbc(), RequestIdNormalize(), RequestIdSet()
property RequestingForProxyID as %String (ZENHIDDEN = 1);
If this is for a proxy, the internal ID of the proxied user
Property methods: RequestingForProxyIDDisplayToLogical(), RequestingForProxyIDGet(), RequestingForProxyIDIsValid(), RequestingForProxyIDLogicalToDisplay(), RequestingForProxyIDLogicalToOdbc(), RequestingForProxyIDNormalize(), RequestingForProxyIDSet()
property RequestingForProxyUserID as HS.Types.Username (ZENHIDDEN = 1);
If this is for a proxy, the $username of the proxied user
Property methods: RequestingForProxyUserIDDisplayToLogical(), RequestingForProxyUserIDGet(), RequestingForProxyUserIDIsValid(), RequestingForProxyUserIDLogicalToDisplay(), RequestingForProxyUserIDLogicalToOdbc(), RequestingForProxyUserIDNormalize(), RequestingForProxyUserIDSet()
property RequestingGateway as %String (MAXLEN = 256, ZENHIDDEN = 1) [ InitialExpression = ##Class(HS.Util.Installer.ConfigItem).GetThisComponentName() ];
An identifier for the access gateway that initiated the request
Property methods: RequestingGatewayDisplayToLogical(), RequestingGatewayGet(), RequestingGatewayIsValid(), RequestingGatewayLogicalToDisplay(), RequestingGatewayLogicalToOdbc(), RequestingGatewayNormalize(), RequestingGatewaySet()
property RequestingUser as HS.Types.Username (ZENHIDDEN = 1) [ InitialExpression = $USERNAME ];
The requesting user
Property methods: RequestingUserDisplayToLogical(), RequestingUserGet(), RequestingUserIsValid(), RequestingUserLogicalToDisplay(), RequestingUserLogicalToOdbc(), RequestingUserNormalize(), RequestingUserSet()
property RequestingUserRoles as %String) [ InitialExpression = $ROLES ];
The roles for the requesting user
Property methods: RequestingUserRolesDisplayToLogical(), RequestingUserRolesGet(), RequestingUserRolesIsValid(), RequestingUserRolesLogicalToDisplay(), RequestingUserRolesLogicalToOdbc(), RequestingUserRolesNormalize(), RequestingUserRolesSet()
property SAMLData as HS.IHE.XUA.SAMLData;
Contains SAML user / rhio / token
Property methods: SAMLDataGet(), SAMLDataGetObject(), SAMLDataGetObjectId(), SAMLDataGetSwizzled(), SAMLDataIsEmpty(), SAMLDataIsValid(), SAMLDataNewObject(), SAMLDataSet(), SAMLDataSetObject(), SAMLDataSetObjectId(), SAMLDataUnSwizzle()
property Signature as %String);
Signature for this request
Property methods: SignatureDisplayToLogical(), SignatureGet(), SignatureIsValid(), SignatureLogicalToDisplay(), SignatureLogicalToOdbc(), SignatureNormalize(), SignatureSet()
property Type as %String (MAXLEN = 512, ZENHIDDEN = 1);
Type for increasing the specificity of a request
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
Methods
classmethod GetUserInfo(pSource As %RegisteredObject, Output pUserName As %String = $Username, Output pUserRoles As %String = $Roles, Output pBreakTheGlass As %Boolean = 0, pPropertyName As %String = "AdditionalInfo") as %Status
Get the user information for a RequestInfo or XMLMessage object
classmethod RequestInfoToXMLMessage(pSource As HS.Types.RequestInfo, pTarget As %RegisteredObject, pPropertyName As %String = "AdditionalInfo") as %Status
Insert/Update request info from any message with an AdditionalInfo array.
Keys supported: "USER:UserID", "USER:Roles" and "BreakTheGlass".
classmethod XMLMessageToRequestInfo(pSource As %RegisteredObject, pTarget As HS.Types.RequestInfo, pPropertyName As %String = "AdditionalInfo") as %Status
Copy request info from any message with an AdditionalInfo array.
Keys supported: "USER:UserID", "USER:Roles" and "BreakTheGlass".
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %CreateModelInstance()
- %DeleteModel()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Extends()
- %GetJSValidationCode()
- %GetParameter()
- %GetPropertyInfo()
- %InvokeAction()
- %IsA()
- %IsModified()
- %IsReadOnly()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnCopyDataFromModel()
- %OnCopyDataToModel()
- %OnDeleteModel()
- %OnDeleteSource()
- %OnGetPropertyInfo()
- %OnInvokeAction()
- %OnLoadModel()
- %OnNewSource()
- %OnOpenSource()
- %OnSaveSource()
- %OnStoreModel()
- %OnSubmit()
- %OpenModel()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SaveModel()
- %SerializeObject()
- %SetModified()
- %SubmitHandler()
- %ValidateObject()
- CopyFrom()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Subclasses
- HS.AU.Message.SMD.DeliveryRequestBase
- HS.Message.AddUpdateHubRequest
- HS.Message.Analytics.QueryRequest
- HS.Message.Analytics.QueryResponse
- HS.Message.AnalyticsPatClinRelationship
- HS.Message.ApplySDAConsentRequest
- HS.Message.DocumentAuditRequest
- HS.Message.ECRFetchRequest
- HS.Message.ECRQueryRequest
- HS.Message.ExpirePatientRequest
- HS.Message.IDUpdateNotificationRequest
- HS.Message.IHE.DSUB.CancelSubscriptionRequest
- HS.Message.IHE.DSUB.SubscriptionRequest
- HS.Message.IHE.XDSI.RetrieveRequest
- HS.Message.IHE.XDSb.DeleteDocumentSetRequest
- HS.Message.IHE.XDSb.Metadata
- HS.Message.IHE.XDSb.ProvideAndRegisterRequest
- HS.Message.IHE.XDSb.QueryRequest
- HS.Message.IHE.XDSb.RetrieveRequest
- HS.Message.MergePatientRequest
- HS.Message.PatClinRelationship
- HS.Message.PatientBatchFetchRequest
- HS.Message.PatientBatchFetchRequestAsync
- HS.Message.PatientFlashFetchRequestAsync
- HS.Message.PatientListCopyRequest
- HS.Message.PatientListRequest
- HS.Message.PatientMPIMatch
- HS.Message.PatientSearchMatch
- HS.Message.PatientSearchRequest
- HS.Message.PatientSearchResponse
- HS.Message.ProductListRequest
- HS.Message.Push.IncorporateClinicalMessageRequest
- HS.Message.Push.PatientGetRequest
- HS.Message.QueueForFetchRequest
- HS.Message.RegistrySDARequest
- HS.Message.SDAAuditRequest
- HS.Message.SearchAndFetchRequest