description: 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.
package_name: hl7.fhir.core
derivation: specialization
name: AuditEvent
type: AuditEvent
elements:
  outcomeDesc: {short: Description of the event outcome, type: string, isSummary: true, index: 6}
  type: {short: Type/identifier of event, type: Coding, isSummary: true, index: 0}
  outcome: {short: Whether the event succeeded or failed, type: code, isSummary: true, index: 5}
  source:
    short: Audit Event Reporter
    type: BackboneElement
    index: 23
    elements:
      site: {short: Logical source location within the enterprise, type: string, index: 24}
      identifier: {short: The identity of source detecting the event, type: Identifier, isSummary: true, index: 25}
      type: {short: The type of source where event originated, type: Coding, array: true, index: 26}
    required: [identifier]
  recorded: {short: Time when the event occurred on source, type: instant, isSummary: true, index: 4}
  agent:
    min: 1
    short: Actor involved in the event
    type: BackboneElement
    array: true
    index: 8
    elements:
      role: {short: Agent role in the event, type: CodeableConcept, array: true, index: 10}
      requestor: {short: Whether user is initiator, type: boolean, isSummary: true, index: 15}
      altId: {short: Alternative User id e.g. authentication, type: string, index: 13}
      name: {short: Human-meaningful name for the agent, type: string, index: 14}
      type: {short: How agent participated, type: CodeableConcept, index: 9}
      policy: {short: Policy that authorized event, type: uri, array: true, index: 17}
      purposeOfUse: {short: Reason given for this user, type: CodeableConcept, array: true, index: 22}
      reference:
        short: Direct reference to resource
        refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
        type: Reference
        isSummary: true
        index: 11
      userId: {short: Unique identifier for the user, type: Identifier, isSummary: true, index: 12}
      network:
        type: BackboneElement
        short: Logical network location for application activity
        index: 19
        elements:
          address: {short: Identifier for the network access point of the user device, type: string, index: 20}
          type: {short: The type of network access point, type: code, index: 21}
      location:
        short: Where
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        type: Reference
        index: 16
      media: {short: Type of media, type: Coding, index: 18}
    required: [requestor]
  purposeOfEvent: {short: The purposeOfUse of the event, type: CodeableConcept, array: true, isSummary: true, index: 7}
  action: {short: Type of action performed during the event, type: code, isSummary: true, index: 2}
  period: {short: When the activity occurred, type: Period, index: 3}
  entity:
    constraint:
      sev-1: {human: Either a name or a query (NOT both), severity: error, expression: name.empty() or query.empty()}
    short: Data or objects used
    type: BackboneElement
    array: true
    index: 27
    elements:
      role: {short: What role the entity played, type: Coding, index: 31}
      description: {short: Descriptive text, type: string, index: 35}
      name: {short: Descriptor for entity, type: string, isSummary: true, index: 34}
      type: {short: Type of entity involved, type: Coding, index: 30}
      lifecycle: {short: Life-cycle stage for the entity, type: Coding, index: 32}
      reference:
        short: Specific instance of resource
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        isSummary: true
        index: 29
      identifier: {short: Specific instance of object, type: Identifier, isSummary: true, index: 28}
      query: {short: Query parameters, type: base64Binary, isSummary: true, index: 36}
      securityLabel: {short: Security labels on the entity, type: Coding, array: true, index: 33}
      detail:
        short: Additional Information about the entity
        type: BackboneElement
        array: true
        index: 37
        elements:
          type: {type: string, short: Name of the property, index: 38}
          value:
            short: Property value
            choices: [valueString, valueBase64Binary]
            index: 40
          valueString: {short: Property value, type: string, choiceOf: value, index: 41}
          valueBase64Binary: {short: Property value, type: base64Binary, choiceOf: value, index: 42}
        required: [valueBase64Binary, valueString, value, type]
  subtype: {short: More specific type/id for the event, type: Coding, array: true, isSummary: true, index: 1}
package_version: 3.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/AuditEvent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [agent, recorded, source, type]