AuditEvent class

AuditEvent A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.

Mixed in types
Annotations
  • @freezed

Constructors

AuditEvent({@Default(R5ResourceType.AuditEvent) @JsonKey(unknownEnumValue: R5ResourceType.AuditEvent) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<CodeableConcept>? category, required CodeableConcept code, FhirCode? action, @JsonKey(name: '_action') Element? actionElement, FhirCode? severity, @JsonKey(name: '_severity') Element? severityElement, Period? occurredPeriod, FhirDateTime? occurredDateTime, @JsonKey(name: '_occurredDateTime') Element? occurredDateTimeElement, FhirInstant? recorded, @JsonKey(name: '_recorded') Element? recordedElement, AuditEventOutcome? outcome, List<CodeableConcept>? authorization, List<Reference>? basedOn, Reference? patient, Reference? encounter, required List<AuditEventAgent> agent, required AuditEventSource source, List<AuditEventEntity>? entity})
AuditEvent A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
const
factory
AuditEvent.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
AuditEvent.fromJsonString(String source)
Acts like a constructor, returns a AuditEvent, accepts a String as an argument, mostly because I got tired of typing it out
factory
AuditEvent.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

action FhirCode?
action Indicator for type of action performed during the event that generated the audit.
no setterinherited
actionElement Element?
actionElement ("_action") Extensions for action
no setterinherited
agent List<AuditEventAgent>
agent An actor taking an active role in the event or activity that is logged.
no setterinherited
authorization List<CodeableConcept>?
authorization The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
no setterinherited
basedOn List<Reference>?
basedOn Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.
no setterinherited
category List<CodeableConcept>?
category Classification of the type of event.
no setterinherited
code CodeableConcept
code Describes what happened. The most specific code for the event.
no setterinherited
contained List<Resource>?
contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
no setterinherited
copyWith → $AuditEventCopyWith<AuditEvent>
no setterinherited
dbId int?
no setterinherited
encounter Reference?
encounter This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).
no setterinherited
entity List<AuditEventEntity>?
entity Specific instances of data or objects that have been accessed.
no setterinherited
extension_ List<FhirExtension>?
extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.
no setterinherited
fhirId FhirId?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
implicitRules FhirUri?
implicitRules A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
no setterinherited
implicitRulesElement Element?
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
language FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement Element?
languageElement ("_language") Extensions for language
no setterinherited
meta FhirMeta?
meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
no setterinherited
modifierExtension List<FhirExtension>?
modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to 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).
no setterinherited
occurredDateTime FhirDateTime?
occurredDateTime The time or period during which the activity occurred.
no setterinherited
occurredDateTimeElement Element?
occurredDateTimeElement ("_occurredDateTime") Extensions for occurredDateTime
no setterinherited
occurredPeriod Period?
occurredPeriod The time or period during which the activity occurred.
no setterinherited
outcome AuditEventOutcome?
outcome Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.
no setterinherited
path String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
patient Reference?
patient The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.
no setterinherited
recorded FhirInstant?
recorded The time when the event was recorded.
no setterinherited
recordedElement Element?
recordedElement ("_recorded") Extensions for recorded
no setterinherited
resourceType R5ResourceType
resourceType This is a AuditEvent resource
no setterinherited
resourceTypeString String?
produce a string of the resourceType
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
severity FhirCode?
severity Indicates and enables segmentation of various severity including debugging from critical.
no setterinherited
severityElement Element?
severityElement ("_severity") Extensions for severity
no setterinherited
source AuditEventSource
source The actor that is reporting the event.
no setterinherited
text Narrative?
text A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
no setterinherited
thisReference Reference
Convenience method to return a Reference referring to that Resource
no setterinherited

Methods

newId() Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDbJson() Map<String, dynamic>
The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids
inherited
toJson() Map<String, dynamic>
inherited
toJsonString() String
Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
override
toString() String
A string representation of this object.
inherited
toYaml() String
Produces a Yaml formatted String version of the object
override
updateVersion({FhirMeta? oldMeta}) Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited