Release 5 Snapshot #1

This page is part of the FHIR Specification (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2

Electronic Health Records Work Group Maturity Level: 1Trial Use Use Context: Any

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent

Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

This profile was published on Thu, Dec 4, 2014 00:00+1100 as a draft by Health Level Seven International (Electronic Health Record).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from AuditEvent.

Summary

Must-Support: 20 elements

This structure is derived from AuditEvent.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... category S0..*CodeableConceptType/identifier of event
... code S1..1CodeableConceptSpecific type of event
... action S0..1codeType of action performed during the event
... outcome 0..1BackboneElementWhether the event succeeded or failed
.... code 1..1CodingWhether the event succeeded or failed
.... detail 0..*CodeableConceptAdditional outcome detail
... authorization S0..*CodeableConceptAuthorization related to the event
... agent S1..*BackboneElementActor involved in the event
.... role S0..*CodeableConceptAgent role in the event
.... who S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Identifier of who
.... requestor S0..1booleanWhether user is initiator
.... location S0..1Reference(Location)The agent location when the event occurred
.... policy S0..*uriPolicy that authorized the agent participation in the event
.... authorization S0..*CodeableConceptAllowable authorization for this agent
... source S1..1BackboneElementAudit Event Reporter
.... site S0..1Reference(Location)Logical source location within the enterprise
.... observer S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)The identity of source detecting the event
.... type S0..*CodeableConceptThe type of source where event originated
... entity S0..*BackboneElementData or objects used
.... what S0..1Reference(Resource)Specific instance of resource
.... role S0..1CodeableConceptWhat role the entity played
.... securityLabel S0..*CodeableConceptSecurity labels on the entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... category SΣ0..*CodeableConceptType/identifier of event
Binding: Audit Event ID (example): Type of event.


... code SΣ1..1CodeableConceptSpecific type of event
Binding: Audit Event Sub-Type (example): Specific type of event.

... action SΣ0..1codeType of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action

... severity Σ0..1codeemergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3

... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantTime when the event was recorded
... outcome Σ0..1BackboneElementWhether the event succeeded or failed
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodingWhether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome

.... detail Σ0..*CodeableConceptAdditional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.


... authorization SΣ0..*CodeableConceptAuthorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.


... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task)Workflow authorization within which this event occurred
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent S1..*BackboneElementActor involved in the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.

.... role S0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


.... who SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Identifier of who
.... requestor SΣ0..1booleanWhether user is initiator
.... location S0..1Reference(Location)The agent location when the event occurred
.... policy S0..*uriPolicy that authorized the agent participation in the event
.... network[x] 0..1This agent network location for the activity
..... networkReferenceReference(Endpoint)
..... networkUriuri
..... networkStringstring
.... authorization S0..*CodeableConceptAllowable authorization for this agent
Binding: PurposeOfUse (example): The reason the activity took place.


... source S1..1BackboneElementAudit Event Reporter
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site S0..1Reference(Location)Logical source location within the enterprise
.... observer SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)The identity of source detecting the event
.... type S0..*CodeableConceptThe type of source where event originated
Binding: Audit Event Source Type (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.


... entity S0..*BackboneElementData or objects used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣ0..1Reference(Resource)Specific instance of resource
.... role S0..1CodeableConceptWhat role the entity played
Binding: AuditEventEntityRole (extensible): DICOM Audit Event Entity Role

.... securityLabel S0..*CodeableConceptSecurity labels on the entity
Binding: SecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... query Σ0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptName of the property
Binding: Audit Event ID (example): Additional detail about an entity used in an event.

..... value[x] 1..1Property value
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueBase64Binarybase64Binary
.... agent 0..*See agent (AuditEvent)Entity is attributed to this agent

doco Documentation for this format
<!-- EHRS FM Record Lifecycle Event - Audit Event -->doco

<AuditEvent xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <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   -->
 <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 -->
 <outcome> ?? 0..1 BackboneElement  <!-- ?? 0..1 Whether the event succeeded or failed -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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    --></authorization>
 <basedOn><!-- ?? 0..* Reference(CarePlan) 
     Workflow authorization within which this event occurred --></basedOn>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter within which this event occurred or which the event is tightly associated --></encounter>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved in the event -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept Agent role in the event   --></role>
  <who><!-- ?? 1..1 Reference(Practitioner) Identifier of who --></who>
  <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    --></authorization>
 </agent>
 <source> ?? 1..1 BackboneElement  <!-- ?? 1..1 Audit Event Reporter -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <site><!-- ?? 0..1 Reference(Location) 
      Logical source location within the enterprise --></site>
  <observer><!-- ?? 1..1 Reference(Practitioner) 
      The identity of source detecting the event --></observer>
  <type><!-- ?? 0..* CodeableConcept The type of source where event originated   --></type>
 </source>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* Data or objects used -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <what><!-- ?? 0..1 Reference(Resource) 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..* BackboneElement  <!-- ?? 0..* Additional Information about the entity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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><!-- See http://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent  Entity is attributed to this agent --></agent>
 </entity>
</AuditEvent>
{ // EHRS FM Record Lifecycle Event - Audit Event
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "category" : [{ CodeableConcept }], // C?Type/identifier of event
    "code" : { CodeableConcept }, // C? R! Specific type of event
    "action" : "<code>", // C?Type of action performed during the event
    "severity" : "<code>", // C?emergency | alert | critical | error | warning | notice | informational | debug
// value[x]: When the activity occurred. One of these 2:
    "occurredPeriod" : { Period }, // C?When the activity occurred
    "occurredDateTime" : "<dateTime>", // C?When the activity occurred
    "recorded" : "<instant>", // C? R! Time when the event was recorded
    "outcome" : { BackboneElement }, // C?Whether the event succeeded or failed
    "authorization" : [{ CodeableConcept }], // C?Authorization related to the event 
    "basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
    "encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
    "agent" : [{ BackboneElement }], // C? R! Actor involved in the event
    "source" : { BackboneElement } // C? R! Audit Event Reporter
    "entity" : [{ BackboneElement }], // C?Data or objects used
  }

This structure is derived from AuditEvent.

Summary

Must-Support: 20 elements

Differential View

This structure is derived from AuditEvent.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... category S0..*CodeableConceptType/identifier of event
... code S1..1CodeableConceptSpecific type of event
... action S0..1codeType of action performed during the event
... outcome 0..1BackboneElementWhether the event succeeded or failed
.... code 1..1CodingWhether the event succeeded or failed
.... detail 0..*CodeableConceptAdditional outcome detail
... authorization S0..*CodeableConceptAuthorization related to the event
... agent S1..*BackboneElementActor involved in the event
.... role S0..*CodeableConceptAgent role in the event
.... who S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Identifier of who
.... requestor S0..1booleanWhether user is initiator
.... location S0..1Reference(Location)The agent location when the event occurred
.... policy S0..*uriPolicy that authorized the agent participation in the event
.... authorization S0..*CodeableConceptAllowable authorization for this agent
... source S1..1BackboneElementAudit Event Reporter
.... site S0..1Reference(Location)Logical source location within the enterprise
.... observer S1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)The identity of source detecting the event
.... type S0..*CodeableConceptThe type of source where event originated
... entity S0..*BackboneElementData or objects used
.... what S0..1Reference(Resource)Specific instance of resource
.... role S0..1CodeableConceptWhat role the entity played
.... securityLabel S0..*CodeableConceptSecurity labels on the entity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventRecord of an event
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... category SΣ0..*CodeableConceptType/identifier of event
Binding: Audit Event ID (example): Type of event.


... code SΣ1..1CodeableConceptSpecific type of event
Binding: Audit Event Sub-Type (example): Specific type of event.

... action SΣ0..1codeType of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action

... severity Σ0..1codeemergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3

... occurred[x] 0..1When the activity occurred
.... occurredPeriodPeriod
.... occurredDateTimedateTime
... recorded SΣ1..1instantTime when the event was recorded
... outcome Σ0..1BackboneElementWhether the event succeeded or failed
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodingWhether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome

.... detail Σ0..*CodeableConceptAdditional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.


... authorization SΣ0..*CodeableConceptAuthorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.


... basedOn 0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task)Workflow authorization within which this event occurred
... encounter 0..1Reference(Encounter)Encounter within which this event occurred or which the event is tightly associated
... agent S1..*BackboneElementActor involved in the event
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.

.... role S0..*CodeableConceptAgent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


.... who SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Identifier of who
.... requestor SΣ0..1booleanWhether user is initiator
.... location S0..1Reference(Location)The agent location when the event occurred
.... policy S0..*uriPolicy that authorized the agent participation in the event
.... network[x] 0..1This agent network location for the activity
..... networkReferenceReference(Endpoint)
..... networkUriuri
..... networkStringstring
.... authorization S0..*CodeableConceptAllowable authorization for this agent
Binding: PurposeOfUse (example): The reason the activity took place.


... source S1..1BackboneElementAudit Event Reporter
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site S0..1Reference(Location)Logical source location within the enterprise
.... observer SΣ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)The identity of source detecting the event
.... type S0..*CodeableConceptThe type of source where event originated
Binding: Audit Event Source Type (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.


... entity S0..*BackboneElementData or objects used
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... what SΣ0..1Reference(Resource)Specific instance of resource
.... role S0..1CodeableConceptWhat role the entity played
Binding: AuditEventEntityRole (extensible): DICOM Audit Event Entity Role

.... securityLabel S0..*CodeableConceptSecurity labels on the entity
Binding: SecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... query Σ0..1base64BinaryQuery parameters
.... detail 0..*BackboneElementAdditional Information about the entity
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptName of the property
Binding: Audit Event ID (example): Additional detail about an entity used in an event.

..... value[x] 1..1Property value
...... valueQuantityQuantity
...... valueCodeableConceptCodeableConcept
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueRangeRange
...... valueRatioRatio
...... valueTimetime
...... valueDateTimedateTime
...... valuePeriodPeriod
...... valueBase64Binarybase64Binary
.... agent 0..*See agent (AuditEvent)Entity is attributed to this agent

doco Documentation for this format

XML Template

<!-- EHRS FM Record Lifecycle Event - Audit Event -->doco

<AuditEvent xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- ?? 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- ?? 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- ?? 0..1 Language of the resource content   -->
 <text><!-- ?? 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <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   -->
 <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 -->
 <outcome> ?? 0..1 BackboneElement  <!-- ?? 0..1 Whether the event succeeded or failed -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <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    --></authorization>
 <basedOn><!-- ?? 0..* Reference(CarePlan) 
     Workflow authorization within which this event occurred --></basedOn>
 <encounter><!-- ?? 0..1 Reference(Encounter) 
     Encounter within which this event occurred or which the event is tightly associated --></encounter>
 <agent> ?? 1..* BackboneElement  <!-- ?? 1..* Actor involved in the event -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <type><!-- ?? 0..1 CodeableConcept How agent participated   --></type>
  <role><!-- ?? 0..* CodeableConcept Agent role in the event   --></role>
  <who><!-- ?? 1..1 Reference(Practitioner) Identifier of who --></who>
  <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    --></authorization>
 </agent>
 <source> ?? 1..1 BackboneElement  <!-- ?? 1..1 Audit Event Reporter -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <site><!-- ?? 0..1 Reference(Location) 
      Logical source location within the enterprise --></site>
  <observer><!-- ?? 1..1 Reference(Practitioner) 
      The identity of source detecting the event --></observer>
  <type><!-- ?? 0..* CodeableConcept The type of source where event originated   --></type>
 </source>
 <entity> ?? 0..* BackboneElement  <!-- ?? 0..* Data or objects used -->
  <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <what><!-- ?? 0..1 Reference(Resource) 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..* BackboneElement  <!-- ?? 0..* Additional Information about the entity -->
   <modifierExtension><!-- ?? 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
   <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><!-- See http://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent  Entity is attributed to this agent --></agent>
 </entity>
</AuditEvent>

JSON Template

{ // EHRS FM Record Lifecycle Event - Audit Event
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "category" : [{ CodeableConcept }], // C?Type/identifier of event
    "code" : { CodeableConcept }, // C? R! Specific type of event
    "action" : "<code>", // C?Type of action performed during the event
    "severity" : "<code>", // C?emergency | alert | critical | error | warning | notice | informational | debug
// value[x]: When the activity occurred. One of these 2:
    "occurredPeriod" : { Period }, // C?When the activity occurred
    "occurredDateTime" : "<dateTime>", // C?When the activity occurred
    "recorded" : "<instant>", // C? R! Time when the event was recorded
    "outcome" : { BackboneElement }, // C?Whether the event succeeded or failed
    "authorization" : [{ CodeableConcept }], // C?Authorization related to the event 
    "basedOn" : [{ Reference(CarePlan) }], // C?Workflow authorization within which this event occurred
    "encounter" : { Reference(Encounter) }, // C?Encounter within which this event occurred or which the event is tightly associated
    "agent" : [{ BackboneElement }], // C? R! Actor involved in the event
    "source" : { BackboneElement } // C? R! Audit Event Reporter
    "entity" : [{ BackboneElement }], // C?Data or objects used
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

PathNameConformanceValueSet
AuditEvent.languageCommon LanguagespreferredCommon Languages
AuditEvent.categoryAudit Event IDexampleAudit Event ID
AuditEvent.codeAudit Event Sub-TypeexampleAudit Event Sub-Type
AuditEvent.actionAuditEventActionrequiredAuditEventAction
AuditEvent.severityAuditEventSeverityrequiredAuditEventSeverity
AuditEvent.outcome.codeAuditEventOutcomepreferredAuditEventOutcome
AuditEvent.outcome.detailAuditEventOutcomeDetailexampleAuditEventOutcomeDetail
AuditEvent.authorizationPurposeOfUseexamplePurposeOfUse
AuditEvent.agent.typeParticipationRoleTypepreferredParticipationRoleType
AuditEvent.agent.roleSecurityRoleTypeexampleSecurityRoleType
AuditEvent.agent.authorizationPurposeOfUseexamplePurposeOfUse
AuditEvent.source.typeAudit Event Source TypepreferredAudit Event Source Type
AuditEvent.entity.roleAuditEventEntityRoleextensibleAuditEventEntityRole
AuditEvent.entity.securityLabelSecurityLabelsextensibleSecurityLabels
AuditEvent.entity.detail.typeAudit Event IDexampleAudit Event ID
.