Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_AuditEvent_R4

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-AuditEvent Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_AuditEvent_R4

This cross-version profile allows R5 AuditEvent content to be represented via FHIR R4 AuditEvent resources.

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(4.0.1) Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
Constraints: ext-1
... recorded Σ 1..1 instant Time when the event was recorded
... agent 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.recorded, AuditEvent.agent, AuditEvent.agent.modifierExtension, AuditEvent.agent.requestor, AuditEvent.source, AuditEvent.source.modifierExtension, AuditEvent.source.observer, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.agent.modifierExtension, AuditEvent.source.modifierExtension, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer 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(4.0.1) Event record kept for security purposes
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
... subtype
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 CodeableConcept R5: Specific type of event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code
Binding: AuditEventSub-Type (example): Specific type of event.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred
... outcome
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 Coding R5: Whether the event succeeded or failed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
..... extension:detail 0..* CodeableConcept R5: Additional outcome detail (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail
Binding: R5AuditEventOutcomeDetailForR4 (0.1.0) (example): A code that provides details as the exact issue.
... source
.... site
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:site 0..1 Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) R5: site additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site
.... observer
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..* CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type
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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:agent 0..* (Complex) R5: Entity is attributed to this agent (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent
.... role
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:role 0..1 CodeableConcept R5: role additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:securityLabel 0..* CodeableConcept R5: securityLabel additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel
Binding: R5SecurityLabelExamplesForR4 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value
..... type
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type
Binding: AuditEventID (example): Additional detail about an entity used in an event.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(4.0.1) Event record kept for security purposes
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 CodeableConcept R5: Specific type of event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code
Binding: AuditEventSub-Type (example): Specific type of event.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period 0..1 Period When the activity occurred
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Coding R5: Whether the event succeeded or failed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
Constraints: ext-1
..... extension:detail 0..* CodeableConcept R5: Additional outcome detail (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail
Binding: R5AuditEventOutcomeDetailForR4 (0.1.0) (example): A code that provides details as the exact issue.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... agent 1..* BackboneElement Actor involved in the event
.... 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 (extensible): 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
.... altId 0..1 string Alternative User identity
.... name 0..1 string Human friendly name for the agent
.... requestor Σ 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy 0..* uri Policy that authorized event
.... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
.... network 0..1 BackboneElement Logical network location for application activity
..... 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
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
.... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... source 1..1 BackboneElement Audit Event Reporter
.... 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 string Logical source location within the enterprise
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:site 0..1 Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) R5: site additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site
Constraints: ext-1
..... value 0..1 string Primitive value for string
Max Length:1048576
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..* CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type
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.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... entity C 0..* BackboneElement Data or objects used
Constraints: sev-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:agent 0..* (Complex) R5: Entity is attributed to this agent (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent
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
.... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
.... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:role 0..1 CodeableConcept R5: role additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
.... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:securityLabel 0..* CodeableConcept R5: securityLabel additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel
Binding: R5SecurityLabelExamplesForR4 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... name ΣC 0..1 string Descriptor for entity
.... description 0..1 string Descriptive text
.... query ΣC 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:value 0..1 Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 1..1 string Name of the property
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type
Binding: AuditEventID (example): Additional detail about an entity used in an event.
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... value[x] 1..1 Property value
...... valueString string
...... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📍3.1.0 THO v7.1
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v7.1
AuditEvent.source.observer.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.type.system, AuditEvent.type.version, AuditEvent.type.code, AuditEvent.type.display, AuditEvent.type.userSelected, AuditEvent.subtype, AuditEvent.subtype.extension, AuditEvent.subtype.extension:code, AuditEvent.subtype.system, AuditEvent.subtype.version, AuditEvent.subtype.code, AuditEvent.subtype.display, AuditEvent.subtype.userSelected, AuditEvent.action, AuditEvent.period, AuditEvent.period.extension, AuditEvent.period.extension:occurred, AuditEvent.period.start, AuditEvent.period.end, AuditEvent.recorded, AuditEvent.outcome, AuditEvent.outcome.extension, AuditEvent.outcome.extension:code, AuditEvent.outcome.extension:detail, AuditEvent.outcomeDesc, AuditEvent.purposeOfEvent, AuditEvent.agent, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.type, AuditEvent.agent.role, AuditEvent.agent.who, AuditEvent.agent.altId, AuditEvent.agent.name, AuditEvent.agent.requestor, AuditEvent.agent.location, AuditEvent.agent.policy, AuditEvent.agent.media, AuditEvent.agent.network, AuditEvent.agent.network.extension, AuditEvent.agent.network.modifierExtension, AuditEvent.agent.network.address, AuditEvent.agent.network.type, AuditEvent.agent.purposeOfUse, AuditEvent.source, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site, AuditEvent.source.site.extension, AuditEvent.source.site.extension:site, AuditEvent.source.observer, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer, AuditEvent.source.observer.reference, AuditEvent.source.observer.type, AuditEvent.source.observer.identifier, AuditEvent.source.observer.display, AuditEvent.source.type, AuditEvent.source.type.extension, AuditEvent.source.type.extension:type, AuditEvent.source.type.system, AuditEvent.source.type.version, AuditEvent.source.type.code, AuditEvent.source.type.display, AuditEvent.source.type.userSelected, AuditEvent.entity, AuditEvent.entity.extension, AuditEvent.entity.extension:agent, AuditEvent.entity.modifierExtension, AuditEvent.entity.what, AuditEvent.entity.type, AuditEvent.entity.role, AuditEvent.entity.role.extension, AuditEvent.entity.role.extension:role, AuditEvent.entity.role.system, AuditEvent.entity.role.version, AuditEvent.entity.role.code, AuditEvent.entity.role.display, AuditEvent.entity.role.userSelected, AuditEvent.entity.lifecycle, AuditEvent.entity.securityLabel, AuditEvent.entity.securityLabel.extension, AuditEvent.entity.securityLabel.extension:securityLabel, AuditEvent.entity.securityLabel.system, AuditEvent.entity.securityLabel.version, AuditEvent.entity.securityLabel.code, AuditEvent.entity.securityLabel.display, AuditEvent.entity.securityLabel.userSelected, AuditEvent.entity.name, AuditEvent.entity.description, AuditEvent.entity.query, AuditEvent.entity.detail, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.extension:value, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type, AuditEvent.entity.detail.type.extension, AuditEvent.entity.detail.type.extension:type, AuditEvent.entity.detail.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.subtype.extension, AuditEvent.subtype.extension:code, AuditEvent.period.extension, AuditEvent.period.extension:occurred, AuditEvent.outcome.extension, AuditEvent.outcome.extension:code, AuditEvent.outcome.extension:detail, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.network.extension, AuditEvent.agent.network.modifierExtension, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site.extension, AuditEvent.source.site.extension:site, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer, AuditEvent.source.type.extension, AuditEvent.source.type.extension:type, AuditEvent.entity.extension, AuditEvent.entity.extension:agent, AuditEvent.entity.modifierExtension, AuditEvent.entity.role.extension, AuditEvent.entity.role.extension:role, AuditEvent.entity.securityLabel.extension, AuditEvent.entity.securityLabel.extension:securityLabel, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.extension:value, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type.extension, AuditEvent.entity.detail.type.extension:type Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 0 element(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(4.0.1) Event record kept for security purposes
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
Constraints: ext-1
... recorded Σ 1..1 instant Time when the event was recorded
... agent 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.recorded, AuditEvent.agent, AuditEvent.agent.modifierExtension, AuditEvent.agent.requestor, AuditEvent.source, AuditEvent.source.modifierExtension, AuditEvent.source.observer, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.agent.modifierExtension, AuditEvent.source.modifierExtension, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer 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(4.0.1) Event record kept for security purposes
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
... type
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
... subtype
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 CodeableConcept R5: Specific type of event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code
Binding: AuditEventSub-Type (example): Specific type of event.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred
... outcome
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:code 1..1 Coding R5: Whether the event succeeded or failed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
..... extension:detail 0..* CodeableConcept R5: Additional outcome detail (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail
Binding: R5AuditEventOutcomeDetailForR4 (0.1.0) (example): A code that provides details as the exact issue.
... source
.... site
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:site 0..1 Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) R5: site additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site
.... observer
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... type
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 0..* CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type
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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:agent 0..* (Complex) R5: Entity is attributed to this agent (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent
.... role
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:role 0..1 CodeableConcept R5: role additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:securityLabel 0..* CodeableConcept R5: securityLabel additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel
Binding: R5SecurityLabelExamplesForR4 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value
..... type
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type
Binding: AuditEventID (example): Additional detail about an entity used in an event.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent(4.0.1) Event record kept for security purposes
... 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:severity 0..1 code R5: emergency | alert | critical | error | warning | notice | informational | debug (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity
Binding: R5AuditEventSeverityForR4 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
Constraints: ext-1
.... extension:basedOn 0..* Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR R4(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR R4(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR R4(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR R4(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR R4(0.1.0) | ServiceRequest | Cross-version Profile for R5.Task for use in FHIR R4(0.1.0) | Task) R5: Workflow authorization within which this event occurred (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn
Constraints: ext-1
.... extension:patient 0..1 Reference(Cross-version Profile for R5.Patient for use in FHIR R4(0.1.0) | Patient) R5: The patient is the subject of the data used/created/updated/deleted during the activity (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient
Constraints: ext-1
.... extension:encounter 0..1 Reference(Cross-version Profile for R5.Encounter for use in FHIR R4(0.1.0) | Encounter) R5: Encounter within which this event occurred or which the event is tightly associated (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:category 0..* CodeableConcept R5: category additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category
Binding: AuditEventID (example): Type of event.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 CodeableConcept R5: Specific type of event additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code
Binding: AuditEventSub-Type (example): Specific type of event.
Constraints: ext-1
.... system Σ 0..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 0..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period 0..1 Period When the activity occurred
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:occurred 0..1 dateTime R5: occurred additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred
Constraints: ext-1
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:code 1..1 Coding R5: Whether the event succeeded or failed (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code
Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
Constraints: ext-1
..... extension:detail 0..* CodeableConcept R5: Additional outcome detail (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail
Binding: R5AuditEventOutcomeDetailForR4 (0.1.0) (example): A code that provides details as the exact issue.
Constraints: ext-1
.... value 0..1 string Primitive value for code
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... agent 1..* BackboneElement Actor involved in the event
.... 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 (extensible): 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
.... altId 0..1 string Alternative User identity
.... name 0..1 string Human friendly name for the agent
.... requestor Σ 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy 0..* uri Policy that authorized event
.... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
.... network 0..1 BackboneElement Logical network location for application activity
..... 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
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
.... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... source 1..1 BackboneElement Audit Event Reporter
.... 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 string Logical source location within the enterprise
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:site 0..1 Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) R5: site additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site
Constraints: ext-1
..... value 0..1 string Primitive value for string
Max Length:1048576
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:observer 0..1 Reference(Resource) R5: observer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 0..* CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type
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.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... entity C 0..* BackboneElement Data or objects used
Constraints: sev-1
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:agent 0..* (Complex) R5: Entity is attributed to this agent (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent
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
.... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
.... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:role 0..1 CodeableConcept R5: role additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
.... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:securityLabel 0..* CodeableConcept R5: securityLabel additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel
Binding: R5SecurityLabelExamplesForR4 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
Constraints: ext-1
..... system Σ 0..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... name ΣC 0..1 string Descriptor for entity
.... description 0..1 string Descriptive text
.... query ΣC 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:value 0..1 Quantity, CodeableConcept, boolean, integer, Range, Ratio, time, dateTime, Period R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... type 1..1 string Name of the property
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:type 0..1 CodeableConcept R5: type additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type
Binding: AuditEventID (example): Additional detail about an entity used in an event.
Constraints: ext-1
...... value 0..1 string Primitive value for string
Max Length:1048576
..... value[x] 1..1 Property value
...... valueString string
...... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages . 📍4.0.1 tx.fhir.org
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📍3.1.0 THO v7.1
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v7.1
AuditEvent.source.observer.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.type.system, AuditEvent.type.version, AuditEvent.type.code, AuditEvent.type.display, AuditEvent.type.userSelected, AuditEvent.subtype, AuditEvent.subtype.extension, AuditEvent.subtype.extension:code, AuditEvent.subtype.system, AuditEvent.subtype.version, AuditEvent.subtype.code, AuditEvent.subtype.display, AuditEvent.subtype.userSelected, AuditEvent.action, AuditEvent.period, AuditEvent.period.extension, AuditEvent.period.extension:occurred, AuditEvent.period.start, AuditEvent.period.end, AuditEvent.recorded, AuditEvent.outcome, AuditEvent.outcome.extension, AuditEvent.outcome.extension:code, AuditEvent.outcome.extension:detail, AuditEvent.outcomeDesc, AuditEvent.purposeOfEvent, AuditEvent.agent, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.type, AuditEvent.agent.role, AuditEvent.agent.who, AuditEvent.agent.altId, AuditEvent.agent.name, AuditEvent.agent.requestor, AuditEvent.agent.location, AuditEvent.agent.policy, AuditEvent.agent.media, AuditEvent.agent.network, AuditEvent.agent.network.extension, AuditEvent.agent.network.modifierExtension, AuditEvent.agent.network.address, AuditEvent.agent.network.type, AuditEvent.agent.purposeOfUse, AuditEvent.source, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site, AuditEvent.source.site.extension, AuditEvent.source.site.extension:site, AuditEvent.source.observer, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer, AuditEvent.source.observer.reference, AuditEvent.source.observer.type, AuditEvent.source.observer.identifier, AuditEvent.source.observer.display, AuditEvent.source.type, AuditEvent.source.type.extension, AuditEvent.source.type.extension:type, AuditEvent.source.type.system, AuditEvent.source.type.version, AuditEvent.source.type.code, AuditEvent.source.type.display, AuditEvent.source.type.userSelected, AuditEvent.entity, AuditEvent.entity.extension, AuditEvent.entity.extension:agent, AuditEvent.entity.modifierExtension, AuditEvent.entity.what, AuditEvent.entity.type, AuditEvent.entity.role, AuditEvent.entity.role.extension, AuditEvent.entity.role.extension:role, AuditEvent.entity.role.system, AuditEvent.entity.role.version, AuditEvent.entity.role.code, AuditEvent.entity.role.display, AuditEvent.entity.role.userSelected, AuditEvent.entity.lifecycle, AuditEvent.entity.securityLabel, AuditEvent.entity.securityLabel.extension, AuditEvent.entity.securityLabel.extension:securityLabel, AuditEvent.entity.securityLabel.system, AuditEvent.entity.securityLabel.version, AuditEvent.entity.securityLabel.code, AuditEvent.entity.securityLabel.display, AuditEvent.entity.securityLabel.userSelected, AuditEvent.entity.name, AuditEvent.entity.description, AuditEvent.entity.query, AuditEvent.entity.detail, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.extension:value, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type, AuditEvent.entity.detail.type.extension, AuditEvent.entity.detail.type.extension:type, AuditEvent.entity.detail.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error AuditEvent.extension, AuditEvent.extension:severity, AuditEvent.extension:basedOn, AuditEvent.extension:patient, AuditEvent.extension:encounter, AuditEvent.modifierExtension, AuditEvent.type.extension, AuditEvent.type.extension:category, AuditEvent.subtype.extension, AuditEvent.subtype.extension:code, AuditEvent.period.extension, AuditEvent.period.extension:occurred, AuditEvent.outcome.extension, AuditEvent.outcome.extension:code, AuditEvent.outcome.extension:detail, AuditEvent.agent.extension, AuditEvent.agent.modifierExtension, AuditEvent.agent.network.extension, AuditEvent.agent.network.modifierExtension, AuditEvent.source.extension, AuditEvent.source.modifierExtension, AuditEvent.source.site.extension, AuditEvent.source.site.extension:site, AuditEvent.source.observer.extension, AuditEvent.source.observer.extension:observer, AuditEvent.source.type.extension, AuditEvent.source.type.extension:type, AuditEvent.entity.extension, AuditEvent.entity.extension:agent, AuditEvent.entity.modifierExtension, AuditEvent.entity.role.extension, AuditEvent.entity.role.extension:role, AuditEvent.entity.securityLabel.extension, AuditEvent.entity.securityLabel.extension:securityLabel, AuditEvent.entity.detail.extension, AuditEvent.entity.detail.extension:value, AuditEvent.entity.detail.modifierExtension, AuditEvent.entity.detail.type.extension, AuditEvent.entity.detail.type.extension:type Must have either extensions or value[x], not both extension.exists() != value.exists()
sev-1 error AuditEvent.entity Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 0 element(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron