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.r4.examples
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
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-type'}
    isSummary: true
    index: 0
  outcome:
    short: Whether the event succeeded or failed
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1'}
    isSummary: true
    index: 5
  source:
    short: Audit Event Reporter
    type: BackboneElement
    index: 22
    elements:
      site: {short: Logical source location within the enterprise, type: string, index: 23}
      observer:
        short: The identity of source detecting the event
        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: 24
      type:
        short: The type of source where event originated
        type: Coding
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/audit-source-type'}
        index: 25
    required: [observer]
  recorded: {short: Time when the event was recorded, 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
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/security-role-type'}
        index: 10
      requestor: {short: Whether user is initiator, type: boolean, isSummary: true, index: 14}
      who:
        short: Identifier of who
        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
      altId: {short: Alternative User identity, type: string, index: 12}
      name: {short: Human friendly name for the agent, type: string, index: 13}
      type:
        short: How agent participated
        type: CodeableConcept
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/participation-role-type'}
        index: 9
      policy: {short: Policy that authorized event, type: uri, array: true, index: 16}
      purposeOfUse:
        short: Reason given for this user
        type: CodeableConcept
        array: true
        binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/v3-PurposeOfUse'}
        index: 21
      network:
        type: BackboneElement
        short: Logical network location for application activity
        index: 18
        elements:
          address: {short: Identifier for the network access point of the user device, type: string, index: 19}
          type:
            short: The type of network access point
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/network-type|4.0.1'}
            index: 20
      location:
        short: Where
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        type: Reference
        index: 15
      media:
        short: Type of media
        type: Coding
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/dicm-405-mediatype'}
        index: 17
    required: [requestor]
  purposeOfEvent:
    short: The purposeOfUse of the event
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/v3-PurposeOfUse'}
    isSummary: true
    index: 7
  action:
    short: Type of action performed during the event
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1'}
    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: 26
    elements:
      role:
        short: What role the entity played
        type: Coding
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/object-role'}
        index: 29
      description: {short: Descriptive text, type: string, index: 33}
      name: {short: Descriptor for entity, type: string, isSummary: true, index: 32}
      type:
        short: Type of entity involved
        type: Coding
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/audit-entity-type'}
        index: 28
      lifecycle:
        short: Life-cycle stage for the entity
        type: Coding
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/object-lifecycle-events'}
        index: 30
      query: {short: Query parameters, type: base64Binary, isSummary: true, index: 34}
      securityLabel:
        short: Security labels on the entity
        type: Coding
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/security-labels'}
        index: 31
      what:
        short: Specific instance of resource
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        isSummary: true
        index: 27
      detail:
        short: Additional Information about the entity
        type: BackboneElement
        array: true
        index: 35
        elements:
          type: {type: string, short: Name of the property, index: 36}
          value:
            short: Property value
            choices: [valueString, valueBase64Binary]
            index: 38
          valueString: {short: Property value, type: string, choiceOf: value, index: 39}
          valueBase64Binary: {short: Property value, type: base64Binary, choiceOf: value, index: 40}
        required: [valueBase64Binary, valueString, value, type]
  subtype:
    short: More specific type/id for the event
    type: Coding
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-sub-type'}
    isSummary: true
    index: 1
package_version: 4.0.1
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/AuditEvent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [agent, recorded, source, type]