Mobile access to Health Documents (MHD)
5.0.0-current - ci-build International flag

Mobile access to Health Documents (MHD), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 5.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.MHD/ and changes regularly. See the Directory of published versions

Resource Profile: Audit Event for Provide Bundle Transaction at Source

Official URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.ProvideBundle.Audit.Source Version: 5.0.0-current
Active as of 2025-10-13 Computable Name: AuditProvideBundleSource

Defines constraints on the AuditEvent Resource to record when a Provide Bundle Transaction happens at the Source.

  • Export event
  • shall have source of itself
  • shall have a document source agent
  • shall have a document recipient agent
  • may have user, app, organization agent(s)
  • shall have a patient entity
  • shall have a submission set identity entity

Usages:

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 Record of an event
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for category Σ 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
Binding: AuditEventID (example): Type of event.
.... category:iti65 Σ 1..1 CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
Required Pattern: R
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.
..... text SΣ 0..1 string Plain text representation of the concept
... Slices for agent Σ 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
.... agent:documentSource ΣC 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... network[x] 1..1 This agent network location for the activity
...... networkReference Reference(Endpoint)
...... networkUri uri
...... networkString string
.... agent:documentRecipient Σ 1..1 BackboneElement Document Recipient
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... network[x] 1..1 This agent network location for the activity
...... networkReference Reference(Endpoint)
...... networkUri uri
...... networkString string
... source Σ 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
... Slices for entity Σ 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:patient Σ 1..1 BackboneElement Patient
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... entity:submissionSet Σ 1..1 BackboneElement SubmissionSet
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category:iti65 Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍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.agent:documentSource.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​role Base example Audit Event Entity Role 📍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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Record of an event
... modifierExtension 0..0
... Slices for category 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
.... category:iti65 1..1 CodeableConcept Type/identifier of event
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
... code 1..1 CodeableConcept Specific type of event
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
... action 0..1 code Type of action performed during the event
Required Pattern: R
... outcome
.... detail
..... text S 0..1 string Plain text representation of the concept
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:documentSource C 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
..... network[x] 1..1 Reference(Endpoint), uri, string This agent network location for the activity
.... agent:documentRecipient 1..1 BackboneElement Document Recipient
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
..... network[x] 1..1 Reference(Endpoint), uri, string This agent network location for the activity
... Slices for entity 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:patient 1..1 BackboneElement Patient
..... what 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
.... entity:submissionSet 1..1 BackboneElement SubmissionSet
..... what 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for category Σ 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
Binding: AuditEventID (example): Type of event.
.... category:iti65 Σ 1..1 CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
Required Pattern: R
... 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 Σ 1..1 instant Time when the event was recorded
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
... authorization Σ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (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
... Slices for agent Σ 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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 (example): The reason the activity took place.
.... agent:documentSource ΣC 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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] 1..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 (example): The reason the activity took place.
.... agent:documentRecipient Σ 1..1 BackboneElement Document Recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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] 1..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 (example): 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 Reference(Location) Logical source location within the enterprise
.... observer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... 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.
... Slices for entity Σ 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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
.... entity:patient Σ 1..1 BackboneElement Patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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
.... entity:submissionSet Σ 1..1 BackboneElement SubmissionSet
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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.category:iti65 Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example 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 v6.5
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 v6.5
AuditEvent.agent:documentSource.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentSource.​role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentSource.​authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
AuditEvent.agent:documentRecipient.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
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.
AuditEvent.entity:patient.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​detail.type Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer

This structure is derived from AuditEvent

Summary

Mandatory: 14 elements
Must-Support: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.category
  • The element 1 is sliced based on the value of AuditEvent.agent
  • The element 1 is sliced based on the value of AuditEvent.entity

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Record of an event
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for category Σ 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
Binding: AuditEventID (example): Type of event.
.... category:iti65 Σ 1..1 CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
Required Pattern: R
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 BackboneElement Whether the event succeeded or failed
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.
..... text SΣ 0..1 string Plain text representation of the concept
... Slices for agent Σ 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
.... agent:documentSource ΣC 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... network[x] 1..1 This agent network location for the activity
...... networkReference Reference(Endpoint)
...... networkUri uri
...... networkString string
.... agent:documentRecipient Σ 1..1 BackboneElement Document Recipient
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... network[x] 1..1 This agent network location for the activity
...... networkReference Reference(Endpoint)
...... networkUri uri
...... networkString string
... source Σ 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
... Slices for entity Σ 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity:patient Σ 1..1 BackboneElement Patient
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... entity:submissionSet Σ 1..1 BackboneElement SubmissionSet
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category:iti65 Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍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.agent:documentSource.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​role Base example Audit Event Entity Role 📍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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Record of an event
... modifierExtension 0..0
... Slices for category 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
.... category:iti65 1..1 CodeableConcept Type/identifier of event
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
... code 1..1 CodeableConcept Specific type of event
Required Pattern: At least the following
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
... action 0..1 code Type of action performed during the event
Required Pattern: R
... outcome
.... detail
..... text S 0..1 string Plain text representation of the concept
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:documentSource C 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
..... network[x] 1..1 Reference(Endpoint), uri, string This agent network location for the activity
.... agent:documentRecipient 1..1 BackboneElement Document Recipient
..... type 1..1 CodeableConcept How agent participated
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
..... network[x] 1..1 Reference(Endpoint), uri, string This agent network location for the activity
... Slices for entity 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:patient 1..1 BackboneElement Patient
..... what 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
.... entity:submissionSet 1..1 BackboneElement SubmissionSet
..... what 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent 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
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... Slices for category Σ 1..* CodeableConcept Type/identifier of event
Slice: Unordered, Open by value:$this
Binding: AuditEventID (example): Type of event.
.... category:iti65 Σ 1..1 CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-65
...... display 1..1 string Representation defined by the system
Fixed Value: Provide Document Bundle
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110106
..... display 1..1 string Representation defined by the system
Fixed Value: Export
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
Required Pattern: R
... 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 Σ 1..1 instant Time when the event was recorded
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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.
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
... authorization Σ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (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
... Slices for agent Σ 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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 Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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 (example): The reason the activity took place.
.... agent:documentSource ΣC 1..1 BackboneElement Document Source
Constraints: val-audit-source
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 1..1 string Representation defined by the system
Fixed Value: Source Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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] 1..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 (example): The reason the activity took place.
.... agent:documentRecipient Σ 1..1 BackboneElement Document Recipient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 1..1 string Representation defined by the system
Fixed Value: Destination Role ID
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
..... 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] 1..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 (example): 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 Reference(Location) Logical source location within the enterprise
.... observer Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... 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.
... Slices for entity Σ 2..* BackboneElement Data or objects used
Slice: Unordered, Open by value:role
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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
.... entity:patient Σ 1..1 BackboneElement Patient
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Patient) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 1
....... display 1..1 string Representation defined by the system
Fixed Value: Patient
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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
.... entity:submissionSet Σ 1..1 BackboneElement SubmissionSet
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(List) Specific instance of resource
..... role 1..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 20
....... display 1..1 string Representation defined by the system
Fixed Value: Job
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... 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.category:iti65 Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example 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 v6.5
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 v6.5
AuditEvent.agent:documentSource.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentSource.​role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentSource.​authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
AuditEvent.agent:documentRecipient.​type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent:documentRecipient.​authorization Base example PurposeOfUse 📦3.1.0 THO v6.5
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.
AuditEvent.entity:patient.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity:patient.​detail.type Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity:submissionSet.​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 **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
val-audit-source error AuditEvent.agent:documentSource The Audit Source is this agent too. $this.who = %resource.source.observer

This structure is derived from AuditEvent

Summary

Mandatory: 14 elements
Must-Support: 1 element
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.category
  • The element 1 is sliced based on the value of AuditEvent.agent
  • The element 1 is sliced based on the value of AuditEvent.entity

 

Other representations of profile: CSV, Excel, Schematron