Skip to content

AuditEvent Profile

Canonical../StructureDefinition/nexus-emr-core-auditevent
Statusdraft (experimental) · 1.26.0
BaseAuditEvent (constraint)
SourceFSH · JSON

Nexus EMR profile for AuditEvent -- the access and activity log: who acted, on which record, when, through what interaction, and with what outcome.

Salient fields

The profile's synthesized-accessor contract: fields TypedFhir surfaces as first-class typed properties, each computed from the instance by a restricted FHIRPath expression. See Salient Fields for what they are, how they shape LLM contexts, and how to declare them.

Key Type Expression Rendered as Description
action code action create | read | update | delete | execute i
outcome code outcome 0 | 4 | 8 | 12 -- whether the interaction succeeded i
date dateTime period.start \| recorded When the activity itself occurred i
performed_by string agent.altId.first() The acting user's identity-provider subject i

action

Short create | read | update | delete | execute
Definition Indicator for type of action performed during the event that generated the audit.
Comments The interaction performed, as R4's audit-event-action codes. See the element note: the platform records a transmission action that these five codes do not express.
Expression action
Type code
Prose inherited from AuditEvent.action

outcome

Short 0 | 4 | 8 | 12 -- whether the interaction succeeded
Definition Indicates whether the event succeeded or failed.
Comments Present only when the outcome is known. An entry recording an outcome the platform could not determine carries no code at all -- treat absence as unknown, never as success.
Expression outcome
Type code
Prose inherited from AuditEvent.outcome

date

Short When the activity itself occurred
Definition The period during which the activity occurred.
Comments When the entry was recorded, falling back from the activity period where one is given. Not necessarily the instant of the interaction -- see the recorded note.
Expression period.start | recorded
Type dateTime
Prose inherited from AuditEvent.period

performed_by

Short The acting user's identity-provider subject
Definition The opaque account identifier the identity provider issues for the acting user (for example auth0|abc123). This is the identity the platform actually holds on every entry, and it is the element to match on when correlating an audit entry with the meta-updated-by extension on a resource version -- the two carry the same kind of value for the same reason. NOT a FHIR id and NOT a Practitioner reference. Resolving it to a person needs the identity directory, which this guide does not describe.
Comments The identity-provider subject of the acting user, as the platform holds it. An opaque account identifier, not a FHIR id and not a Practitioner reference. Resolving it to a person needs the identity directory, which this guide does not describe.
Expression agent.altId.first()
Type string
Prose inherited from AuditEvent.agent.altId