Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3 R2

6.4 Resource AuditEvent - Content

Security icon Work Group Maturity Level : 3 4   Trial Use Security Category : Not Classified Compartments : Device , Patient , Practitioner

A record of an event made relevant for purposes of maintaining a security log. Typical uses include detection of intrusion attempts such as operations, privacy, security, maintenance, and monitoring for inappropriate usage. performance analysis.

6.4.1 Scope and Usage

The audit event is based on the IHE-ATNA Audit record definitions, originally from RFC 3881 icon , and now managed by DICOM (see DICOM Part 15 Annex A5 icon ).

  • ASTM E2147 – - Setup the concept of security audit logs for healthcare including accounting of disclosures
  • IETF RFC 3881 – - Defined the Information Model (IETF rule forced this to be informative)
  • DICOM Audit Log Message – - Made the information model Normative, defined Vocabulary, Transport Binding, and Schema
  • IHE ATNA – - Defines the grouping with secure transport and access controls; and defined specific audit log records for specific IHE transactions.
  • NIST SP800-92 – - Shows how to do audit log management and reporting – - consistent with our model
  • HL7 PASS – - Defined an Audit Service with responsibilities and a query interface for reporting use
  • ISO 27789 – - Defined the subset of audit events that an EHR would need
  • ISO/HL7 10781 EHR System Functional Model Release 2
  • ISO 21089 Trusted End-to-End Information Flows

This resource is managed collaboratively between HL7, DICOM, and IHE.

The primary purpose of this resource is the maintenance A record of security audit log information. However, it can also be used an event relevant for any audit logging needs purposes such as operations, privacy, security, maintenance, and simple event-based notification. performance analysis.

6.4.2 Background and Context

All actors - such as applications, processes, and services - involved in an auditable event should record an AuditEvent. This will likely result in multiple AuditEvent entries that show whether privacy and security safeguards, such as access control, are properly functioning across an enterprise's system-of-systems. Thus, it is typical to get an auditable event recorded by both the application in a workflow process and the servers that support them. For this reason, duplicate entries are expected, which is helpful because it may aid in the detection of. of security, privacy, or other operational problems. For example, fewer than expected actors being recorded in a multi-actor process or attributes related to those records being in conflict, which is an indication of a security problem. There may be non-participating actors, such as trusted intermediary, that also detect a security security, privacy, or operational relevant event and thus would record an AuditEvent, such as a trusted intermediary. AuditEvent.

Security relevant events are not limited to communications or RESTful events. They include:

  • software start-up and shutdown;
  • user login and logout;
  • access control decisions;
  • configuration events;
  • software installation;
  • policy rules changes; and
  • manipulation of data that exposes the data to users.

See the Audit Event Sub-Type Category vocabulary for guidance on some security relevant events. event categories.

The AuditEvent resource holds the details of an event in terms of who, what, where, when, and why. Where the identification of the who participated is the agent. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. What objects were used/created/updated is recorded as the entity. An entity is an identifiable physical, digital, conceptual or other kind of thing; entities may be real or imaginary.

The content of an AuditEvent is intended for use by security system administrators, security and privacy information managers, and records management personnel. This content is not intended to be accessible or used directly by other healthcare users, such as providers or patients, although reports generated from the raw data would be useful. An example is a patient-centric accounting of disclosures or an access report. Servers that provide support for AuditEvent resources would not generally accept update or delete operations on the resources, as this would compromise the integrity of the audit record. Access to the AuditEvent would typically be limited to security, privacy, or other system administration purposes.

Relationship of AuditEvent and Provenance resources are often (though not exclusively) created by the application responding to the create/read/query/update/delete/execute etc. event. A Provenance resource contains overlapping information, but is a record-keeping assertion that gathers information about the context in which the information in a resource "came to be" in its current state, e.g., whether it was created de novo or obtained from another entity in whole, part, or by transformation. Provenance resources are prepared by the application that initiates the create/update of the resource and may be persisted with the AuditEvent target resource.

6.4.3 References to this Resource

No resources refer to this resource directly.
    This resource implements the
  • Implements: Event pattern.

6.4.4 Resource Content

Structure

Identifier for the network access point of the user device The type of network access point Reason given I string Descriptor for entity Descriptive text 0..1 Query parameters Additional Information about the entity Name of the property Property value
Name Flags Card. Type Description & Constraints doco
. . AuditEvent TU DomainResource Event record kept for security purposes Record of an event

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . type category Σ 1..1 0..* Coding CodeableConcept Type/identifier of event
Binding: Audit Event ID ( Extensible Example )

. . . subtype code Σ 0..* 1..1 Coding CodeableConcept More specific type/id for the Specific type of event
Binding: Audit Event Sub-Type ( Extensible Example )
. . . action Σ 0..1 code Type of action performed during the event
AuditEventAction Binding: Audit Event Action ( Required )
... occurred[x] 0..1 When the activity occurred
. . . . occurredPeriod Period
... . occurredDateTime dateTime
... recorded Σ 1..1 instant Time when the event was recorded
. . . outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... code Σ 0..1 1..1 code Coding Whether the event succeeded or failed
AuditEventOutcome Binding: Audit Event Outcome ( Required Preferred )
. . outcomeDesc . . detail Σ 0..1 0..* string CodeableConcept Description of the event Additional outcome detail
Binding: Audit Event Outcome Detail ( Example )

. . . purposeOfEvent authorization Σ 0..* CodeableConcept The purposeOfUse of Authorization related to the event
Binding: PurposeOfUse icon ( Extensible Example )

. . agent . basedOn 1..* 0..* BackboneElement Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task ) Actor involved in the Workflow authorization within which this event occurred

. . type . patient TU 0..1 CodeableConcept Reference ( Patient ) How agent participated The patient is the subject of the data used/created/updated/deleted during the activity
ParticipationRoleType ( Extensible )
. . role . encounter 0..* 0..1 CodeableConcept Reference ( Encounter ) Agent role in Encounter within which this event occurred or which the event SecurityRoleType ( Example ) is tightly associated
. . who . agent Σ 0..1 1..* Reference ( PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson BackboneElement ) Identifier of who Actor involved in the event

. . . altId . type 0..1 string CodeableConcept Alternative User identity How agent participated
Binding: Participation Role Type ( Preferred )
. . . name . role 0..1 0..* string CodeableConcept Human friendly name for Agent role in the agent event
Binding: Security Role Type ( Example )

. . . requestor . who Σ 1..1 boolean Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson ) Whether user is initiator Identifier of who
. . . location . requestor Σ 0..1 Reference ( Location boolean ) Where Whether user is initiator
. . . policy . location 0..* 0..1 uri Reference ( Location ) Policy that authorized The agent location when the event occurred
. . . media . policy 0..1 0..* Coding uri Type of media Policy that authorized the agent participation in the event

Media Type Code ( Extensible )
. . . network . network[x] 0..1 BackboneElement Logical This agent network location for application the activity
. . . . address . networkReference 0..1 string Reference ( Endpoint )
. . . . . type networkUri 0..1 uri code
. . . . . networkString AuditEventAgentNetworkType ( Required string )
. . . purposeOfUse . authorization 0..* CodeableConcept Allowable authorization for this user agent
Binding: PurposeOfUse icon ( Extensible Example )

. . . source Σ 1..1 BackboneElement Audit Event Reporter
. . . . site 0..1 string Reference ( Location ) Logical source location within the enterprise
. . . . observer Σ 1..1 Reference ( PractitionerRole | Practitioner | PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson ) The identity of source detecting the event
. . . . type 0..* Coding CodeableConcept The type of source where event originated
Binding: Audit Event Source Type ( Extensible Preferred )

. . . entity I Σ 0..* BackboneElement Data or objects used
+ Rule: Either a name or a query (NOT both)
. . . . what Σ 0..1 Reference ( Any ) Specific instance of resource
. . . type . role 0..1 CodeableConcept What role the entity played
Binding: Audit Event Entity Role ( Example )
.... securityLabel 0..1 0..* Coding CodeableConcept Type of Security labels on the entity involved
AuditEventEntityType Binding: Example set of Security Labels ( Extensible Example )

. . . role . query Σ 0..1 Coding base64Binary What role the entity played Query parameters
AuditEventEntityRole ( Extensible )
. . . lifecycle . detail 0..1 0..* Coding BackboneElement Life-cycle stage for Additional Information about the entity
ObjectLifecycleEvents ( Extensible )
. . . . . securityLabel type 0..* 1..1 Coding CodeableConcept Security labels on Name of the entity property
SecurityLabels Binding: Audit Event ID ( Extensible Example )
. . . name . . value[x] Σ 1..1 0..1 Property value
. . . . . . valueQuantity Quantity
. . . . . description . valueCodeableConcept CodeableConcept
. . . . . . valueString 0..1 string
. . . . . . query valueBoolean Σ boolean I
. . . . . . valueInteger base64Binary integer
. . . detail . . . valueRange Range
. . . . . . valueRatio 0..* BackboneElement Ratio
. . . . . . type valueTime 1..1 string time
. . . . value[x] . . valueDateTime 1..1 dateTime
. . . . . valueString . valuePeriod string Period
. . . . . . valueBase64Binary base64Binary
. . . . agent 0..* see agent Entity is attributed to this agent


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

AuditEvent ( DomainResource ) Identifier for a family Classification of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function type of event category : Coding CodeableConcept [1..1] [0..*] « null (Strength=Extensible) (Strength=Example) AuditEventID + ?? » Identifier Describes what happened. The most specific code for the category of event subtype code : Coding CodeableConcept [0..*] [1..1] « null (Strength=Extensible) (Strength=Example) AuditEventSub-Type AuditEventSubType + ?? » Indicator for type of action performed during the event that generated the audit action : code [0..1] « null Indicator for type of action performed during the event that generated the event. (Strength=Required) AuditEventAction ! » Indicates and enables segmentation of various severity including debugging from critical severity : code [0..1] « The severity of the audit entry. (Strength=Required) AuditEventSeverity ! » The time or period during which the activity occurred period occurred[x] : Period DataType [0..1] « Period | dateTime » The time when the event was recorded recorded : instant [1..1] Indicates whether The authorization (e.g., PurposeOfUse) that was used during the event succeeded or failed being recorded outcome authorization : code CodeableConcept [0..1] [0..*] « null (Strength=Required) (Strength=Example) AuditEventOutcome ! PurposeOfUse ?? » A free text description Allows tracing of authorizatino for the outcome events and tracking whether proposals/recommendations were acted upon basedOn : Reference [0..*] « CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task » 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 patient : Reference [0..1] « Patient » 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) outcomeDesc encounter : string Reference [0..1] « Encounter » Outcome The purposeOfUse (reason) that was used during Indicates whether the event being recorded succeeded or failed purposeOfEvent code : Coding [1..1] « Indicates whether the event succeeded or failed. (Strength=Preferred) AuditEventOutcome ? » Additional details about the error. This may be a text description of the error or a system code that identifies the error detail : CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) PurposeOfUse AuditEventOutcomeDetail + ?? » Agent Specification The Functional Role of the participation type the user plays when performing the event type : CodeableConcept [0..1] « null (Strength=Extensible) (Strength=Preferred) ParticipationRoleType + ? » The security role that structural roles of the user was acting under, that come from local codes defined by agent indicating the access control agent's competency. The security system (e.g. RBAC, ABAC) used in role enabling the local context agent with respect to the activity role : CodeableConcept [0..*] « null (Strength=Example) SecurityRoleType ?? » Reference to who this agent is that was involved in the event who : Reference [0..1] [1..1] « PractitionerRole Practitioner | Practitioner PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson » 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 altId : string [0..1] Human-meaningful name for the agent name : string [0..1] Indicator that the user is or is not the requestor, or initiator, for the event being audited requestor : boolean [1..1] [0..1] Where the agent location is known, the agent location when the event occurred location : Reference [0..1] « Location » The policy or plan Where the policy(ies) are known that authorized the activity being recorded. agent participation in the event. 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 policy : uri [0..*] Type of media involved. Used when When the event is about exporting/importing onto media utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details media network[x] : Coding DataType [0..1] « null (Strength=Extensible) MediaTypeCode Reference ( Endpoint )| uri | string + » The reason (purpose of use), specific to this agent, authorization (e.g., PurposeOfUse) that was used during the event being recorded purposeOfUse authorization : CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) PurposeOfUse + » Network An identifier for the network access point of the user device for the audit event address : string [0..1] An identifier for the type of network access point that originated the audit event type : code [0..1] « null (Strength=Required) AuditEventAgentNetworkType ! ?? » Source Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group site : string Reference [0..1] « Location » Identifier of the source where the event was detected observer : Reference [1..1] « PractitionerRole Practitioner | Practitioner PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson » Code specifying the type of source where event originated type : Coding CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Preferred) AuditEventSourceType + ? » Entity Identifies a specific instance of the entity. The reference should be version specific specific. This is allowed to be a Parameters resource what : Reference [0..1] « Any » The type of the object that was involved in this audit event type : Coding [0..1] « null (Strength=Extensible) AuditEventEntityType + » Code representing the role the entity played in the event being audited role : Coding CodeableConcept [0..1] « null (Strength=Extensible) AuditEventEntityRole + » Identifier for Code representing the data life-cycle stage for role the entity played in the audit event. (Strength=Example) lifecycle : Coding [0..1] « null (Strength=Extensible) ObjectLifecycleEvents AuditEventEntityRole + ?? » Security labels for the identified entity securityLabel : Coding CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) All Security Labels SecurityLabelExamples + ?? » A name of the entity in the audit event name : string [0..1] Text that describes the entity in more detail description : string [0..1] The query parameters for a query-type entities query : base64Binary [0..1] Detail The type of extra detail provided in the value type : string CodeableConcept [1..1] « null (Strength=Example) AuditEventID ?? » The value of the extra detail value[x] : Element DataType [1..1] « Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | time | dateTime | Period | base64Binary » Logical network location for application activity, if Indicates whether the activity has a network location event succeeded or failed. A free text descripiton can be given in outcome.text network outcome [0..1] An actor taking an active role in the event or activity that is logged agent [1..*] The system actor that is reporting the event source [1..1] Tagged value pairs for conveying additional information about the entity detail [0..*] The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent agent [0..*] Specific instances of data or objects that have been accessed entity [0..*]

XML Template 

<

<AuditEvent xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</type>
 <</subtype>

 <category><!-- 0..* CodeableConcept Type/identifier of event --></category>
 <code><!-- 1..1 CodeableConcept Specific type of event --></code>

 <action value="[code]"/><!-- 0..1 Type of action performed during the event -->
 <</period>

 <severity value="[code]"/><!-- 0..1 emergency | alert | critical | error | warning | notice | informational | debug -->
 <occurred[x]><!-- 0..1 Period|dateTime When the activity occurred --></occurred[x]>

 <recorded value="[instant]"/><!-- 1..1 Time when the event was recorded -->
 <
 <
 <</purposeOfEvent>

 <outcome>  <!-- 0..1 Whether the event succeeded or failed -->
  <code><!-- 1..1 Coding Whether the event succeeded or failed --></code>
  <detail><!-- 0..* CodeableConcept Additional outcome detail --></detail>
 </outcome>
 <authorization><!-- 0..* CodeableConcept Authorization related to the event icon --></authorization>
 <basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ServiceRequest|Task) Workflow authorization within which this event occurred --></basedOn>

 <patient><!-- 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated --></encounter>

 <agent>  <!-- 1..* Actor involved in the event -->
  <</type>
  <</role>
  <|

  <type><!-- 0..1 CodeableConcept How agent participated --></type>
  <role><!-- 0..* CodeableConcept Agent role in the event --></role>
  <who><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) Identifier of who --></who>
  <
  <
  <
  <</location>
  <
  <</media>
  <
   <
   <
  </network>
  <</purposeOfUse>

  <requestor value="[boolean]"/><!-- 0..1 Whether user is initiator -->
  <location><!-- 0..1 Reference(Location) The agent location when the event occurred --></location>
  <policy value="[uri]"/><!-- 0..* Policy that authorized the agent participation in the event -->
  <network[x]><!-- 0..1 Reference(Endpoint)|uri|string This agent network location for the activity --></network[x]>
  <authorization><!-- 0..* CodeableConcept Allowable authorization for this agent icon --></authorization>

 </agent>
 <
  <
  <|

 <source>  <!-- 1..1 Audit Event Reporter -->
  <site><!-- 0..1 Reference(Location) Logical source location within the enterprise --></site>
  <observer><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) The identity of source detecting the event --></observer>
  <</type>

  <type><!-- 0..* CodeableConcept The type of source where event originated --></type>

 </source>
 <entity>  <!-- 0..* Data or objects used -->
  <</what>
  <</type>
  <</role>
  <</lifecycle>
  <</securityLabel>
  <
  <
  <

  <what><!-- 0..1 Reference(Any) Specific instance of resource --></what>
  <role><!-- 0..1 CodeableConcept What role the entity played --></role>
  <securityLabel><!-- 0..* CodeableConcept Security labels on the entity --></securityLabel>
  <query value="[base64Binary]"/><!-- 0..1 Query parameters -->

  <detail>  <!-- 0..* Additional Information about the entity -->
   <
   <</value[x]>

   <type><!-- 1..1 CodeableConcept Name of the property --></type>
   <value[x]><!-- 1..1 Quantity|CodeableConcept|string|boolean|integer|Range|
     Ratio|time|dateTime|Period|base64Binary Property value --></value[x]>
  </detail>
  <agent><!-- 0..* Content as for AuditEvent.agent Entity is attributed to this agent --></agent>

 </entity>
</AuditEvent>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "AuditEvent",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "

  "category" : [{ CodeableConcept }], // Type/identifier of event
  "code" : { CodeableConcept }, // R!  Specific type of event

  "action" : "<code>", // Type of action performed during the event
  "

  "severity" : "<code>", // emergency | alert | critical | error | warning | notice | informational | debug
  // occurred[x]: When the activity occurred. One of these 2:

  "occurredPeriod" : { Period },
  "occurredDateTime" : "<dateTime>",

  "recorded" : "<instant>", // R!  Time when the event was recorded
  "
  "
  "

  "outcome" : { // Whether the event succeeded or failed
    "code" : { Coding }, // R!  Whether the event succeeded or failed
    "detail" : [{ CodeableConcept }] // Additional outcome detail
  },
  "authorization" : [{ CodeableConcept }], // Authorization related to the event icon
  "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ServiceRequest|Task) }], // Workflow authorization within which this event occurred

  "patient" : { Reference(Patient) }, // The patient is the subject of the data used/created/updated/deleted during the activity
  "encounter" : { Reference(Encounter) }, // Encounter within which this event occurred or which the event is tightly associated

  "agent" : [{ // R!  Actor involved in the event
    "
    "
    "|
    
    "
    "
    "
    "
    "
    "
    "
      "
      "
    },
    "

    "type" : { CodeableConcept }, // How agent participated
    "role" : [{ CodeableConcept }], // Agent role in the event
    "who" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }, // R!  Identifier of who

    "requestor" : <boolean>, // Whether user is initiator
    "location" : { Reference(Location) }, // The agent location when the event occurred
    "policy" : ["<uri>"], // Policy that authorized the agent participation in the event
    // network[x]: This agent network location for the activity. One of these 3:

    "networkReference" : { Reference(Endpoint) },
    "networkUri" : "<uri>",
    "networkString" : "<string>",
    "authorization" : [{ CodeableConcept }] // Allowable authorization for this agent icon

  }],
  "
    "
    "|

  "source" : { // R!  Audit Event Reporter
    "site" : { Reference(Location) }, // Logical source location within the enterprise
    "observer" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) }, // R!  The identity of source detecting the event
    "

    "type" : [{ CodeableConcept }] // The type of source where event originated

  },
  "entity" : [{ // Data or objects used
    "
    "
    "
    "
    "
    "
    "
    "

    "what" : { Reference(Any) }, // Specific instance of resource
    "role" : { CodeableConcept }, // What role the entity played
    "securityLabel" : [{ CodeableConcept }], // Security labels on the entity
    "query" : "<base64Binary>", // Query parameters

    "detail" : [{ // Additional Information about the entity
      "
      
      ">"

      "type" : { CodeableConcept }, // R!  Name of the property
      // value[x]: Property value. One of these 11:

      "valueQuantity" : { Quantity },
      "valueCodeableConcept" : { CodeableConcept },
      "valueString" : "<string>",
      "valueBoolean" : <boolean>,
      "valueInteger" : <integer>,
      "valueRange" : { Range },
      "valueRatio" : { Ratio },
      "valueTime" : "<time>",
      "valueDateTime" : "<dateTime>",
      "valuePeriod" : { Period },

      "valueBase64Binary" : "<base64Binary>"
    }]

    }],
    "agent" : [{ Content as for AuditEvent.agent }] // Entity is attributed to this agent

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:;

[ a fhir:AuditEvent;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ];
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      # . One of these 2
        fhir: ]
        fhir: ]
    ], ...;
  ], ...;

  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Type/identifier of event
  fhir:code [ CodeableConcept ] ; # 1..1 Specific type of event
  fhir:action [ code ] ; # 0..1 Type of action performed during the event
  fhir:severity [ code ] ; # 0..1 emergency | alert | critical | error | warning | notice | informational | debug
  # occurred[x] : 0..1 When the activity occurred. One of these 2
    fhir:occurred [  a fhir:Period ; Period ]
    fhir:occurred [  a fhir:dateTime ; dateTime ]
  fhir:recorded [ instant ] ; # 1..1 Time when the event was recorded
  fhir:outcome [ # 0..1 Whether the event succeeded or failed
    fhir:code [ Coding ] ; # 1..1 Whether the event succeeded or failed
    fhir:detail  ( [ CodeableConcept ] ... ) ; # 0..* Additional outcome detail
  ] ;
  fhir:authorization  ( [ CodeableConcept ] ... ) ; # 0..* Authorization related to the event
  fhir:basedOn  ( [ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|
  NutritionOrder|ServiceRequest|Task) ] ... ) ; # 0..* Workflow authorization within which this event occurred

  fhir:patient [ Reference(Patient) ] ; # 0..1 The patient is the subject of the data used/created/updated/deleted during the activity
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter within which this event occurred or which the event is tightly associated
  fhir:agent ( [ # 1..* Actor involved in the event
    fhir:type [ CodeableConcept ] ; # 0..1 How agent participated
    fhir:role  ( [ CodeableConcept ] ... ) ; # 0..* Agent role in the event
    fhir:who [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 1..1 Identifier of who
    fhir:requestor [ boolean ] ; # 0..1 Whether user is initiator
    fhir:location [ Reference(Location) ] ; # 0..1 The agent location when the event occurred
    fhir:policy  ( [ uri ] ... ) ; # 0..* Policy that authorized the agent participation in the event
    # network[x] : 0..1 This agent network location for the activity. One of these 3
      fhir:network [  a fhir:Reference ; Reference(Endpoint) ]
      fhir:network [  a fhir:uri ; uri ]
      fhir:network [  a fhir:string ; string ]
    fhir:authorization  ( [ CodeableConcept ] ... ) ; # 0..* Allowable authorization for this agent
  ] ... ) ;
  fhir:source [ # 1..1 Audit Event Reporter
    fhir:site [ Reference(Location) ] ; # 0..1 Logical source location within the enterprise
    fhir:observer [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 1..1 The identity of source detecting the event
    fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The type of source where event originated
  ] ;
  fhir:entity ( [ # 0..* Data or objects used
    fhir:what [ Reference(Any) ] ; # 0..1 Specific instance of resource
    fhir:role [ CodeableConcept ] ; # 0..1 What role the entity played
    fhir:securityLabel  ( [ CodeableConcept ] ... ) ; # 0..* Security labels on the entity
    fhir:query [ base64Binary ] ; # 0..1 Query parameters
    fhir:detail ( [ # 0..* Additional Information about the entity
      fhir:type [ CodeableConcept ] ; # 1..1 Name of the property
      # value[x] : 1..1 Property value. One of these 11
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:string ; string ]
        fhir:value [  a fhir:boolean ; boolean ]
        fhir:value [  a fhir:integer ; integer ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:Ratio ; Ratio ]
        fhir:value [  a fhir:time ; time ]
        fhir:value [  a fhir:dateTime ; dateTime ]
        fhir:value [  a fhir:Period ; Period ]
        fhir:value [  a fhir:base64Binary ; base64Binary ]
    ] ... ) ;
    fhir:agent  ( [ See AuditEvent.agent ] ... ) ; # 0..* Entity is attributed to this agent
  ] ... ) ;

]

Changes since from both R4 and R4B

AuditEvent
AuditEvent.category
  • No Changes Renamed from type to category
  • Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-type` (extensible)
AuditEvent.code
  • Renamed from subtype to code
  • Min Cardinality changed from 0 to 1
  • Max Cardinality changed from * to 1
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-sub-type` (extensible)
AuditEvent.severity
  • Added Element
AuditEvent.occurred[x]
  • Added Element
AuditEvent.outcome
  • Type changed from code to BackboneElement
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.0` (required)
AuditEvent.outcome.code
  • Added Mandatory Element
AuditEvent.outcome.detail
  • Added Element
AuditEvent.authorization
  • Renamed from purposeOfEvent to authorization
  • Remove Binding `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` (extensible)
AuditEvent.basedOn
  • Added Element
AuditEvent.patient
  • Added Element
AuditEvent.encounter
  • Added Element
AuditEvent.agent.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/participation-role-type` (extensible)
AuditEvent.agent.who
  • Min Cardinality changed from 0 to 1
  • Type Reference: Added Target Type CareTeam
AuditEvent.agent.requestor
  • Min Cardinality changed from 1 to 0
AuditEvent.agent.network[x]
  • Renamed from network to network[x]
  • Add Types Reference(Endpoint), uri, string
  • Remove Type BackboneElement
AuditEvent.agent.authorization
  • Renamed from purposeOfUse to authorization
  • Remove Binding `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` (extensible)
AuditEvent.source.site
  • Type changed from string to Reference(Location)
AuditEvent.source.observer
  • Type Reference: Added Target Type CareTeam
AuditEvent.source.type
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-source-type` (extensible)
AuditEvent.entity.role
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/object-role` (extensible)
AuditEvent.entity.securityLabel
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/security-labels` (extensible)
AuditEvent.entity.detail.type
  • Type changed from string to CodeableConcept
AuditEvent.entity.detail.value[x]
  • Add Types Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period
AuditEvent.entity.agent
  • Added Element
AuditEvent.period
  • Deleted
AuditEvent.outcomeDesc
  • Deleted (-> outcome)
AuditEvent.agent.altId
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID)
AuditEvent.agent.name
  • Deleted (-> who.display)
AuditEvent.agent.media
  • Deleted (-> AuditEvent.entity)
AuditEvent.agent.network.address
  • Deleted (-> network[x])
AuditEvent.agent.network.type
  • Deleted (-> network[x])
AuditEvent.entity.type
  • Deleted (-> what.type)
AuditEvent.entity.lifecycle
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/auditevent-Lifecycle)
AuditEvent.entity.name
  • Deleted (-> what.display)
AuditEvent.entity.description
  • Deleted (-> entity.detail.valueString)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 8 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

Structure

Identifier for the network access point of the user device The type of network access point Reason given I string Descriptor for entity Descriptive text 0..1 Query parameters Additional Information about the entity Name of the property Property value
Name Flags Card. Type Description & Constraints doco
. . AuditEvent TU DomainResource Event record kept for security purposes Record of an event

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . type category Σ 1..1 0..* Coding CodeableConcept Type/identifier of event
Binding: Audit Event ID ( Extensible Example )

. . . subtype code Σ 0..* 1..1 Coding CodeableConcept More specific type/id for the Specific type of event
Binding: Audit Event Sub-Type ( Extensible Example )
. . . action Σ 0..1 code Type of action performed during the event
AuditEventAction Binding: Audit Event Action ( Required )
... occurred[x] 0..1 When the activity occurred
. . . . occurredPeriod Period
... . occurredDateTime dateTime
... recorded Σ 1..1 instant Time when the event was recorded
. . . outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... code Σ 0..1 1..1 code Coding Whether the event succeeded or failed
AuditEventOutcome Binding: Audit Event Outcome ( Required Preferred )
. . outcomeDesc . . detail Σ 0..1 0..* string CodeableConcept Description of the event Additional outcome detail
Binding: Audit Event Outcome Detail ( Example )

. . . purposeOfEvent authorization Σ 0..* CodeableConcept The purposeOfUse of Authorization related to the event
Binding: PurposeOfUse icon ( Extensible Example )

. . agent . basedOn 1..* 0..* BackboneElement Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task ) Actor involved in the Workflow authorization within which this event occurred

. . type . patient TU 0..1 CodeableConcept Reference ( Patient ) How agent participated The patient is the subject of the data used/created/updated/deleted during the activity
ParticipationRoleType ( Extensible )
. . role . encounter 0..* 0..1 CodeableConcept Reference ( Encounter ) Agent role in Encounter within which this event occurred or which the event SecurityRoleType ( Example ) is tightly associated
. . who . agent Σ 0..1 1..* Reference ( PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson BackboneElement ) Identifier of who Actor involved in the event

. . . altId . type 0..1 string CodeableConcept Alternative User identity How agent participated
Binding: Participation Role Type ( Preferred )
. . . name . role 0..1 0..* string CodeableConcept Human friendly name for Agent role in the agent event
Binding: Security Role Type ( Example )

. . . requestor . who Σ 1..1 boolean Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson ) Whether user is initiator Identifier of who
. . . location . requestor Σ 0..1 Reference ( Location boolean ) Where Whether user is initiator
. . . policy . location 0..* 0..1 uri Reference ( Location ) Policy that authorized The agent location when the event occurred
. . . media . policy 0..1 0..* Coding uri Type of media Policy that authorized the agent participation in the event

Media Type Code ( Extensible )
. . . network . network[x] 0..1 BackboneElement Logical This agent network location for application the activity
. . . . address . networkReference 0..1 string Reference ( Endpoint )
. . . . . type networkUri 0..1 uri code
. . . . . networkString AuditEventAgentNetworkType ( Required string )
. . . purposeOfUse . authorization 0..* CodeableConcept Allowable authorization for this user agent
Binding: PurposeOfUse icon ( Extensible Example )

. . . source Σ 1..1 BackboneElement Audit Event Reporter
. . . . site 0..1 string Reference ( Location ) Logical source location within the enterprise
. . . . observer Σ 1..1 Reference ( PractitionerRole | Practitioner | PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson ) The identity of source detecting the event
. . . . type 0..* Coding CodeableConcept The type of source where event originated
Binding: Audit Event Source Type ( Extensible Preferred )

. . . entity I Σ 0..* BackboneElement Data or objects used
+ Rule: Either a name or a query (NOT both)
. . . . what Σ 0..1 Reference ( Any ) Specific instance of resource
. . . type . role 0..1 CodeableConcept What role the entity played
Binding: Audit Event Entity Role ( Example )
.... securityLabel 0..1 0..* Coding CodeableConcept Type of Security labels on the entity involved
AuditEventEntityType Binding: Example set of Security Labels ( Extensible Example )

. . . role . query Σ 0..1 Coding base64Binary What role the entity played Query parameters
AuditEventEntityRole ( Extensible )
. . . lifecycle . detail 0..1 0..* Coding BackboneElement Life-cycle stage for Additional Information about the entity
ObjectLifecycleEvents ( Extensible )
. . . . . securityLabel type 0..* 1..1 Coding CodeableConcept Security labels on Name of the entity property
SecurityLabels Binding: Audit Event ID ( Extensible Example )
. . . name . . value[x] Σ 1..1 0..1 Property value
. . . . . . valueQuantity Quantity
. . . . . description . valueCodeableConcept CodeableConcept
. . . . . . valueString 0..1 string
. . . . . . query valueBoolean Σ boolean I
. . . . . . valueInteger base64Binary integer
. . . detail . . . valueRange Range
. . . . . . valueRatio 0..* BackboneElement Ratio
. . . . . . type valueTime 1..1 string time
. . . . value[x] . . valueDateTime 1..1 dateTime
. . . . . valueString . valuePeriod string Period
. . . . . . valueBase64Binary base64Binary
. . . . agent 0..* see agent Entity is attributed to this agent


doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

AuditEvent ( DomainResource ) Identifier for a family Classification of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function type of event category : Coding CodeableConcept [1..1] [0..*] « null (Strength=Extensible) (Strength=Example) AuditEventID + ?? » Identifier Describes what happened. The most specific code for the category of event subtype code : Coding CodeableConcept [0..*] [1..1] « null (Strength=Extensible) (Strength=Example) AuditEventSub-Type AuditEventSubType + ?? » Indicator for type of action performed during the event that generated the audit action : code [0..1] « null Indicator for type of action performed during the event that generated the event. (Strength=Required) AuditEventAction ! » Indicates and enables segmentation of various severity including debugging from critical severity : code [0..1] « The severity of the audit entry. (Strength=Required) AuditEventSeverity ! » The time or period during which the activity occurred period occurred[x] : Period DataType [0..1] « Period | dateTime » The time when the event was recorded recorded : instant [1..1] Indicates whether The authorization (e.g., PurposeOfUse) that was used during the event succeeded or failed being recorded outcome authorization : code CodeableConcept [0..1] [0..*] « null (Strength=Required) (Strength=Example) AuditEventOutcome ! PurposeOfUse ?? » A free text description Allows tracing of authorizatino for the outcome events and tracking whether proposals/recommendations were acted upon basedOn : Reference [0..*] « CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task » 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 patient : Reference [0..1] « Patient » 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) outcomeDesc encounter : string Reference [0..1] « Encounter » Outcome The purposeOfUse (reason) that was used during Indicates whether the event being recorded succeeded or failed purposeOfEvent code : Coding [1..1] « Indicates whether the event succeeded or failed. (Strength=Preferred) AuditEventOutcome ? » Additional details about the error. This may be a text description of the error or a system code that identifies the error detail : CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) PurposeOfUse AuditEventOutcomeDetail + ?? » Agent Specification The Functional Role of the participation type the user plays when performing the event type : CodeableConcept [0..1] « null (Strength=Extensible) (Strength=Preferred) ParticipationRoleType + ? » The security role that structural roles of the user was acting under, that come from local codes defined by agent indicating the access control agent's competency. The security system (e.g. RBAC, ABAC) used in role enabling the local context agent with respect to the activity role : CodeableConcept [0..*] « null (Strength=Example) SecurityRoleType ?? » Reference to who this agent is that was involved in the event who : Reference [0..1] [1..1] « PractitionerRole Practitioner | Practitioner PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson » 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 altId : string [0..1] Human-meaningful name for the agent name : string [0..1] Indicator that the user is or is not the requestor, or initiator, for the event being audited requestor : boolean [1..1] [0..1] Where the agent location is known, the agent location when the event occurred location : Reference [0..1] « Location » The policy or plan Where the policy(ies) are known that authorized the activity being recorded. agent participation in the event. 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 policy : uri [0..*] Type of media involved. Used when When the event is about exporting/importing onto media utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details media network[x] : Coding DataType [0..1] « null (Strength=Extensible) MediaTypeCode Reference ( Endpoint )| uri | string + » The reason (purpose of use), specific to this agent, authorization (e.g., PurposeOfUse) that was used during the event being recorded purposeOfUse authorization : CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) PurposeOfUse + » Network An identifier for the network access point of the user device for the audit event address : string [0..1] An identifier for the type of network access point that originated the audit event type : code [0..1] « null (Strength=Required) AuditEventAgentNetworkType ! ?? » Source Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group site : string Reference [0..1] « Location » Identifier of the source where the event was detected observer : Reference [1..1] « PractitionerRole Practitioner | Practitioner PractitionerRole | Organization | Device CareTeam | Patient | Device | RelatedPerson » Code specifying the type of source where event originated type : Coding CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Preferred) AuditEventSourceType + ? » Entity Identifies a specific instance of the entity. The reference should be version specific specific. This is allowed to be a Parameters resource what : Reference [0..1] « Any » The type of the object that was involved in this audit event type : Coding [0..1] « null (Strength=Extensible) AuditEventEntityType + » Code representing the role the entity played in the event being audited role : Coding CodeableConcept [0..1] « null (Strength=Extensible) AuditEventEntityRole + » Identifier for Code representing the data life-cycle stage for role the entity played in the audit event. (Strength=Example) lifecycle : Coding [0..1] « null (Strength=Extensible) ObjectLifecycleEvents AuditEventEntityRole + ?? » Security labels for the identified entity securityLabel : Coding CodeableConcept [0..*] « null (Strength=Extensible) (Strength=Example) All Security Labels SecurityLabelExamples + ?? » A name of the entity in the audit event name : string [0..1] Text that describes the entity in more detail description : string [0..1] The query parameters for a query-type entities query : base64Binary [0..1] Detail The type of extra detail provided in the value type : string CodeableConcept [1..1] « null (Strength=Example) AuditEventID ?? » The value of the extra detail value[x] : Element DataType [1..1] « Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | time | dateTime | Period | base64Binary » Logical network location for application activity, if Indicates whether the activity has a network location event succeeded or failed. A free text descripiton can be given in outcome.text network outcome [0..1] An actor taking an active role in the event or activity that is logged agent [1..*] The system actor that is reporting the event source [1..1] Tagged value pairs for conveying additional information about the entity detail [0..*] The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent agent [0..*] Specific instances of data or objects that have been accessed entity [0..*]

XML Template 

<

<AuditEvent xmlns="http://hl7.org/fhir"> doco

 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <</type>
 <</subtype>

 <category><!-- 0..* CodeableConcept Type/identifier of event --></category>
 <code><!-- 1..1 CodeableConcept Specific type of event --></code>

 <action value="[code]"/><!-- 0..1 Type of action performed during the event -->
 <</period>

 <severity value="[code]"/><!-- 0..1 emergency | alert | critical | error | warning | notice | informational | debug -->
 <occurred[x]><!-- 0..1 Period|dateTime When the activity occurred --></occurred[x]>

 <recorded value="[instant]"/><!-- 1..1 Time when the event was recorded -->
 <
 <
 <</purposeOfEvent>

 <outcome>  <!-- 0..1 Whether the event succeeded or failed -->
  <code><!-- 1..1 Coding Whether the event succeeded or failed --></code>
  <detail><!-- 0..* CodeableConcept Additional outcome detail --></detail>
 </outcome>
 <authorization><!-- 0..* CodeableConcept Authorization related to the event icon --></authorization>
 <basedOn><!-- 0..* Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ServiceRequest|Task) Workflow authorization within which this event occurred --></basedOn>

 <patient><!-- 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity --></patient>
 <encounter><!-- 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated --></encounter>

 <agent>  <!-- 1..* Actor involved in the event -->
  <</type>
  <</role>
  <|

  <type><!-- 0..1 CodeableConcept How agent participated --></type>
  <role><!-- 0..* CodeableConcept Agent role in the event --></role>
  <who><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) Identifier of who --></who>
  <
  <
  <
  <</location>
  <
  <</media>
  <
   <
   <
  </network>
  <</purposeOfUse>

  <requestor value="[boolean]"/><!-- 0..1 Whether user is initiator -->
  <location><!-- 0..1 Reference(Location) The agent location when the event occurred --></location>
  <policy value="[uri]"/><!-- 0..* Policy that authorized the agent participation in the event -->
  <network[x]><!-- 0..1 Reference(Endpoint)|uri|string This agent network location for the activity --></network[x]>
  <authorization><!-- 0..* CodeableConcept Allowable authorization for this agent icon --></authorization>

 </agent>
 <
  <
  <|

 <source>  <!-- 1..1 Audit Event Reporter -->
  <site><!-- 0..1 Reference(Location) Logical source location within the enterprise --></site>
  <observer><!-- 1..1 Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) The identity of source detecting the event --></observer>
  <</type>

  <type><!-- 0..* CodeableConcept The type of source where event originated --></type>

 </source>
 <entity>  <!-- 0..* Data or objects used -->
  <</what>
  <</type>
  <</role>
  <</lifecycle>
  <</securityLabel>
  <
  <
  <

  <what><!-- 0..1 Reference(Any) Specific instance of resource --></what>
  <role><!-- 0..1 CodeableConcept What role the entity played --></role>
  <securityLabel><!-- 0..* CodeableConcept Security labels on the entity --></securityLabel>
  <query value="[base64Binary]"/><!-- 0..1 Query parameters -->

  <detail>  <!-- 0..* Additional Information about the entity -->
   <
   <</value[x]>

   <type><!-- 1..1 CodeableConcept Name of the property --></type>
   <value[x]><!-- 1..1 Quantity|CodeableConcept|string|boolean|integer|Range|
     Ratio|time|dateTime|Period|base64Binary Property value --></value[x]>
  </detail>
  <agent><!-- 0..* Content as for AuditEvent.agent Entity is attributed to this agent --></agent>

 </entity>
</AuditEvent>

JSON Template 

{doco
  "resourceType" : "",

  "resourceType" : "AuditEvent",

  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "
  "

  "category" : [{ CodeableConcept }], // Type/identifier of event
  "code" : { CodeableConcept }, // R!  Specific type of event

  "action" : "<code>", // Type of action performed during the event
  "

  "severity" : "<code>", // emergency | alert | critical | error | warning | notice | informational | debug
  // occurred[x]: When the activity occurred. One of these 2:

  "occurredPeriod" : { Period },
  "occurredDateTime" : "<dateTime>",

  "recorded" : "<instant>", // R!  Time when the event was recorded
  "
  "
  "

  "outcome" : { // Whether the event succeeded or failed
    "code" : { Coding }, // R!  Whether the event succeeded or failed
    "detail" : [{ CodeableConcept }] // Additional outcome detail
  },
  "authorization" : [{ CodeableConcept }], // Authorization related to the event icon
  "basedOn" : [{ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|
   MedicationRequest|NutritionOrder|ServiceRequest|Task) }], // Workflow authorization within which this event occurred

  "patient" : { Reference(Patient) }, // The patient is the subject of the data used/created/updated/deleted during the activity
  "encounter" : { Reference(Encounter) }, // Encounter within which this event occurred or which the event is tightly associated

  "agent" : [{ // R!  Actor involved in the event
    "
    "
    "|
    
    "
    "
    "
    "
    "
    "
    "
      "
      "
    },
    "

    "type" : { CodeableConcept }, // How agent participated
    "role" : [{ CodeableConcept }], // Agent role in the event
    "who" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|
    PractitionerRole|RelatedPerson) }, // R!  Identifier of who

    "requestor" : <boolean>, // Whether user is initiator
    "location" : { Reference(Location) }, // The agent location when the event occurred
    "policy" : ["<uri>"], // Policy that authorized the agent participation in the event
    // network[x]: This agent network location for the activity. One of these 3:

    "networkReference" : { Reference(Endpoint) },
    "networkUri" : "<uri>",
    "networkString" : "<string>",
    "authorization" : [{ CodeableConcept }] // Allowable authorization for this agent icon

  }],
  "
    "
    "|

  "source" : { // R!  Audit Event Reporter
    "site" : { Reference(Location) }, // Logical source location within the enterprise
    "observer" : { Reference(CareTeam|Device|Organization|Patient|Practitioner|

    PractitionerRole|RelatedPerson) }, // R!  The identity of source detecting the event
    "

    "type" : [{ CodeableConcept }] // The type of source where event originated

  },
  "entity" : [{ // Data or objects used
    "
    "
    "
    "
    "
    "
    "
    "

    "what" : { Reference(Any) }, // Specific instance of resource
    "role" : { CodeableConcept }, // What role the entity played
    "securityLabel" : [{ CodeableConcept }], // Security labels on the entity
    "query" : "<base64Binary>", // Query parameters

    "detail" : [{ // Additional Information about the entity
      "
      
      ">"

      "type" : { CodeableConcept }, // R!  Name of the property
      // value[x]: Property value. One of these 11:

      "valueQuantity" : { Quantity },
      "valueCodeableConcept" : { CodeableConcept },
      "valueString" : "<string>",
      "valueBoolean" : <boolean>,
      "valueInteger" : <integer>,
      "valueRange" : { Range },
      "valueRatio" : { Ratio },
      "valueTime" : "<time>",
      "valueDateTime" : "<dateTime>",
      "valuePeriod" : { Period },

      "valueBase64Binary" : "<base64Binary>"
    }]

    }],
    "agent" : [{ Content as for AuditEvent.agent }] // Entity is attributed to this agent

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:;

[ a fhir:AuditEvent;

  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ];
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
    fhir:
  ];
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      # . One of these 2
        fhir: ]
        fhir: ]
    ], ...;
  ], ...;

  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Type/identifier of event
  fhir:code [ CodeableConcept ] ; # 1..1 Specific type of event
  fhir:action [ code ] ; # 0..1 Type of action performed during the event
  fhir:severity [ code ] ; # 0..1 emergency | alert | critical | error | warning | notice | informational | debug
  # occurred[x] : 0..1 When the activity occurred. One of these 2
    fhir:occurred [  a fhir:Period ; Period ]
    fhir:occurred [  a fhir:dateTime ; dateTime ]
  fhir:recorded [ instant ] ; # 1..1 Time when the event was recorded
  fhir:outcome [ # 0..1 Whether the event succeeded or failed
    fhir:code [ Coding ] ; # 1..1 Whether the event succeeded or failed
    fhir:detail  ( [ CodeableConcept ] ... ) ; # 0..* Additional outcome detail
  ] ;
  fhir:authorization  ( [ CodeableConcept ] ... ) ; # 0..* Authorization related to the event
  fhir:basedOn  ( [ Reference(CarePlan|DeviceRequest|ImmunizationRecommendation|MedicationRequest|
  NutritionOrder|ServiceRequest|Task) ] ... ) ; # 0..* Workflow authorization within which this event occurred

  fhir:patient [ Reference(Patient) ] ; # 0..1 The patient is the subject of the data used/created/updated/deleted during the activity
  fhir:encounter [ Reference(Encounter) ] ; # 0..1 Encounter within which this event occurred or which the event is tightly associated
  fhir:agent ( [ # 1..* Actor involved in the event
    fhir:type [ CodeableConcept ] ; # 0..1 How agent participated
    fhir:role  ( [ CodeableConcept ] ... ) ; # 0..* Agent role in the event
    fhir:who [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 1..1 Identifier of who
    fhir:requestor [ boolean ] ; # 0..1 Whether user is initiator
    fhir:location [ Reference(Location) ] ; # 0..1 The agent location when the event occurred
    fhir:policy  ( [ uri ] ... ) ; # 0..* Policy that authorized the agent participation in the event
    # network[x] : 0..1 This agent network location for the activity. One of these 3
      fhir:network [  a fhir:Reference ; Reference(Endpoint) ]
      fhir:network [  a fhir:uri ; uri ]
      fhir:network [  a fhir:string ; string ]
    fhir:authorization  ( [ CodeableConcept ] ... ) ; # 0..* Allowable authorization for this agent
  ] ... ) ;
  fhir:source [ # 1..1 Audit Event Reporter
    fhir:site [ Reference(Location) ] ; # 0..1 Logical source location within the enterprise
    fhir:observer [ Reference(CareTeam|Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ] ; # 1..1 The identity of source detecting the event
    fhir:type  ( [ CodeableConcept ] ... ) ; # 0..* The type of source where event originated
  ] ;
  fhir:entity ( [ # 0..* Data or objects used
    fhir:what [ Reference(Any) ] ; # 0..1 Specific instance of resource
    fhir:role [ CodeableConcept ] ; # 0..1 What role the entity played
    fhir:securityLabel  ( [ CodeableConcept ] ... ) ; # 0..* Security labels on the entity
    fhir:query [ base64Binary ] ; # 0..1 Query parameters
    fhir:detail ( [ # 0..* Additional Information about the entity
      fhir:type [ CodeableConcept ] ; # 1..1 Name of the property
      # value[x] : 1..1 Property value. One of these 11
        fhir:value [  a fhir:Quantity ; Quantity ]
        fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
        fhir:value [  a fhir:string ; string ]
        fhir:value [  a fhir:boolean ; boolean ]
        fhir:value [  a fhir:integer ; integer ]
        fhir:value [  a fhir:Range ; Range ]
        fhir:value [  a fhir:Ratio ; Ratio ]
        fhir:value [  a fhir:time ; time ]
        fhir:value [  a fhir:dateTime ; dateTime ]
        fhir:value [  a fhir:Period ; Period ]
        fhir:value [  a fhir:base64Binary ; base64Binary ]
    ] ... ) ;
    fhir:agent  ( [ See AuditEvent.agent ] ... ) ; # 0..* Entity is attributed to this agent
  ] ... ) ;

]

Changes since Release 4 from both R4 and R4B

AuditEvent
AuditEvent.category
  • No Changes Renamed from type to category
  • Min Cardinality changed from 1 to 0
  • Max Cardinality changed from 1 to *
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-type` (extensible)
AuditEvent.code
  • Renamed from subtype to code
  • Min Cardinality changed from 0 to 1
  • Max Cardinality changed from * to 1
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-sub-type` (extensible)
AuditEvent.severity
  • Added Element
AuditEvent.occurred[x]
  • Added Element
AuditEvent.outcome
  • Type changed from code to BackboneElement
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.0` (required)
AuditEvent.outcome.code
  • Added Mandatory Element
AuditEvent.outcome.detail
  • Added Element
AuditEvent.authorization
  • Renamed from purposeOfEvent to authorization
  • Remove Binding `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` (extensible)
AuditEvent.basedOn
  • Added Element
AuditEvent.patient
  • Added Element
AuditEvent.encounter
  • Added Element
AuditEvent.agent.type
  • Remove Binding `http://hl7.org/fhir/ValueSet/participation-role-type` (extensible)
AuditEvent.agent.who
  • Min Cardinality changed from 0 to 1
  • Type Reference: Added Target Type CareTeam
AuditEvent.agent.requestor
  • Min Cardinality changed from 1 to 0
AuditEvent.agent.network[x]
  • Renamed from network to network[x]
  • Add Types Reference(Endpoint), uri, string
  • Remove Type BackboneElement
AuditEvent.agent.authorization
  • Renamed from purposeOfUse to authorization
  • Remove Binding `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` (extensible)
AuditEvent.source.site
  • Type changed from string to Reference(Location)
AuditEvent.source.observer
  • Type Reference: Added Target Type CareTeam
AuditEvent.source.type
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/audit-source-type` (extensible)
AuditEvent.entity.role
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/object-role` (extensible)
AuditEvent.entity.securityLabel
  • Type changed from Coding to CodeableConcept
  • Remove Binding `http://hl7.org/fhir/ValueSet/security-labels` (extensible)
AuditEvent.entity.detail.type
  • Type changed from string to CodeableConcept
AuditEvent.entity.detail.value[x]
  • Add Types Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period
AuditEvent.entity.agent
  • Added Element
AuditEvent.period
  • Deleted
AuditEvent.outcomeDesc
  • Deleted (-> outcome)
AuditEvent.agent.altId
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/auditevent-AlternativeUserID)
AuditEvent.agent.name
  • Deleted (-> who.display)
AuditEvent.agent.media
  • Deleted (-> AuditEvent.entity)
AuditEvent.agent.network.address
  • Deleted (-> network[x])
AuditEvent.agent.network.type
  • Deleted (-> network[x])
AuditEvent.entity.type
  • Deleted (-> what.type)
AuditEvent.entity.lifecycle
  • Deleted (-> use extension http://hl7.org/fhir/StructureDefinition/auditevent-Lifecycle)
AuditEvent.entity.name
  • Deleted (-> what.display)
AuditEvent.entity.description
  • Deleted (-> entity.detail.valueString)

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 8 tests that all execute ok. All tests pass round-trip testing and all r3 resources are valid.) See Conversions Summary .)

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis

6.4.4.1 Terminology Bindings

AuditEvent.outcome AuditEvent.purposeOfEvent AuditEvent.agent.type AuditEvent.agent.role AuditEvent.agent.media AuditEvent.agent.network.type AuditEvent.entity.type AuditEvent.entity.lifecycle 6.4.4.2 Constraints id Level Location Description name.empty() or query.empty()
Path Definition ValueSet Type Reference Documentation
AuditEvent.type AuditEvent.category AuditEventID Extensible Example AuditEventID

Event Categories for Audit Events - defined by DICOM with some FHIR specific additions.

AuditEvent.subtype AuditEvent.code AuditEventSubType Extensible Example AuditEventSub-Type

More detailed code concerning the type of the audit event - defined by DICOM with some additional FHIR, HL7, and other additions.

AuditEvent.action AuditEventAction Required AuditEventAction

Indicator for type of action performed during the event that generated the event.

AuditEvent.severity AuditEventSeverity Required AuditEventOutcome

The severity of the audit entry.

AuditEvent.outcome.code AuditEventOutcome (a valid code from Issue Severity ) Extensible Preferred PurposeOfUse

Indicates whether the event succeeded or failed.

AuditEvent.outcome.detail AuditEventOutcomeDetail (a valid code from Operation Outcome Codes icon ) Extensible Example ParticipationRoleType

Indicates more detailed reason for outcome.

AuditEvent.authorization PurposeOfUse icon Example SecurityRoleType

Supports communication of purpose of use at a general level.

AuditEvent.agent.type ParticipationRoleType Extensible Preferred MediaTypeCode

This FHIR value set is comprised of Actor participation Type codes, which can be used to value FHIR agents, actors, and other role elements. The codes are intended to express how the agent participated in some activity. Sometimes refered to the agent functional-role relative to the activity.

AuditEvent.agent.role SecurityRoleType (a valid code from Sample Codes for Security Structural Role ) Required Example AuditEventAgentNetworkType

This value set contains example structural roles. In general, two types of roles can be distinguished: structural roles and functional roles. Structural Roles reflect human or organizational categories (hierarchies), and describe prerequisites, feasibilities, or competences for actions. Functional roles are bound to the realization or performance of actions.

AuditEvent.agent.purposeOfUse AuditEvent.agent.authorization PurposeOfUse icon Extensible Example PurposeOfUse

Supports communication of purpose of use at a general level.

AuditEvent.source.type Extensible AuditEventSourceType Extensible Preferred AuditEventEntityType

The type of process where the audit event originated from. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.

AuditEvent.entity.role Extensible AuditEventEntityRole Extensible Example ObjectLifecycleEvents

Code representing the role the entity played in the audit event.

AuditEvent.entity.securityLabel SecurityLabelExamples Extensible Example All

A sample of security labels from Healthcare Privacy and Security Labels Classification System as the combination of data and event codes.

AuditEvent.entity.detail.type Expression AuditEventID sev-1 Rule Example AuditEvent.entity Either a name or a query (NOT both)

Event Categories for Audit Events - defined by DICOM with some FHIR specific additions.

6.4.4.3 6.4.4.2 Using Coded Values

The AuditEvent resource and the ATNA Audit record are used in many contexts throughout healthcare. The coded values defined in the "extensible" bindings above are those widely used and/or defined by DICOM, IHE or ISO, who defined these codes to meet very specific use cases. These codes should be used when they are suitable. When needed, other codes can be defined.

Note: When using codes from a vocabulary, the display element for the code can be left off to keep the AuditEvent size small and minimize impact of a large audit log of similar entries.

The set of codes defined for this resource is expected to grow over time, and additional codes may be proposed / requested using the "Propose a change" link above below.

6.4.4.4 6.4.4.3 Event codes for Common Scenarios

This table summarizes common event scenarios, and the codes that should be used for each case.

Scenario type category subtype code action Other
User Login ( example ) 110114 icon User Authentication 110122 icon User Authentication E Execute One agent which contains the details of the logged-in user.
User Logout ( example ) 110114 icon User Authentication 110123 icon User Logout E Execute One agent which contains the details of the logged-out user.
REST operation logged on server ( example ) rest RESTful Operation [code] defined for operation * (see below) Agent for logged in user, if available.
Search operation logged on server ( example ) rest RESTful Operation [code] defined for operation E Execute Agent for logged in user, if available, and one object with a query element. The Execute action is used as the server must execute the search parameters to get the results, whereas a Read action identifies a specific object.
Break-Glass started ( example ) 110113 icon Security Alert 110127 icon Emergency Override Started E Execute Agent is the user who is authorized to break-glass and has declared an emergency override. Note there is an Emergency Override Stopped code that can be used to indicate the closing of the break-glass event, when it is known.

Audit Event Actions for RESTful operations:

Operation Action
create C
read, vread, history-instance, history-type, history-system R
update U
delete D
transaction, operation, conformance, validate, search, search-type, search-system E

6.4.4.3.1 Recording Search Events

A search event is recorded as an Execute action as the server must execute the search parameters to get the results. The category is a rest operation. The code should be search . The Server is identified in an .agent as the role Destination Role ID , and the client is identified in an .agent as the role Source Role ID . Additional .agent elements may be used to identify user, application, organization, etc.

A Search Event records one .entity element that holds the search request, and should not record the contents of the search response so as to limit duplication of sensitive health information that is already present in the system, and discoverable by replaying the search request.

The AuditEvent.entity.query shall hold the whole WHOLE http header and body encoded as base64binary. This should preserve as much of the raw http header and body as possible to best capture any attempts by clients or intermediaries to misbehave. There should be no sanitization or normalization of this value.

The FHIR specification defines a harmonized search parameter string, which is returned in the searchset bundle as the .link.url on the .link for self. This string could be recorded in the AuditEvent.entry.description as it is well behaved and represents what was actually processed as search parameters. See: conformance icon

Where there are identifiable Patient subject(s) associated with the returned Resource(s), the AuditEvent.patient should be used to record the Patient as the subject of the data or activity. When multiple patient results are returned one AuditEvent is created for every Patient identified in the resulting search set. Note this is true when the search set bundle includes any number of resources that collectively reference multiple Patients. This includes one Resource with multiple subject values, or many Resources with single subject values that are different.

6.4.4.5 6.4.4.4 Encoding a FHIR operation outcome

FHIR interactions can result in a rich description of the outcome using the OperationOutcome . The OperationOutcome Resource is a collection of error, warning or information messages that result from a system action. This describes in detail the outcome of some operation, such as when a RESTful operation fails.

When recording into an AuditEvent that some FHIR interaction has happened, the AuditEvent should include the OperationOutcome from that FHIR interaction. This is done by placing the OperationOutcome into an AuditEvent.entity. Likely as a contained resource, given that OperationOutcome resources often are not persisted.

entity.who entity.what is the OperationOutcome -- Likely contained

entity.type is code OperationOutcome

entity.description explains why this OperationOutcome was included.

See transaction failure example : When a client attempts to post (create) an Observation Resource, using a server Patient endpoint; this would result in an error with an OperationOutcome.

6.4.4.6 6.4.4.5 PurposeOfEvent authorization and PurposeOfUse agent.authorization

The AuditEvent provides the element purposeOfEvent AudientEvent.authorization to convey the purpose of use for the whole event and purposeOfUse AuditEvent.agent.authorization to convey the reason purpose of use that a particular actor (machine, person, software) was involved in the event.

purposeOfEvent AuditEvent.authorization is an element at the level of AuditEvent and can convey the purpose of the activity that resulted in the event. This will occur when the system that is reporting the event is aware of the purpose of the event. A specific example would be a radiology reporting system where a radiologist has created and is sending a finished report. This system likely knows the purpose, e.g., "treatment". It is multi-valued because the one event may be related to multiple purposes.

It is also commonplace that the reporting system does not have information about the purpose of the event. In these cases, the event report would not have a purposeOfEvent. an authorization.

It is also likely that the same event will be reported from different perspectives, e.g., by both the sender and recipient of a communication. These two different perspectives can have different knowledge regarding the purposeOfEvent . purposeOfUse authorization.

purposeOfUse AuditEvent.agent.authorization is an element at the level of agent within AuditEvent. This describes the reason that this person, machine, or software is participating in the activity that resulted in the event. For example, an individual person participating in the event may assert a purpose of use from their perspective. It is also possible that they are participating for multiple reasons and report multiple purposeOfUse.

The reporting system might not have knowledge regarding why a particular machine or person was involved and would omit this element in those cases.

When the same event is reported from multiple perspectives, the reports can have different knowledge regarding the purpose.

6.4.4.6 Patient as subject of data or activity reference in AuditEvent.patient

It is a best practice to include a reference to the Patient affected by any auditable event, in order to enable Privacy Accounting of Disclosures and Access Logs, and to enable privacy office and security office audit log analysis. Reasonable efforts should be taken to assure the Patient is recorded, but it is recognized that there are times when this is not reasonable.

Where an activity impacts more than one Patient subject; multiple AuditEvent resources should be recorded, one for each Patient subject. This best enables segmentation of the AuditEvent details so as to limit the Privacy impact. The use of multiple AuditEvent is a best-practice and should be driven by a Policy. There will be cases where the use of multiple AuditEvent resources are not necessary, such as public health reporting.

To record a REST interaction or $operation, it is often necessary to complete the transaction in order to determine the Patient subject. Inspection of the potential returned results may be necessary. Some REST and $operations include parameters limiting the results to a specific Patient, in these cases this parameter informs the inclusion of the Patient reference.

Implementation Guides may make the AuditEvent requirements more clear given the workflow or security context mandated by the Implementation Guide.

6.4.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

subtype token More specific type/id for the event AuditEvent.subtype type token Type/identifier of event AuditEvent.type
Name Type Description Expression In Common
action token Type of action performed during the event AuditEvent.action
address string agent Identifier for the network access point of the user device AuditEvent.agent.network.address agent reference Identifier of who AuditEvent.agent.who
( Practitioner , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson )
agent-name agent-role string token Human friendly name for Agent role in the agent event AuditEvent.agent.name AuditEvent.agent.role
agent-role based-on token reference Agent role in Reference to the event service request. AuditEvent.agent.role AuditEvent.basedOn
( CarePlan , MedicationRequest , Task , NutritionOrder , DeviceRequest , ServiceRequest , ImmunizationRecommendation )
altid category token Alternative User identity Category of event AuditEvent.agent.altId AuditEvent.category
date code date token Time when More specific code for the event was recorded AuditEvent.recorded AuditEvent.code 22 Resources
entity date reference date Specific instance of resource Time when the event was recorded AuditEvent.entity.what (Any) AuditEvent.recorded 27 Resources
entity-name encounter string reference Descriptor for entity Encounter related to the activity recorded in the AuditEvent AuditEvent.entity.name AuditEvent.encounter
( Encounter ) 		29 Resources
entity-role entity token reference What role the entity played Specific instance of resource AuditEvent.entity.role AuditEvent.entity.what
(Any)
entity-type entity-role token Type of What role the entity involved played AuditEvent.entity.type AuditEvent.entity.role
outcome token Whether the event succeeded or failed AuditEvent.outcome AuditEvent.outcome.code
patient reference Identifier of who Where the activity involved patient data AuditEvent.agent.who.where(resolve() is Patient) | AuditEvent.entity.what.where(resolve() is Patient) AuditEvent.patient
( Patient ) 		66 Resources
policy uri Policy that authorized event AuditEvent.agent.policy
site purpose token Logical source location within The authorization (purposeOfUse) of the enterprise event AuditEvent.source.site AuditEvent.authorization | AuditEvent.agent.authorization
source reference The identity of source detecting the event AuditEvent.source.observer
( Practitioner , Organization , CareTeam , Device , Patient , PractitionerRole , RelatedPerson )