Skip to main content

HS.FHIRModel.R4.AuditEventX.Agent

class HS.FHIRModel.R4.AuditEventX.Agent extends HS.FHIRModel.FHIRClassSuper

*****************************************
** AuditEventX.Agent generated class schema
*****************************************
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 XMLTYPE = R4_AUDITEVENTX_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.FHIRModel.R4.Element;
Extensions for altId
Property methods: _altIdGet(), _altIdGetSwizzled(), _altIdIsValid(), _altIdNewObject(), _altIdSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _policy as HS.FHIRModel.R4.SeqOfElement;
Extensions for policy
Property methods: _policyGet(), _policyGetSwizzled(), _policyIsValid(), _policyNewObject(), _policySet()
property _requestor as HS.FHIRModel.R4.Element;
Extensions for requestor
Property methods: _requestorGet(), _requestorGetSwizzled(), _requestorIsValid(), _requestorNewObject(), _requestorSet()
property altId as %String;
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: altIdDisplayToLogical(), altIdGet(), altIdIsValid(), altIdLogicalToDisplay(), altIdLogicalToOdbc(), altIdNormalize(), altIdSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property location as HS.FHIRModel.R4.Reference;
Where the event occurred.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property media as HS.FHIRModel.R4.Coding;
Type of media involved. Used when the event is about exporting/importing onto media.
Property methods: mediaGet(), mediaGetSwizzled(), mediaIsValid(), mediaNewObject(), mediaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property name as %String;
Human-meaningful name for the agent.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
Logical network location for application activity, if the activity has a network location.
Property methods: networkGet(), networkGetSwizzled(), networkIsValid(), networkNewObject(), networkSet()
property policy as HS.FHIRModel.R4.SeqOfString;
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: policyGet(), policyGetSwizzled(), policyIsValid(), policyNewObject(), policySet()
property purposeOfUse as HS.FHIRModel.R4.SeqOfCodeableConcept;
The reason (purpose of use), specific to this agent, that was used during the event being recorded.
Property methods: purposeOfUseGet(), purposeOfUseGetSwizzled(), purposeOfUseIsValid(), purposeOfUseNewObject(), purposeOfUseSet()
property requestor as %Boolean;
Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Property methods: requestorDisplayToLogical(), requestorGet(), requestorIsValid(), requestorLogicalToDisplay(), requestorLogicalToXSD(), requestorNormalize(), requestorSet(), requestorXSDToLogical()
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: roleGet(), roleGetSwizzled(), roleIsValid(), roleNewObject(), roleSet()
Specification of the participation type the user plays when performing the event.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property who as HS.FHIRModel.R4.Reference;
Reference to who this agent is that was involved in the event.
Property methods: whoGet(), whoGetSwizzled(), whoIsValid(), whoNewObject(), whoSet()

Methods

method IncludeExtension()
method IncludeLocation()
method IncludeMedia()
method IncludeModifierExtension()
method IncludeNetwork()
method IncludePolicy()
method IncludePurposeOfUse()
method IncludeRole()
method IncludeType()
method IncludeWho()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab