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

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: Create - Detailed Descriptions

Active as of 2025-10-13

Definitions for the IHE.BasicAudit.MHD5.Create resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. AuditEvent
Definition | A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
Short | Record of an event
Comments | Based on IHE-ATNA.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. AuditEvent.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. AuditEvent.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
6. AuditEvent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. AuditEvent.category
Definition | Classification of the type of event.
Short | Type/identifier of event
Control | 10..*
Binding | For example codes, see AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0 (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Codes that classify the general type of event that happened.
Alternate Names | type
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `AuditEvent.category`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
10. AuditEvent.category:anyCreate
Slice Name | anyCreate
Definition | Classification of the type of event.
Short | Type/identifier of event
Control | 10..1*
Binding | For example codes, see AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0 (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Codes that classify the general type of event that happened.
Alternate Names | type
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/restful-interaction", "code" : "create" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. AuditEvent.code
Definition | Describes what happened. The most specific code for the event.
Short | Specific type of event
Control | 1..1
Binding | For example codes, see AuditEventSubType http://hl7.org/fhir/ValueSet/audit-event-sub-type|5.0.0 (example to `http://hl7.org/fhir/ValueSet/audit-event-sub-type|5.0.0` ) Specific type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field enables queries of messages by implementation-defined event categories.
Alternate Names | subtype
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type", "code" : "rest" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. AuditEvent.action
Definition | Indicator for type of action performed during the event that generated the audit.
Short | Type of action performed during the event
Control | 0..1
Binding | The codes SHALL be taken from AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0 (required to `http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0` ) DICOM Audit Event Action
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.
Pattern Value | `C`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. AuditEvent.recorded
Definition | The time when the event was recorded.
Short | Time when the event was recorded
Comments | In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
Control | 1..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. AuditEvent.agent
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 21..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `AuditEvent.agent`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
20. AuditEvent.agent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. AuditEvent.agent.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. AuditEvent.agent:client
Slice Name | client
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 1..1*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. AuditEvent.agent:client.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. AuditEvent.agent:client.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 10..1
Binding | The codes SHOULD be taken from ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0 (preferred to `http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0` ) The Participation type of the agent to the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110153" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
30. AuditEvent.agent:client.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
32. AuditEvent.agent:client.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 10..1
Type | Choice of: Reference(Endpoint), uri, string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
34. AuditEvent.agent:server
Slice Name | server
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 1..1*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
36. AuditEvent.agent:server.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. AuditEvent.agent:server.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 10..1
Binding | The codes SHOULD be taken from ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0 (preferred to `http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0` ) The Participation type of the agent to the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110152" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
40. AuditEvent.agent:server.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
42. AuditEvent.agent:server.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 10..1
Type | Choice of: Reference(Endpoint), uri, string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
44. AuditEvent.agent:user
Slice Name | user
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 01..1*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
46. AuditEvent.agent:user.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. AuditEvent.agent:user.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 10..1
Binding | The codes SHALL be taken from The codes SHOULD be taken from participant source types for RESTful create http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0 (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/DataSources` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. AuditEvent.agent:user.role
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
Short | Agent role in the event
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
Control | 0..*
Binding | For example codes, see SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type|5.0.0 (example to `http://hl7.org/fhir/ValueSet/security-role-type|5.0.0` ) What security role enabled the agent to participate in the event.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
52. AuditEvent.agent:user.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
54. AuditEvent.agent:user.requestor
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Short | Whether user is initiator
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
Meaning if Missing | false
Pattern Value | `true`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
56. AuditEvent.agent:user.policy
Definition | Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Short | Policy that authorized the agent participation in the event
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | This value is used retrospectively to determine the authorization policies.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. AuditEvent.agent:user.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 0..01
Type | Choice of: Reference(Endpoint), uri, string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. AuditEvent.source
Definition | The actor that is reporting the event.
Short | Audit Event Reporter
Comments | Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Requirements | The event is reported by one source.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. AuditEvent.source.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
64. AuditEvent.source.observer
Definition | Identifier of the source where the event was detected.
Short | The identity of source detecting the event
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.
Alternate Names | SourceId
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. AuditEvent.entity
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 10..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `AuditEvent.entity`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ role
68. AuditEvent.entity.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
70. AuditEvent.entity:transaction
Slice Name | transaction
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 0..1*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. AuditEvent.entity:transaction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
74. AuditEvent.entity:transaction.role
Definition | Code representing the role the entity played in the event being audited.
Short | What role the entity played
Control | 10..1
Binding | For example codes, see AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role|5.0.0 (example to `http://hl7.org/fhir/ValueSet/object-role|5.0.0` ) DICOM Audit Event Entity Role
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
Pattern Value | `{ "coding" : [{ "system" : "https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType", "code" : "XrequestId" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. AuditEvent.entity:data
Slice Name | data
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 10..1*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. AuditEvent.entity:data.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
80. AuditEvent.entity:data.what
Definition | Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.
Short | Specific instance of resource
Comments | Use .what.display when all you have is a string (e.g. ParticipantObjectName).
Control | 10..1
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
82. AuditEvent.entity:data.role
Definition | Code representing the role the entity played in the event being audited.
Short | What role the entity played
Control | 0..1
Binding | The codes SHALL be taken from For example codes, see RESTful objects role in the event http://hl7.org/fhir/ValueSet/object-role|5.0.0 (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/RestObjectRoles` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
84. AuditEvent.entity:data.securityLabel
Definition | Security labels for the identified entity.
Short | may contain the security labels on the resource returnedSecurity labels on the entity
Comments | Copied from entity meta security tags.
Control | 0..*
Binding | For example codes, see SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0 (example to `http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0` ) Example Security Labels from the Healthcare Privacy and Security Classification System.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. AuditEvent
2. AuditEvent.category
Control | 1..?
Slicing | This element introduces a set of slices on `AuditEvent.category`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
4. AuditEvent.category:anyCreate
Slice Name | anyCreate
Control | 1..1
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/restful-interaction", "code" : "create" }] }`
6. AuditEvent.code
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type", "code" : "rest" }] }`
8. AuditEvent.action
Pattern Value | `C`
10. AuditEvent.outcome
12. AuditEvent.outcome.code
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome", "code" : "0" }`
14. AuditEvent.agent
Control | 2..?
Slicing | This element introduces a set of slices on `AuditEvent.agent`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
16. AuditEvent.agent:client
Slice Name | client
Control | 1..1
18. AuditEvent.agent:client.type
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110153" }] }`
20. AuditEvent.agent:client.network[x]
Control | 1..?
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
22. AuditEvent.agent:server
Slice Name | server
Control | 1..1
24. AuditEvent.agent:server.type
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110152" }] }`
26. AuditEvent.agent:server.network[x]
Control | 1..?
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
28. AuditEvent.agent:user
Slice Name | user
Control | 0..1
30. AuditEvent.agent:user.type
Control | 1..?
Binding | The codes SHALL be taken from participant source types for RESTful create (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/DataSources` )
32. AuditEvent.agent:user.role
Must Support | true
34. AuditEvent.agent:user.requestor
Pattern Value | `true`
36. AuditEvent.agent:user.policy
Must Support | true
38. AuditEvent.agent:user.network[x]
Control | 0..0
40. AuditEvent.source
Must Support | true
42. AuditEvent.entity
Control | 1..?
Slicing | This element introduces a set of slices on `AuditEvent.entity`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ role
44. AuditEvent.entity:transaction
Slice Name | transaction
Control | 0..1
46. AuditEvent.entity:transaction.what
48. AuditEvent.entity:transaction.what.identifier
Note | This is a business identifier, not a resource identifier (see discussion)
50. AuditEvent.entity:transaction.what.identifier.value
Short | the value of X-Request-Id
Control | 1..?
52. AuditEvent.entity:transaction.role
Control | 1..?
Pattern Value | `{ "coding" : [{ "system" : "https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType", "code" : "XrequestId" }] }`
54. AuditEvent.entity:data
Slice Name | data
Control | 1..1
56. AuditEvent.entity:data.what
Control | 1..?
58. AuditEvent.entity:data.role
Binding | The codes SHALL be taken from RESTful objects role in the event (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/RestObjectRoles` )
60. AuditEvent.entity:data.securityLabel
Short | may contain the security labels on the resource returned

Guidance on how to interpret the contents of this table can be foundhere

0. AuditEvent
Definition | A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.
Short | Record of an event
Comments | Based on IHE-ATNA.
Control | 0..*
Is Modifier | false
Must Support | false
Summary | false
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (`text.`div`.exists()`)
2. AuditEvent.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control | 0..1
Type | id
Is Modifier | false
Must Support | false
Summary | true
4. AuditEvent.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. AuditEvent.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
Control | 0..1
Type | uri
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. AuditEvent.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages|5.0.0` ) IETF language tag for a human language
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
10. AuditEvent.text
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
Control | 0..1 This element is affected by the following invariants: dom-6
Type | Narrative
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | narrative, html, xhtml, display
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
12. AuditEvent.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
Short | Contained, inline Resources
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
Type | Resource
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
14. AuditEvent.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Must Support | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
16. AuditEvent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support | false
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. AuditEvent.category
Definition | Classification of the type of event.
Short | Type/identifier of event
Control | 1..*
Binding | For example codes, see AuditEventID (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Codes that classify the general type of event that happened.
Alternate Names | type
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `AuditEvent.category`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ $this
20. AuditEvent.category:anyCreate
Slice Name | anyCreate
Definition | Classification of the type of event.
Short | Type/identifier of event
Control | 1..1
Binding | For example codes, see AuditEventID (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Codes that classify the general type of event that happened.
Alternate Names | type
Pattern Value | `{ "coding" : [{ "system" : "http://hl7.org/fhir/restful-interaction", "code" : "create" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. AuditEvent.code
Definition | Describes what happened. The most specific code for the event.
Short | Specific type of event
Control | 1..1
Binding | For example codes, see AuditEventSubType (example to `http://hl7.org/fhir/ValueSet/audit-event-sub-type|5.0.0` ) Specific type of event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field enables queries of messages by implementation-defined event categories.
Alternate Names | subtype
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type", "code" : "rest" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. AuditEvent.action
Definition | Indicator for type of action performed during the event that generated the audit.
Short | Type of action performed during the event
Control | 0..1
Binding | The codes SHALL be taken from AuditEventAction (required to `http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0` ) DICOM Audit Event Action
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.
Pattern Value | `C`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. AuditEvent.severity
Definition | Indicates and enables segmentation of various severity including debugging from critical.
Short | emergency | alert | critical | error | warning | notice | informational | debug
Comments | ATNA will map this to the SYSLOG PRI element.
Control | 0..1
Binding | The codes SHALL be taken from AuditEventSeverity (required to `http://hl7.org/fhir/ValueSet/audit-event-severity|5.0.0` ) This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
28. AuditEvent.occurred[x]
Definition | The time or period during which the activity occurred.
Short | When the activity occurred
Comments | The time or period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
Control | 0..1
Type | Choice of: Period, dateTime
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
30. AuditEvent.recorded
Definition | The time when the event was recorded.
Short | Time when the event was recorded
Comments | In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
Control | 1..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
32. AuditEvent.outcome
Definition | Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.
Short | Whether the event succeeded or failed
Comments | In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | when a code is given there must be one code from the given codeSystem, and may be other equivilant codes from other codeSystems (for example http response codes such as 2xx, 4xx, or 5xx).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
34. AuditEvent.outcome.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
36. AuditEvent.outcome.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
38. AuditEvent.outcome.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
40. AuditEvent.outcome.code
Definition | Indicates whether the event succeeded or failed.
Short | Whether the event succeeded or failed
Comments | In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
Control | 1..1
Binding | The codes SHOULD be taken from AuditEventOutcome (preferred to `http://hl7.org/fhir/ValueSet/audit-event-outcome|5.0.0` ) DICOM Audit Event Outcome
Type | Coding
Is Modifier | false
Must Support | false
Summary | true
Requirements | when a code is given there must be one code from the given codeSystem.
Pattern Value | `{ "system" : "http://terminology.hl7.org/CodeSystem/audit-event-outcome", "code" : "0" }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
42. AuditEvent.outcome.detail
Definition | Additional details about the error. This may be a text description of the error or a system code that identifies the error.
Short | Additional outcome detail
Comments | A human readable description of the error issue SHOULD be placed in details.text.
Control | 0..*
Binding | For example codes, see AuditEventOutcomeDetail (example to `http://hl7.org/fhir/ValueSet/audit-event-outcome-detail|5.0.0` ) A code that provides details as the exact issue.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
44. AuditEvent.authorization
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
Short | Authorization related to the event
Comments | Use AuditEvent.agent.authorization when you know that it is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
Control | 0..*
Binding | For example codes, see PurposeOfUse (example to `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` ) The authorized purposeOfUse for the activity.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | true
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
Alternate Names | PurposeOfEvent
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
46. AuditEvent.basedOn
Definition | Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.
Short | Workflow authorization within which this event occurred
Control | 0..*
Type | Reference(CarePlan, DeviceRequest, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest, Task)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
48. AuditEvent.patient
Definition | The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.
Short | The patient is the subject of the data used/created/updated/deleted during the activity
Control | 0..1
Type | Reference(Patient)
Is Modifier | false
Must Support | false
Summary | false
Requirements | When the .patient is populated it shall be accurate to the subject of the used data. The .patient shall not be populated when the used data used/created/updated/deleted (.entity) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
50. AuditEvent.encounter
Definition | This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).
Short | Encounter within which this event occurred or which the event is tightly associated
Control | 0..1
Type | Reference(Encounter)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
52. AuditEvent.agent
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 2..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `AuditEvent.agent`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ type
54. AuditEvent.agent.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
56. AuditEvent.agent.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
58. AuditEvent.agent.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
60. AuditEvent.agent.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 0..1
Binding | The codes SHOULD be taken from ParticipationRoleType (preferred to `http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0` ) The Participation type of the agent to the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
62. AuditEvent.agent.role
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
Short | Agent role in the event
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
Control | 0..*
Binding | For example codes, see SecurityRoleType (example to `http://hl7.org/fhir/ValueSet/security-role-type|5.0.0` ) What security role enabled the agent to participate in the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
64. AuditEvent.agent.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
66. AuditEvent.agent.requestor
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Short | Whether user is initiator
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
Meaning if Missing | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
68. AuditEvent.agent.location
Definition | Where the agent location is known, the agent location when the event occurred.
Short | The agent location when the event occurred
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
70. AuditEvent.agent.policy
Definition | Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Short | Policy that authorized the agent participation in the event
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | This value is used retrospectively to determine the authorization policies.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
72. AuditEvent.agent.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 0..1
Type | Choice of: Reference(Endpoint), uri, string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
74. AuditEvent.agent.authorization
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
Short | Allowable authorization for this agent
Comments | Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
Control | 0..*
Binding | For example codes, see PurposeOfUse (example to `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` ) The reason the activity took place.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
Alternate Names | PurposeOfUse
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
76. AuditEvent.agent:client
Slice Name | client
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
78. AuditEvent.agent:client.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
80. AuditEvent.agent:client.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
82. AuditEvent.agent:client.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
84. AuditEvent.agent:client.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 1..1
Binding | The codes SHOULD be taken from ParticipationRoleType (preferred to `http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0` ) The Participation type of the agent to the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110153" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
86. AuditEvent.agent:client.role
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
Short | Agent role in the event
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
Control | 0..*
Binding | For example codes, see SecurityRoleType (example to `http://hl7.org/fhir/ValueSet/security-role-type|5.0.0` ) What security role enabled the agent to participate in the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
88. AuditEvent.agent:client.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
90. AuditEvent.agent:client.requestor
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Short | Whether user is initiator
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
Meaning if Missing | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
92. AuditEvent.agent:client.location
Definition | Where the agent location is known, the agent location when the event occurred.
Short | The agent location when the event occurred
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
94. AuditEvent.agent:client.policy
Definition | Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Short | Policy that authorized the agent participation in the event
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | This value is used retrospectively to determine the authorization policies.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
96. AuditEvent.agent:client.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 1..1
Type | Choice of: Reference(Endpoint), uri, string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
98. AuditEvent.agent:client.authorization
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
Short | Allowable authorization for this agent
Comments | Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
Control | 0..*
Binding | For example codes, see PurposeOfUse (example to `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` ) The reason the activity took place.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
Alternate Names | PurposeOfUse
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
100. AuditEvent.agent:server
Slice Name | server
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
102. AuditEvent.agent:server.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
104. AuditEvent.agent:server.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
106. AuditEvent.agent:server.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
108. AuditEvent.agent:server.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 1..1
Binding | The codes SHOULD be taken from ParticipationRoleType (preferred to `http://hl7.org/fhir/ValueSet/participation-role-type|5.0.0` ) The Participation type of the agent to the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Pattern Value | `{ "coding" : [{ "system" : "http://dicom.nema.org/resources/ontology/DCM", "code" : "110152" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
110. AuditEvent.agent:server.role
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
Short | Agent role in the event
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
Control | 0..*
Binding | For example codes, see SecurityRoleType (example to `http://hl7.org/fhir/ValueSet/security-role-type|5.0.0` ) What security role enabled the agent to participate in the event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
112. AuditEvent.agent:server.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
114. AuditEvent.agent:server.requestor
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Short | Whether user is initiator
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
Meaning if Missing | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
116. AuditEvent.agent:server.location
Definition | Where the agent location is known, the agent location when the event occurred.
Short | The agent location when the event occurred
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
118. AuditEvent.agent:server.policy
Definition | Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Short | Policy that authorized the agent participation in the event
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | This value is used retrospectively to determine the authorization policies.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
120. AuditEvent.agent:server.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 1..1
Type | Choice of: Reference(Endpoint), uri, string
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
122. AuditEvent.agent:server.authorization
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
Short | Allowable authorization for this agent
Comments | Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
Control | 0..*
Binding | For example codes, see PurposeOfUse (example to `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` ) The reason the activity took place.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
Alternate Names | PurposeOfUse
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
124. AuditEvent.agent:user
Slice Name | user
Definition | An actor taking an active role in the event or activity that is logged.
Short | Actor involved in the event
Comments | Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity. When a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
Alternate Names | ActiveParticipant
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
126. AuditEvent.agent:user.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
128. AuditEvent.agent:user.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
130. AuditEvent.agent:user.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
132. AuditEvent.agent:user.type
Definition | The Functional Role of the user when performing the event.
Short | How agent participated
Comments | For example: assembler, author, prescriber, signer, investigator, etc.
Control | 1..1
Binding | The codes SHALL be taken from participant source types for RESTful create (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/DataSources` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
134. AuditEvent.agent:user.role
Definition | The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
Short | Agent role in the event
Comments | For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
Control | 0..*
Binding | For example codes, see SecurityRoleType (example to `http://hl7.org/fhir/ValueSet/security-role-type|5.0.0` ) What security role enabled the agent to participate in the event.
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | false
Requirements | Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
136. AuditEvent.agent:user.who
Definition | Reference to who this agent is that was involved in the event.
Short | Identifier of who
Comments | Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties an audit event to a specific resource or identifier.
Alternate Names | userId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
138. AuditEvent.agent:user.requestor
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited.
Short | Whether user is initiator
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.
Meaning if Missing | false
Pattern Value | `true`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
140. AuditEvent.agent:user.location
Definition | Where the agent location is known, the agent location when the event occurred.
Short | The agent location when the event occurred
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
142. AuditEvent.agent:user.policy
Definition | Where the policy(ies) are known that authorized the agent participation in the event. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Short | Policy that authorized the agent participation in the event
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.
Control | 0..*
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | false
Requirements | This value is used retrospectively to determine the authorization policies.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
144. AuditEvent.agent:user.network[x]
Definition | When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
Short | This agent network location for the activity
Comments | When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.
Control | 0..0
Type | Choice of: Reference(Endpoint), uri, string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
146. AuditEvent.agent:user.authorization
Definition | The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
Short | Allowable authorization for this agent
Comments | Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
Control | 0..*
Binding | For example codes, see PurposeOfUse (example to `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse` ) The reason the activity took place.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.
Alternate Names | PurposeOfUse
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
148. AuditEvent.source
Definition | The actor that is reporting the event.
Short | Audit Event Reporter
Comments | Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | true
Summary | true
Requirements | The event is reported by one source.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
150. AuditEvent.source.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
152. AuditEvent.source.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
154. AuditEvent.source.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
156. AuditEvent.source.site
Definition | Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
Short | Logical source location within the enterprise
Control | 0..1
Type | Reference(Location)
Is Modifier | false
Must Support | false
Summary | false
Requirements | This value differentiates among the sites in a multi-site enterprise health information system.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
158. AuditEvent.source.observer
Definition | Identifier of the source where the event was detected.
Short | The identity of source detecting the event
Control | 1..1
Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
Is Modifier | false
Must Support | false
Summary | true
Requirements | This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.
Alternate Names | SourceId
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
160. AuditEvent.source.type
Definition | Code specifying the type of source where event originated.
Short | The type of source where event originated
Control | 0..*
Binding | The codes SHOULD be taken from AuditEventSourceType (preferred to `http://hl7.org/fhir/ValueSet/security-source-type|5.0.0` ) 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.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
162. AuditEvent.entity
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 1..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing | This element introduces a set of slices on `AuditEvent.entity`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ role
164. AuditEvent.entity.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
166. AuditEvent.entity.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
168. AuditEvent.entity.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
170. AuditEvent.entity.what
Definition | Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.
Short | Specific instance of resource
Comments | Use .what.display when all you have is a string (e.g. ParticipantObjectName).
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
172. AuditEvent.entity.role
Definition | Code representing the role the entity played in the event being audited.
Short | What role the entity played
Control | 0..1
Binding | For example codes, see AuditEventEntityRole (example to `http://hl7.org/fhir/ValueSet/object-role|5.0.0` ) DICOM Audit Event Entity Role
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
174. AuditEvent.entity.securityLabel
Definition | Security labels for the identified entity.
Short | Security labels on the entity
Comments | Copied from entity meta security tags.
Control | 0..*
Binding | For example codes, see SecurityLabelExamples (example to `http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0` ) Example Security Labels from the Healthcare Privacy and Security Classification System.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
176. AuditEvent.entity.query
Definition | The query parameters for a query-type entities.
Short | Query parameters
Comments | The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. The DICOM AuditMessage schema does not support both .name and .query being populated.
Control | 0..1
Type | base64Binary
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
178. AuditEvent.entity.detail
Definition | Tagged value pairs for conveying additional information about the entity.
Short | Additional Information about the entity
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Requirements | Implementation-defined data about specific details of the object accessed or used.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
180. AuditEvent.entity.detail.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
182. AuditEvent.entity.detail.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
184. AuditEvent.entity.detail.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
186. AuditEvent.entity.detail.type
Definition | The type of extra detail provided in the value.
Short | Name of the property
Control | 1..1
Binding | For example codes, see AuditEventID (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Additional detail about an entity used in an event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
188. AuditEvent.entity.detail.value[x]
Definition | The value of the extra detail.
Short | Property value
Control | 1..1
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, time, dateTime, Period, base64Binary
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Should not duplicate the entity value unless absolutely necessary.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
190. AuditEvent.entity.agent
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.
Short | Entity is attributed to this agent
Comments | A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
192. AuditEvent.entity:transaction
Slice Name | transaction
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 0..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
194. AuditEvent.entity:transaction.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
196. AuditEvent.entity:transaction.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
198. AuditEvent.entity:transaction.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
200. AuditEvent.entity:transaction.what
Definition | Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.
Short | Specific instance of resource
Comments | Use .what.display when all you have is a string (e.g. ParticipantObjectName).
Control | 0..1
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
202. AuditEvent.entity:transaction.what.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
204. AuditEvent.entity:transaction.what.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `AuditEvent.entity.what.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
206. AuditEvent.entity:transaction.what.reference
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Short | Literal reference, Relative, internal or absolute URL
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Control | 0..1 This element is affected by the following invariants: ref-2, ref-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
208. AuditEvent.entity:transaction.what.type
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to `http://hl7.org/fhir/ValueSet/resource-types|5.0.0` ) Aa resource (or, for logical models, the URI of the logical model).
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
210. AuditEvent.entity:transaction.what.identifier
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1 This element is affected by the following invariants: ref-2
Type | Identifier
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
212. AuditEvent.entity:transaction.what.identifier.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | id
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
214. AuditEvent.entity:transaction.what.identifier.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing | This element introduces a set of slices on `AuditEvent.entity.what.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
216. AuditEvent.entity:transaction.what.identifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|5.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
218. AuditEvent.entity:transaction.what.identifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Description of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type|5.0.0` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
220. AuditEvent.entity:transaction.what.identifier.system
Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Short | The namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 0..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
222. AuditEvent.entity:transaction.what.identifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | the value of X-Request-Id
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Control | 1..1 This element is affected by the following invariants: ident-1
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Example | General: 123456
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
224. AuditEvent.entity:transaction.what.identifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
226. AuditEvent.entity:transaction.what.identifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
228. AuditEvent.entity:transaction.what.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Control | 0..1 This element is affected by the following invariants: ref-2
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
230. AuditEvent.entity:transaction.role
Definition | Code representing the role the entity played in the event being audited.
Short | What role the entity played
Control | 1..1
Binding | For example codes, see AuditEventEntityRole (example to `http://hl7.org/fhir/ValueSet/object-role|5.0.0` ) DICOM Audit Event Entity Role
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
Pattern Value | `{ "coding" : [{ "system" : "https://profiles.ihe.net/ITI/MHD/CodeSystem/BasicAuditEntityType", "code" : "XrequestId" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
232. AuditEvent.entity:transaction.securityLabel
Definition | Security labels for the identified entity.
Short | Security labels on the entity
Comments | Copied from entity meta security tags.
Control | 0..*
Binding | For example codes, see SecurityLabelExamples (example to `http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0` ) Example Security Labels from the Healthcare Privacy and Security Classification System.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
234. AuditEvent.entity:transaction.query
Definition | The query parameters for a query-type entities.
Short | Query parameters
Comments | The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. The DICOM AuditMessage schema does not support both .name and .query being populated.
Control | 0..1
Type | base64Binary
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
236. AuditEvent.entity:transaction.detail
Definition | Tagged value pairs for conveying additional information about the entity.
Short | Additional Information about the entity
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Requirements | Implementation-defined data about specific details of the object accessed or used.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
238. AuditEvent.entity:transaction.detail.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
240. AuditEvent.entity:transaction.detail.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
242. AuditEvent.entity:transaction.detail.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
244. AuditEvent.entity:transaction.detail.type
Definition | The type of extra detail provided in the value.
Short | Name of the property
Control | 1..1
Binding | For example codes, see AuditEventID (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Additional detail about an entity used in an event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
246. AuditEvent.entity:transaction.detail.value[x]
Definition | The value of the extra detail.
Short | Property value
Control | 1..1
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, time, dateTime, Period, base64Binary
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Should not duplicate the entity value unless absolutely necessary.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
248. AuditEvent.entity:transaction.agent
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.
Short | Entity is attributed to this agent
Comments | A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
250. AuditEvent.entity:data
Slice Name | data
Definition | Specific instances of data or objects that have been accessed.
Short | Data or objects used
Comments | Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
Control | 1..1
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | true
Requirements | The event may have other entities involved.
Alternate Names | ParticipantObject
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
252. AuditEvent.entity:data.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
254. AuditEvent.entity:data.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
256. AuditEvent.entity:data.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
258. AuditEvent.entity:data.what
Definition | Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.
Short | Specific instance of resource
Comments | Use .what.display when all you have is a string (e.g. ParticipantObjectName).
Control | 1..1
Type | Reference(Resource)
Is Modifier | false
Must Support | false
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
260. AuditEvent.entity:data.role
Definition | Code representing the role the entity played in the event being audited.
Short | What role the entity played
Control | 0..1
Binding | The codes SHALL be taken from RESTful objects role in the event (required to `https://profiles.ihe.net/ITI/MHD/ValueSet/RestObjectRoles` )
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
262. AuditEvent.entity:data.securityLabel
Definition | Security labels for the identified entity.
Short | may contain the security labels on the resource returned
Comments | Copied from entity meta security tags.
Control | 0..*
Binding | For example codes, see SecurityLabelExamples (example to `http://hl7.org/fhir/ValueSet/security-label-examples|5.0.0` ) Example Security Labels from the Healthcare Privacy and Security Classification System.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Requirements | This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
264. AuditEvent.entity:data.query
Definition | The query parameters for a query-type entities.
Short | Query parameters
Comments | The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. The DICOM AuditMessage schema does not support both .name and .query being populated.
Control | 0..1
Type | base64Binary
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | true
Requirements | For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
266. AuditEvent.entity:data.detail
Definition | Tagged value pairs for conveying additional information about the entity.
Short | Additional Information about the entity
Control | 0..*
Type | BackboneElement
Is Modifier | false
Must Support | false
Summary | false
Requirements | Implementation-defined data about specific details of the object accessed or used.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
268. AuditEvent.entity:data.detail.id
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | Unique id for inter-element referencing
Control | 0..1 This element is affected by the following invariants: ele-1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
270. AuditEvent.entity:data.detail.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short | Additional content defined by implementations
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
272. AuditEvent.entity:data.detail.modifierExtension
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Short | Extensions that cannot be ignored even if unrecognized
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, user content, modifiers
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
274. AuditEvent.entity:data.detail.type
Definition | The type of extra detail provided in the value.
Short | Name of the property
Control | 1..1
Binding | For example codes, see AuditEventID (example to `http://hl7.org/fhir/ValueSet/audit-event-type|5.0.0` ) Additional detail about an entity used in an event.
Type | CodeableConcept
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
276. AuditEvent.entity:data.detail.value[x]
Definition | The value of the extra detail.
Short | Property value
Control | 1..1
Type | Choice of: Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, time, dateTime, Period, base64Binary
[x] Note | SeeChoice of Data Typesfor further information about how to use [x]
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | false
Summary | false
Requirements | Should not duplicate the entity value unless absolutely necessary.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
278. AuditEvent.entity:data.agent
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.
Short | Entity is attributed to this agent
Comments | A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.
Control | 0..*
Type | Seettp://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent
Is Modifier | false
Must Support | false
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)