Connectathon 11 Snapshot
This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). 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
This profile is marked as a draft.
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.
This structure is derived from AuditEvent.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | 0..* | AuditEvent | ||
  event | S | 1..1 | BackboneElement | |
 type | S | 1..1 | Coding | |
| subtype | S | 0..* | Coding | |
| action | S | 0..1 | code | |
| dateTime | S | 1..1 | instant | |
 purposeOfEvent | S | 0..* | Coding | |
| participant | S | 1..* | BackboneElement | |
| role | S | 0..* | CodeableConcept | |
| reference | S | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | |
| userId | S | 0..1 | Identifier | |
| requestor | S | 1..1 | boolean | |
| location | S | 0..1 | Reference(Location) | |
| policy | S | 0..* | uri | |
| network | S | 0..1 | BackboneElement | |
| address | S | 0..1 | string | |
| type | S | 0..1 | code | |
| purposeOfUse | S | 0..* | Coding | |
| source | S | 1..1 | BackboneElement | |
| site | S | 0..1 | string | |
| identifier | S | 1..1 | Identifier | |
| type | S | 0..* | Coding | |
| object | S | 0..* | BackboneElement | |
 identifier | S | 0..1 | Identifier | |
| reference | S | 0..1 | Reference(Resource) | |
| type | S | 0..1 | Coding | |
| role | S | 0..1 | Coding | |
| lifecycle | S | 0..1 | Coding | |
| securityLabel | S | 0..* | Coding | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
 implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47  (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event | S | 1..1 | BackboneElement | What was done |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 type | S ∑ | 1..1 | Coding | Type/identifier of event Binding: Audit Event ID (extensible) |
| subtype | S ∑ | 0..* | Coding | More specific type/id for the event Binding: Audit Event Sub-Type (extensible) |
| action | S ∑ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
| dateTime | S ∑ | 1..1 | instant | Time when the event occurred on source |
| outcome | ∑ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required) |
| outcomeDesc | ∑ | 0..1 | string | Description of the event outcome |
| purposeOfEvent | S ∑ | 0..* | Coding | The purposeOfUse of the event Binding: PurposeOfUse (extensible) |
| participant | S | 1..* | BackboneElement | A person, a hardware device or software process |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| role | S | 0..* | CodeableConcept | User roles (e.g. local RBAC codes) Binding: Audit Active Participant Role ID Code (extensible) |
 reference | S ∑ | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | Direct reference to resource |
| userId | S ∑ | 0..1 | Identifier | Unique identifier for the user |
| altId | 0..1 | string | Alternative User id e.g. authentication | |
| name | 0..1 | string | Human-meaningful name for the user | |
| requestor | S | 1..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | Where |
| policy | S | 0..* | uri | Policy that authorized event |
| media | 0..1 | Coding | Type of media Binding: Media Type Code (extensible) | |
| network | S | 0..1 | BackboneElement | Logical network location for application activity |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| address | S | 0..1 | string | Identifier for the network access point of the user device |
| type | S | 0..1 | code | The type of network access point Binding: AuditEventParticipantNetworkType (required) |
| purposeOfUse | S | 0..* | Coding | Reason given for this user Binding: PurposeOfUse (extensible) |
| source | S | 1..1 | BackboneElement | Application systems and processes |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| site | S | 0..1 | string | Logical source location within the enterprise |
| identifier | S ∑ | 1..1 | Identifier | The identity of source detecting the event |
| type | S | 0..* | Coding | The type of source where event originated Binding: Audit Event Source Type (extensible) |
| object | S I | 0..* | BackboneElement | Specific instances of data or objects that have been accessed sev-1: Either a name or a query (NOT both) |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | S ∑ | 0..1 | Identifier | Specific instance of object (e.g. versioned) |
| reference | S ∑ | 0..1 | Reference(Resource) | Specific instance of resource (e.g. versioned) |
| type | S | 0..1 | Coding | Type of object involved Binding: AuditEventObjectType (extensible) |
| role | S | 0..1 | Coding | What role the Object played Binding: AuditEventObjectRole (extensible) |
| lifecycle | S | 0..1 | Coding | Life-cycle stage for the object Binding: AuditEventObjectLifecycle (extensible) |
| securityLabel | S | 0..* | Coding | Security labels applied to the object Binding: All Security Labels (extensible) |
| name | ∑ I | 0..1 | string | Instance-specific descriptor for Object |
| description | 0..1 | string | Descriptive text | |
| query | ∑ I | 0..1 | base64Binary | Actual query for object |
| detail | 0..* | BackboneElement | Additional Information about the Object | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | 1..1 | string | Name of the property | |
| value | 1..1 | base64Binary | Property value | |
| Documentation for this format | ||||
todo
This structure is derived from AuditEvent.
Differential View
This structure is derived from AuditEvent.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | ||
| event | S | 1..1 | BackboneElement | |
| type | S | 1..1 | Coding | |
| subtype | S | 0..* | Coding | |
| action | S | 0..1 | code | |
| dateTime | S | 1..1 | instant | |
| purposeOfEvent | S | 0..* | Coding | |
| participant | S | 1..* | BackboneElement | |
| role | S | 0..* | CodeableConcept | |
| reference | S | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | |
| userId | S | 0..1 | Identifier | |
| requestor | S | 1..1 | boolean | |
| location | S | 0..1 | Reference(Location) | |
| policy | S | 0..* | uri | |
| network | S | 0..1 | BackboneElement | |
| address | S | 0..1 | string | |
| type | S | 0..1 | code | |
| purposeOfUse | S | 0..* | Coding | |
| source | S | 1..1 | BackboneElement | |
| site | S | 0..1 | string | |
| identifier | S | 1..1 | Identifier | |
| type | S | 0..* | Coding | |
| object | S | 0..* | BackboneElement | |
| identifier | S | 0..1 | Identifier | |
| reference | S | 0..1 | Reference(Resource) | |
| type | S | 0..1 | Coding | |
| role | S | 0..1 | Coding | |
| lifecycle | S | 0..1 | Coding | |
| securityLabel | S | 0..* | Coding | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Event record kept for security purposes | |
| meta | ∑ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?! ∑ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: IETF BCP-47 (required) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| event | S | 1..1 | BackboneElement | What was done |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | S ∑ | 1..1 | Coding | Type/identifier of event Binding: Audit Event ID (extensible) |
| subtype | S ∑ | 0..* | Coding | More specific type/id for the event Binding: Audit Event Sub-Type (extensible) |
| action | S ∑ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required) |
| dateTime | S ∑ | 1..1 | instant | Time when the event occurred on source |
| outcome | ∑ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required) |
| outcomeDesc | ∑ | 0..1 | string | Description of the event outcome |
| purposeOfEvent | S ∑ | 0..* | Coding | The purposeOfUse of the event Binding: PurposeOfUse (extensible) |
| participant | S | 1..* | BackboneElement | A person, a hardware device or software process |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| role | S | 0..* | CodeableConcept | User roles (e.g. local RBAC codes) Binding: Audit Active Participant Role ID Code (extensible) |
| reference | S ∑ | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | Direct reference to resource |
| userId | S ∑ | 0..1 | Identifier | Unique identifier for the user |
| altId | 0..1 | string | Alternative User id e.g. authentication | |
| name | 0..1 | string | Human-meaningful name for the user | |
| requestor | S | 1..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | Where |
| policy | S | 0..* | uri | Policy that authorized event |
| media | 0..1 | Coding | Type of media Binding: Media Type Code (extensible) | |
| network | S | 0..1 | BackboneElement | Logical network location for application activity |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| address | S | 0..1 | string | Identifier for the network access point of the user device |
| type | S | 0..1 | code | The type of network access point Binding: AuditEventParticipantNetworkType (required) |
| purposeOfUse | S | 0..* | Coding | Reason given for this user Binding: PurposeOfUse (extensible) |
| source | S | 1..1 | BackboneElement | Application systems and processes |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| site | S | 0..1 | string | Logical source location within the enterprise |
| identifier | S ∑ | 1..1 | Identifier | The identity of source detecting the event |
| type | S | 0..* | Coding | The type of source where event originated Binding: Audit Event Source Type (extensible) |
| object | S I | 0..* | BackboneElement | Specific instances of data or objects that have been accessed sev-1: Either a name or a query (NOT both) |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | S ∑ | 0..1 | Identifier | Specific instance of object (e.g. versioned) |
| reference | S ∑ | 0..1 | Reference(Resource) | Specific instance of resource (e.g. versioned) |
| type | S | 0..1 | Coding | Type of object involved Binding: AuditEventObjectType (extensible) |
| role | S | 0..1 | Coding | What role the Object played Binding: AuditEventObjectRole (extensible) |
| lifecycle | S | 0..1 | Coding | Life-cycle stage for the object Binding: AuditEventObjectLifecycle (extensible) |
| securityLabel | S | 0..* | Coding | Security labels applied to the object Binding: All Security Labels (extensible) |
| name | ∑ I | 0..1 | string | Instance-specific descriptor for Object |
| description | 0..1 | string | Descriptive text | |
| query | ∑ I | 0..1 | base64Binary | Actual query for object |
| detail | 0..* | BackboneElement | Additional Information about the Object | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| type | 1..1 | string | Name of the property | |
| value | 1..1 | base64Binary | Property value | |
| Documentation for this format | ||||
XML Template
JSON Template
todo
Other representations of profile: Schematron
| Path | Name | Conformance | ValueSet |
| AuditEvent.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| AuditEvent.event.type | Audit Event ID | extensible | Audit Event ID |
| AuditEvent.event.subtype | Audit Event Sub-Type | extensible | Audit Event Sub-Type |
| AuditEvent.event.action | AuditEventAction | required | AuditEventAction |
| AuditEvent.event.outcome | AuditEventOutcome | required | AuditEventOutcome |
| AuditEvent.event.purposeOfEvent | PurposeOfUse | extensible | PurposeOfUse |
| AuditEvent.participant.role | Audit Active Participant Role ID Code | extensible | Audit Active Participant Role ID Code |
| AuditEvent.participant.media | Media Type Code | extensible | Media Type Code |
| AuditEvent.participant.network.type | AuditEventParticipantNetworkType | required | AuditEventParticipantNetworkType |
| AuditEvent.participant.purposeOfUse | PurposeOfUse | extensible | PurposeOfUse |
| AuditEvent.source.type | Audit Event Source Type | extensible | Audit Event Source Type |
| AuditEvent.object.type | AuditEventObjectType | extensible | AuditEventObjectType |
| AuditEvent.object.role | AuditEventObjectRole | extensible | AuditEventObjectRole |
| AuditEvent.object.lifecycle | AuditEventObjectLifecycle | extensible | AuditEventObjectLifecycle |
| AuditEvent.object.securityLabel | All Security Labels | extensible | All Security Labels |
| Id | Path | Details | Requirements |
| sev-1 | AuditEvent.object | Either a name or a query (NOT both) XPath: not(exists(f:name)) or not(exists(f:query)) |
© HL7.org 2011+. FHIR DSTU2 (v1.2.0-7447) generated on Fri, Dec 11, 2015 17:44+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change