AuditEvent
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/AuditEvent/[id] |
| Vread | GET | /fhir/R4/AuditEvent/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/AuditEvent/[id] |
| Patch | PATCH | /fhir/R4/AuditEvent/[id] |
| Delete | DELETE | /fhir/R4/AuditEvent/[id] |
| Create | POST | /fhir/R4/AuditEvent |
| Search | GET | /fhir/R4/AuditEvent |
| History | GET | /fhir/R4/AuditEvent/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
type | Coding | 1..1 | Type/identifier of event |
subtype | Coding | 0..* | More specific type/id for the event |
action | code | 0..1 | Type of action performed during the event |
period | Period | 0..1 | When the activity occurred |
recorded | instant | 1..1 | Time when the event was recorded |
outcome | code | 0..1 | Whether the event succeeded or failed |
outcomeDesc | string | 0..1 | Description of the event outcome |
purposeOfEvent | CodeableConcept | 0..* | The purposeOfUse of the event |
agent | BackboneElement | 1..* | Actor involved in the event |
source | BackboneElement | 1..1 | Audit Event Reporter |
entity | BackboneElement | 0..* | Data or objects used |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
action | token | Type of action performed during the event |
address | string | Identifier for the network access point of the user device |
agent | reference | Identifier of who |
agent-name | string | Human friendly name for the agent |
agent-role | token | Agent role in the event |
altid | token | Alternative User identity |
date | date | Time when the event was recorded |
entity | reference | Specific instance of resource |
entity-name | string | Descriptor for entity |
entity-role | token | What role the entity played |
entity-type | token | Type of entity involved |
outcome | token | Whether the event succeeded or failed |
patient | reference | Identifier of who |
policy | uri | Policy that authorized event |
site | token | Logical source location within the enterprise |
source | reference | The identity of source detecting the event |
subtype | token | More specific type/id for the event |
type | token | Type/identifier of event |
Reference
Official FHIR R4 spec: AuditEvent.
Maturity: Trial Use 3 (FMM 3).