# AuditEvent

Canonical page: https://docs.ovok.com/api/fhir/r4/audit-event

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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-type"></span>`type` | [Coding](/fhir-elements/complex/coding) | `1..1` | Type/identifier of event |
| <span id="element-subtype"></span>`subtype` | [Coding](/fhir-elements/complex/coding) | `0..*` | More specific type/id for the event |
| <span id="element-action"></span>`action` | [code](/fhir-elements/primitive/code) | `0..1` | Type of action performed during the event |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | When the activity occurred |
| <span id="element-recorded"></span>`recorded` | [instant](/fhir-elements/primitive/instant) | `1..1` | Time when the event was recorded |
| <span id="element-outcome"></span>`outcome` | [code](/fhir-elements/primitive/code) | `0..1` | Whether the event succeeded or failed |
| <span id="element-outcome-desc"></span>`outcomeDesc` | [string](/fhir-elements/primitive/string) | `0..1` | Description of the event outcome |
| <span id="element-purpose-of-event"></span>`purposeOfEvent` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | The purposeOfUse of the event |
| <span id="element-agent"></span>`agent` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..*` | Actor involved in the event |
| <span id="element-source"></span>`source` | [BackboneElement](/fhir-elements/complex/backbone-element) | `1..1` | Audit Event Reporter |
| <span id="element-entity"></span>`entity` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Data or objects used |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [AuditEvent](https://hl7.org/fhir/R4/auditevent.html).  
Maturity: Trial Use 3 (FMM 3).
