description: A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: AuditEvent
type: AuditEvent
elements:
  patient:
    isModifier: false
    short: The patient is the subject of the data used/created/updated/deleted during the activity
    refers: ['http://hl7.org/fhir/StructureDefinition/Patient']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 14
  category:
    isModifier: false
    short: Type/identifier of event
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-type'}
    isSummary: true
    index: 0
  occurred:
    isModifier: false
    short: When the activity occurred
    mustSupport: false
    choices: [occurredPeriod, occurredDateTime]
    isSummary: false
    index: 5
  encounter:
    isModifier: false
    short: Encounter within which this event occurred or which the event is tightly associated
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 15
  authorization:
    isModifier: false
    short: Authorization related to the event
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-PurposeOfUse'}
    isSummary: true
    index: 12
  occurredDateTime: {isModifier: false, short: When the activity occurred, type: dateTime, mustSupport: false, choiceOf: occurred, isSummary: false, index: 7}
  outcome:
    isModifier: false
    short: Whether the event succeeded or failed
    type: BackboneElement
    mustSupport: false
    isSummary: true
    index: 9
    elements:
      code:
        isModifier: false
        short: Whether the event succeeded or failed
        type: Coding
        mustSupport: false
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-outcome'}
        isSummary: true
        index: 10
      detail:
        isModifier: false
        short: Additional outcome detail
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-outcome-detail'}
        isSummary: true
        index: 11
    required: [code]
  source:
    isModifier: false
    short: Audit Event Reporter
    index: 29
    type: BackboneElement
    mustSupport: false
    elements:
      site:
        isModifier: false
        short: Logical source location within the enterprise
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 30
      observer:
        isModifier: false
        short: The identity of source detecting the event
        refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', '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
        mustSupport: false
        isSummary: true
        index: 31
      type:
        isModifier: false
        short: The type of source where event originated
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/security-source-type'}
        isSummary: false
        index: 32
    required: [observer]
    isSummary: true
  recorded: {isModifier: false, short: Time when the event was recorded, type: instant, mustSupport: false, isSummary: true, index: 8}
  agent:
    min: 1
    isModifier: false
    short: Actor involved in the event
    index: 16
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      role:
        isModifier: false
        short: Agent role in the event
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/security-role-type'}
        isSummary: false
        index: 18
      requestor: {isModifier: false, short: Whether user is initiator, type: boolean, mustSupport: false, meaningWhenMissing: 'false', isSummary: true, index: 20}
      who:
        isModifier: false
        short: Identifier of who
        refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', '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
        mustSupport: false
        isSummary: true
        index: 19
      authorization:
        isModifier: false
        short: Allowable authorization for this agent
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v3-PurposeOfUse'}
        isSummary: false
        index: 28
      type:
        isModifier: false
        short: How agent participated
        type: CodeableConcept
        mustSupport: false
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/participation-role-type'}
        isSummary: false
        index: 17
      networkReference:
        isModifier: false
        short: This agent network location for the activity
        refers: ['http://hl7.org/fhir/StructureDefinition/Endpoint']
        type: Reference
        mustSupport: false
        choiceOf: network
        isSummary: false
        index: 25
      networkString: {isModifier: false, short: This agent network location for the activity, type: string, mustSupport: false, choiceOf: network, isSummary: false, index: 27}
      policy: {isModifier: false, short: Policy that authorized the agent participation in the event, type: uri, mustSupport: false, array: true, isSummary: false, index: 22}
      networkUri: {isModifier: false, short: This agent network location for the activity, type: uri, mustSupport: false, choiceOf: network, isSummary: false, index: 26}
      network:
        isModifier: false
        short: This agent network location for the activity
        mustSupport: false
        choices: [networkReference, networkUri, networkString]
        isSummary: false
        index: 24
      location:
        isModifier: false
        short: The agent location when the event occurred
        refers: ['http://hl7.org/fhir/StructureDefinition/Location']
        type: Reference
        mustSupport: false
        isSummary: false
        index: 21
    required: [who]
    isSummary: true
  severity:
    isModifier: false
    short: emergency | alert | critical | error | warning | notice | informational | debug
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-severity|5.0.0-ballot'}
    isSummary: true
    index: 3
  code:
    isModifier: false
    short: Specific type of event
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-sub-type'}
    isSummary: true
    index: 1
  action:
    isModifier: false
    short: Type of action performed during the event
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0-ballot'}
    isSummary: true
    index: 2
  basedOn:
    isModifier: false
    short: Workflow authorization within which this event occurred
    refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest', 'http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/NutritionOrder', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest', 'http://hl7.org/fhir/StructureDefinition/Task']
    type: Reference
    mustSupport: false
    array: true
    isSummary: false
    index: 13
  entity:
    isModifier: false
    short: Data or objects used
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: true
    index: 33
    elements:
      what:
        isModifier: false
        short: Specific instance of resource
        refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 34
      role:
        isModifier: false
        short: What role the entity played
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/object-role'}
        isSummary: false
        index: 35
      securityLabel:
        isModifier: false
        short: Security labels on the entity
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/security-label-examples'}
        isSummary: false
        index: 36
      query: {isModifier: false, short: Query parameters, type: base64Binary, mustSupport: false, isSummary: true, index: 37}
      detail:
        isModifier: false
        short: Additional Information about the entity
        index: 38
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          valueBase64Binary: {isModifier: false, short: Property value, type: base64Binary, mustSupport: false, choiceOf: value, isSummary: false, index: 52}
          valueTime: {isModifier: false, short: Property value, type: time, mustSupport: false, choiceOf: value, isSummary: false, index: 49}
          valueQuantity: {isModifier: false, short: Property value, type: Quantity, mustSupport: false, choiceOf: value, isSummary: false, index: 42}
          value:
            isModifier: false
            short: Property value
            mustSupport: false
            choices: [valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueInteger, valueRange, valueRatio, valueTime, valueDateTime, valuePeriod, valueBase64Binary]
            isSummary: false
            index: 41
          valueString: {isModifier: false, short: Property value, type: string, mustSupport: false, choiceOf: value, isSummary: false, index: 44}
          valueRatio: {isModifier: false, short: Property value, type: Ratio, mustSupport: false, choiceOf: value, isSummary: false, index: 48}
          valueBoolean: {isModifier: false, short: Property value, type: boolean, mustSupport: false, choiceOf: value, isSummary: false, index: 45}
          valueDateTime: {isModifier: false, short: Property value, type: dateTime, mustSupport: false, choiceOf: value, isSummary: false, index: 50}
          type:
            isModifier: false
            short: Name of the property
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/audit-event-type'}
            isSummary: false
            index: 39
          valueCodeableConcept: {isModifier: false, short: Property value, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: false, index: 43}
          valuePeriod: {isModifier: false, short: Property value, type: Period, mustSupport: false, choiceOf: value, isSummary: false, index: 51}
          valueRange: {isModifier: false, short: Property value, type: Range, mustSupport: false, choiceOf: value, isSummary: false, index: 47}
          valueInteger: {isModifier: false, short: Property value, type: integer, mustSupport: false, choiceOf: value, isSummary: false, index: 46}
        required: [valueBase64Binary, valuePeriod, valueString, valueRatio, valueRange, valueDateTime, value, valueBoolean, type, valueCodeableConcept, valueTime, valueQuantity, valueInteger]
        isSummary: false
      agent:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/AuditEvent', elements, agent]
        isModifier: false
        short: Entity is attributed to this agent
        mustSupport: false
        array: true
        isSummary: false
        index: 53
  occurredPeriod: {isModifier: false, short: When the activity occurred, type: Period, mustSupport: false, choiceOf: occurred, isSummary: false, index: 6}
package_version: 5.0.0-ballot
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/AuditEvent
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0-ballot
required: [agent, recorded, source, code]