Skip to main content

HS.FHIR.vSTU3.Model.Resource.AuditEvent.Agent

deprecated class HS.FHIR.vSTU3.Model.Resource.AuditEvent.Agent extends HS.FHIR.vSTU3.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = AuditEvent.Agent;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = AuditEvent.Agent;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property altId as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "altId", XMLPROJECTION = "ELEMENT");
Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
Property methods: altIdGet(), altIdGetSwizzled(), altIdIsValid(), altIdNewObject(), altIdSet()
property location as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Where the event occurred.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property media as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "media", XMLPROJECTION = "ELEMENT");
Type of media involved. Used when the event is about exporting/importing onto media.
Property methods: mediaGet(), mediaGetSwizzled(), mediaIsValid(), mediaNewObject(), mediaSet()
property name as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "name", XMLPROJECTION = "ELEMENT");
Human-meaningful name for the agent.
Property methods: nameGet(), nameGetSwizzled(), nameIsValid(), nameNewObject(), nameSet()
property network as HS.FHIR.vSTU3.Model.Resource.AuditEvent.Network (XMLNAME = "network", XMLPROJECTION = "ELEMENT");
Logical network location for application activity, if the activity has a network location.
Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property policy as list of HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "policy", XMLPROJECTION = "ELEMENT");
The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Property methods: policyBuildValueArray(), policyCollectionToDisplay(), policyCollectionToOdbc(), policyDisplayToCollection(), policyGet(), policyGetObject(), policyGetObjectId(), policyGetSwizzled(), policyIsValid(), policyOdbcToCollection(), policySet(), policySetObject(), policySetObjectId()
property purposeOfUse as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "purposeOfUse", XMLPROJECTION = "ELEMENT");
The reason (purpose of use), specific to this agent, that was used during the event being recorded.
Property methods: purposeOfUseBuildValueArray(), purposeOfUseCollectionToDisplay(), purposeOfUseCollectionToOdbc(), purposeOfUseDisplayToCollection(), purposeOfUseGet(), purposeOfUseGetObject(), purposeOfUseGetObjectId(), purposeOfUseGetSwizzled(), purposeOfUseIsValid(), purposeOfUseOdbcToCollection(), purposeOfUseSet(), purposeOfUseSetObject(), purposeOfUseSetObjectId()
property reference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reference", XMLPROJECTION = "ELEMENT");
Direct reference to a resource that identifies the agent.
Property methods: referenceGet(), referenceGetSwizzled(), referenceIsValid(), referenceNewObject(), referenceSet()
property requestor as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "requestor", XMLPROJECTION = "ELEMENT") [ Required ];
Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Property methods: requestorGet(), requestorGetSwizzled(), requestorIsValid(), requestorNewObject(), requestorSet()
property role as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "role", XMLPROJECTION = "ELEMENT");
The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
Property methods: roleBuildValueArray(), roleCollectionToDisplay(), roleCollectionToOdbc(), roleDisplayToCollection(), roleGet(), roleGetObject(), roleGetObjectId(), roleGetSwizzled(), roleIsValid(), roleOdbcToCollection(), roleSet(), roleSetObject(), roleSetObjectId()
property userId as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "userId", XMLPROJECTION = "ELEMENT");
Unique identifier for the user actively participating in the event.
Property methods: userIdGet(), userIdGetSwizzled(), userIdIsValid(), userIdNewObject(), userIdSet()

Methods

deprecated method SetAltId(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "altId" property.
deprecated method SetLocation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "location" property.
deprecated method SetMedia(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "media" property.
deprecated method SetName(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "name" property.
deprecated method SetPolicy(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "policy" property.
deprecated method SetPurposeOfUse(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "purposeOfUse" property.
deprecated method SetReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reference" property.
deprecated method SetRequestor(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requestor" property.
deprecated method SetRole(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "role" property.
deprecated method SetUserId(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "userId" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab