AuditEventAgent constructor

const AuditEventAgent({
  1. @JsonKey(name: 'id') FhirId? fhirId,
  2. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  3. List<FhirExtension>? modifierExtension,
  4. CodeableConcept? type,
  5. List<CodeableConcept>? role,
  6. Reference? who,
  7. String? altId,
  8. @JsonKey(name: '_altId') Element? altIdElement,
  9. String? name,
  10. @JsonKey(name: '_name') Element? nameElement,
  11. FhirBoolean? requestor,
  12. @JsonKey(name: '_requestor') Element? requestorElement,
  13. Reference? location,
  14. List<FhirUri>? policy,
  15. @JsonKey(name: '_policy') List<Element?>? policyElement,
  16. Coding? media,
  17. AuditEventNetwork? network,
  18. List<CodeableConcept>? purposeOfUse,
})

AuditEventAgent 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.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ 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.

modifierExtension 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).

type Specification of the participation type the user plays when performing the event.

role 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.

who Reference to who this agent is that was involved in the event.

altId 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.

altIdElement Extensions for altId

name Human-meaningful name for the agent.

nameElement Extensions for name

requestor Indicator that the user is or is not the requestor, or initiator, for the event being audited.

requestorElement Extensions for requestor

location Where the event occurred.

policy 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.

policyElement Extensions for policy

media Type of media involved. Used when the event is about exporting/importing onto media.

network Logical network location for application activity, if the activity has a network location.

purposeOfUse The reason (purpose of use), specific to this agent, that was used during the event being recorded.

Implementation

const factory AuditEventAgent({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [extension_] 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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).
  List<FhirExtension>? modifierExtension,

  /// [type] Specification of the participation type the user plays when
  ///  performing the event.
  CodeableConcept? type,

  /// [role] 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.
  List<CodeableConcept>? role,

  /// [who] Reference to who this agent is that was involved in the event.
  Reference? who,

  /// [altId] 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.
  String? altId,

  /// [altIdElement] Extensions for altId
  @JsonKey(name: '_altId') Element? altIdElement,

  /// [name] Human-meaningful name for the agent.
  String? name,

  /// [nameElement] Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [requestor] Indicator that the user is or is not the requestor, or
  ///  initiator, for the event being audited.
  FhirBoolean? requestor,

  /// [requestorElement] Extensions for requestor
  @JsonKey(name: '_requestor') Element? requestorElement,

  /// [location] Where the event occurred.
  Reference? location,

  /// [policy] 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.
  List<FhirUri>? policy,

  /// [policyElement] Extensions for policy
  @JsonKey(name: '_policy') List<Element?>? policyElement,

  /// [media] Type of media involved. Used when the event is about
  ///  exporting/importing onto media.
  Coding? media,

  /// [network] Logical network location for application activity, if the
  ///  activity has a network location.
  AuditEventNetwork? network,

  /// [purposeOfUse] The reason (purpose of use), specific to this agent, that
  ///  was used during the event being recorded.
  List<CodeableConcept>? purposeOfUse,
}) = _AuditEventAgent;