AuditEvent Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-auditevent |
|---|---|
| Status | draft (experimental) · 1.26.0 |
| Base | AuditEvent (constraint) |
| Source | FSH · JSON |
Nexus EMR profile for AuditEvent -- the access and activity log: who acted, on which record, when, through what interaction, and with what outcome.
Elements / Snapshot
The full effective definition: base AuditEvent with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | Nexus EMR AuditEvent Core i Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, auditevent-names-an-actor |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | S | 0..1 | Narrative | Narrative i Invariants: ele-1 |
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| type | S | 1..1 | Coding | What kind of event this is i Binding: audit-event-type ( extensible)Invariants: ele-1 |
| subtype | S | 0..* | Coding | The narrower activity, where the event is not simply a REST interaction i Binding: audit-event-sub-type ( extensible)Invariants: ele-1 |
| action | S | 0..1 | code | create | read | update | delete | execute i Binding: audit-event-action ( required)Invariants: ele-1 |
| period | S | 0..1 | Period | When the activity itself occurred i Invariants: ele-1 |
| recorded | S | 1..1 | instant | When the entry was recorded i Invariants: ele-1 |
| outcome | S | 0..1 | code | 0 | 4 | 8 | 12 -- whether the interaction succeeded i Binding: audit-event-outcome ( required)Invariants: ele-1 |
| outcomeDesc | S | 0..1 | string | Free-text detail about the event i Invariants: ele-1 |
| purposeOfEvent | S | 0..* | CodeableConcept | Why the interaction took place i Binding: v3-PurposeOfUse ( extensible)Invariants: ele-1 |
| agent | S | 1..* | BackboneElement | Who acted i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | 0..1 | CodeableConcept | How agent participated Binding: participation-role-type ( extensible)Invariants: ele-1 |
|
| role | 0..* | CodeableConcept | Agent role in the event i Binding: security-role-type ( example)Invariants: ele-1 |
|
| who | S | 0..1 | Reference(Practitioner Profile | PractitionerRole Profile | Patient Profile | RelatedPerson Profile | Organization Profile | App Device Profile | Device Profile) | The actor, where it resolves to a resource i Invariants: ele-1 |
| altId | S | 0..1 | string | The acting user's identity-provider subject Invariants: ele-1 |
| name | S | 0..1 | string | Human-readable label for the actor i Invariants: ele-1 |
| requestor | S | 1..1 | boolean | Whether this agent initiated the interaction i Invariants: ele-1 |
| location | 0..1 | Reference(Location) | Where Invariants: ele-1 |
|
| policy | S | 0..* | uri | The authority the interaction was performed under i Invariants: ele-1 |
| media | 0..1 | Coding | Type of media Binding: dicm-405-mediatype ( extensible)Invariants: ele-1 |
|
| network | S | 0..1 | BackboneElement | Where the request came from i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| address | 0..1 | string | Identifier for the network access point of the user device i Invariants: ele-1 |
|
| type | 0..1 | code | The type of network access point Binding: network-type ( required)Invariants: ele-1 |
|
| purposeOfUse | 0..* | CodeableConcept | Reason given for this user i Binding: v3-PurposeOfUse ( extensible)Invariants: ele-1 |
|
| source | S | 1..1 | BackboneElement | The system that recorded the entry i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| site | S | 0..1 | string | The logical source location i Invariants: ele-1 |
| observer | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event Invariants: ele-1 |
|
| type | 0..* | Coding | The type of source where event originated Binding: audit-source-type ( extensible)Invariants: ele-1 |
|
| entity | S | 0..* | BackboneElement | The records the interaction concerned i Invariants: ele-1, sev-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| what | S | 0..1 | Reference(Resource) | The record concerned i Invariants: ele-1 |
| type | S | 0..1 | Coding | What kind of thing the record is i Binding: audit-entity-type ( extensible)Invariants: ele-1 |
| role | 0..1 | Coding | What role the entity played Binding: object-role ( extensible)Invariants: ele-1 |
|
| lifecycle | 0..1 | Coding | Life-cycle stage for the entity i Binding: object-lifecycle-events ( extensible)Invariants: ele-1 |
|
| securityLabel | 0..* | Coding | Security labels on the entity i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| name | 0..1 | string | Descriptor for entity i Invariants: ele-1 |
|
| description | 0..1 | string | Descriptive text Invariants: ele-1 |
|
| query | 0..1 | base64Binary | Query parameters i Invariants: ele-1 |
|
| detail | S | 0..* | BackboneElement | Named values carrying detail about the record concerned i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | 1..1 | string | Name of the property Invariants: ele-1 |
|
| value[x] | 1..1 | string, base64Binary | Property value i Invariants: ele-1 |