HL7 FHIR Costa Rica - Core
0.0.1-ballot - ci-build Costa Rica flag

HL7 FHIR Costa Rica - Core, published by Iniciativa HL7 Costa Rica. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cr/core/ and changes regularly. See the Directory of published versions

Resource Profile: Evento de Auditoría

Official URL: https://hl7.or.cr/fhir/core/StructureDefinition/cr-core-auditevent Version: 0.0.1-ballot
Standards status: Draft Maturity Level: 0 Computable Name: CRCoreAuditEvent

Copyright/Legal: Usado con el permiso de HL7 International, todos los derechos resevados en los Licencias de HL7 Internacional.

Perfil AuditEvent para registrar eventos de auditoría en recursos clínicos y administrativos, incluyendo metadatos específicos de auditoría y trazabilidad.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... recorded SΣ 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... agent SΣ 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... who SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
... source SΣ 1..1 BackboneElement Fuente del evento de auditoría.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... observer SΣ 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error AuditEvent.implicitRules, AuditEvent.modifierExtension, AuditEvent.code, AuditEvent.recorded, AuditEvent.agent, AuditEvent.agent.modifierExtension, AuditEvent.agent.who, AuditEvent.source, AuditEvent.source.modifierExtension, AuditEvent.source.observer All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.modifierExtension, AuditEvent.agent.modifierExtension, AuditEvent.source.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... code S 1..1 CodeableConcept Tipo de evento de auditoría.
Binding: AuditEventSubType (required): ValueSet de tipos de eventos de auditoría definidos en FHIR.
... recorded S 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... agent S 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... who S 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
.... observer S 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... category Σ 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
... code SΣ 1..1 CodeableConcept Tipo de evento de auditoría.
Binding: AuditEventSubType (required): ValueSet de tipos de eventos de auditoría definidos en FHIR.
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity Σ 0..1 code emergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
.... detail Σ 0..* CodeableConcept Additional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
... authorization Σ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (3.1.0) (example): The authorized purposeOfUse for the activity.
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
... agent SΣ 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
.... who SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
.... requestor Σ 0..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) The agent location when the event occurred
.... policy 0..* uri Policy that authorized the agent participation in the event
.... network[x] 0..1 This agent network location for the activity
..... networkReference Reference(Endpoint)
..... networkUri uri
..... networkString string
.... authorization 0..* CodeableConcept Allowable authorization for this agent
Binding: PurposeOfUse (3.1.0) (example): The reason the activity took place.
... source SΣ 1..1 BackboneElement Fuente del evento de auditoría.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... site 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.
.... type 0..* CodeableConcept The type of source where event originated
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
... entity Σ 0..* BackboneElement Data or objects used
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... what Σ 0..1 Reference(Resource) Specific instance of resource
.... role 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel 0..* CodeableConcept Security labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... query Σ 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 1..1 CodeableConcept Name of the property
Binding: AuditEventID (example): Additional detail about an entity used in an event.
..... value[x] 1..1 Property value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... valueBase64Binary base64Binary
.... agent 0..* See agent (AuditEvent) Entity is attributed to this agent

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.0
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.0
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error AuditEvent.meta, AuditEvent.implicitRules, AuditEvent.language, AuditEvent.text, AuditEvent.extension, AuditEvent.modifierExtension, AuditEvent.category, AuditEvent.code, AuditEvent.action, AuditEvent.severity, AuditEvent.occurred[x], AuditEvent.recorded, AuditEvent.outcome, AuditEvent.outcome.extension, AuditEvent.outcome.modifierExtension, AuditEvent.outcome.code, AuditEvent.outcome.detail, AuditEvent.authorization, AuditEvent.basedOn, AuditEvent.patient, AuditEvent.encounter, AuditEvent.agent, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.type, AuditEvent.agent.role, AuditEvent.agent.who, AuditEvent.agent.requestor, AuditEvent.agent.location, AuditEvent.agent.policy, AuditEvent.agent.network[x], AuditEvent.agent.authorization, AuditEvent.source, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site, AuditEvent.source.observer, AuditEvent.source.type, AuditEvent.entity, AuditEvent.entity.extension, AuditEvent.entity.modifierExtension, AuditEvent.entity.what, AuditEvent.entity.role, AuditEvent.entity.securityLabel, AuditEvent.entity.query, AuditEvent.entity.detail, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type, AuditEvent.entity.detail.value[x], AuditEvent.entity.agent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.modifierExtension, AuditEvent.outcome.extension, AuditEvent.outcome.modifierExtension, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.entity.extension, AuditEvent.entity.modifierExtension, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... recorded SΣ 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... agent SΣ 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... who SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
... source SΣ 1..1 BackboneElement Fuente del evento de auditoría.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... observer SΣ 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error AuditEvent.implicitRules, AuditEvent.modifierExtension, AuditEvent.code, AuditEvent.recorded, AuditEvent.agent, AuditEvent.agent.modifierExtension, AuditEvent.agent.who, AuditEvent.source, AuditEvent.source.modifierExtension, AuditEvent.source.observer All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.modifierExtension, AuditEvent.agent.modifierExtension, AuditEvent.source.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... code S 1..1 CodeableConcept Tipo de evento de auditoría.
Binding: AuditEventSubType (required): ValueSet de tipos de eventos de auditoría definidos en FHIR.
... recorded S 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... agent S 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... who S 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
.... observer S 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(5.0.0) Record of an event
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... category Σ 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
... code SΣ 1..1 CodeableConcept Tipo de evento de auditoría.
Binding: AuditEventSubType (required): ValueSet de tipos de eventos de auditoría definidos en FHIR.
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity Σ 0..1 code emergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Fecha y hora en que se registró el evento de auditoría.
... outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
.... detail Σ 0..* CodeableConcept Additional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
... authorization Σ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (3.1.0) (example): The authorized purposeOfUse for the activity.
... basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
... agent SΣ 1..* BackboneElement Agentes involucrados en el evento de auditoría.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
.... who SΣ 1..1 Reference(Profesional de la Salud(0.0.1-ballot) | Organización(0.0.1-ballot)) Referencia al agente.
.... requestor Σ 0..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) The agent location when the event occurred
.... policy 0..* uri Policy that authorized the agent participation in the event
.... network[x] 0..1 This agent network location for the activity
..... networkReference Reference(Endpoint)
..... networkUri uri
..... networkString string
.... authorization 0..* CodeableConcept Allowable authorization for this agent
Binding: PurposeOfUse (3.1.0) (example): The reason the activity took place.
... source SΣ 1..1 BackboneElement Fuente del evento de auditoría.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... site 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Organización(0.0.1-ballot) | Profesional de la Salud(0.0.1-ballot)) Observador de la fuente.
.... type 0..* CodeableConcept The type of source where event originated
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
... entity Σ 0..* BackboneElement Data or objects used
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... what Σ 0..1 Reference(Resource) Specific instance of resource
.... role 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel 0..* CodeableConcept Security labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... query Σ 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 1..1 CodeableConcept Name of the property
Binding: AuditEventID (example): Additional detail about an entity used in an event.
..... value[x] 1..1 Property value
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
...... valueBase64Binary base64Binary
.... agent 0..* See agent (AuditEvent) Entity is attributed to this agent

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base required Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.0
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.0
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error AuditEvent.meta, AuditEvent.implicitRules, AuditEvent.language, AuditEvent.text, AuditEvent.extension, AuditEvent.modifierExtension, AuditEvent.category, AuditEvent.code, AuditEvent.action, AuditEvent.severity, AuditEvent.occurred[x], AuditEvent.recorded, AuditEvent.outcome, AuditEvent.outcome.extension, AuditEvent.outcome.modifierExtension, AuditEvent.outcome.code, AuditEvent.outcome.detail, AuditEvent.authorization, AuditEvent.basedOn, AuditEvent.patient, AuditEvent.encounter, AuditEvent.agent, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.type, AuditEvent.agent.role, AuditEvent.agent.who, AuditEvent.agent.requestor, AuditEvent.agent.location, AuditEvent.agent.policy, AuditEvent.agent.network[x], AuditEvent.agent.authorization, AuditEvent.source, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site, AuditEvent.source.observer, AuditEvent.source.type, AuditEvent.entity, AuditEvent.entity.extension, AuditEvent.entity.modifierExtension, AuditEvent.entity.what, AuditEvent.entity.role, AuditEvent.entity.securityLabel, AuditEvent.entity.query, AuditEvent.entity.detail, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type, AuditEvent.entity.detail.value[x], AuditEvent.entity.agent All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.modifierExtension, AuditEvent.outcome.extension, AuditEvent.outcome.modifierExtension, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.entity.extension, AuditEvent.entity.modifierExtension, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron