EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide, published by HL7 International / Electronic Health Records. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ehrs-rle-ig/ and changes regularly. See the Directory of published versions
Page standards status: Informative | Maturity Level: 1 |
Definitions for the ehrsrle-auditevent resource profile.
Guidance on how to interpret the contents of this table can be found here
0. AuditEvent | |
2. AuditEvent.category | |
Must Support | true |
4. AuditEvent.code | |
Binding | The codes SHOULD be taken from ValueSet record-lifecycle-events |
Must Support | true |
6. AuditEvent.action | |
Must Support | true |
8. AuditEvent.recorded | |
Must Support | true |
10. AuditEvent.authorization | |
Must Support | true |
12. AuditEvent.agent | |
Must Support | true |
14. AuditEvent.agent.who | |
Must Support | true |
16. AuditEvent.agent.requestor | |
Must Support | true |
18. AuditEvent.agent.location | |
Must Support | true |
20. AuditEvent.agent.network[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Must Support | true |
22. AuditEvent.agent.authorization | |
Must Support | true |
24. AuditEvent.source | |
Must Support | true |
26. AuditEvent.entity | |
Must Support | true |
28. AuditEvent.entity.what | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
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 | 0..* |
Binding | For example codes, see AuditEventIDhttp://hl7.org/fhir/ValueSet/audit-event-type Type of event. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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())) |
10. AuditEvent.code | |
Definition | Describes what happened. The most specific code for the event. |
Short | Specific type of event |
Control | 1..1 |
Binding | The codes SHOULD be taken from For example codes, see ValueSet record-lifecycle-eventshttp://hl7.org/fhir/ValueSet/audit-event-sub-type |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | This field enables queries of messages by implementation-defined event categories. |
Alternate Names | subtype |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. 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 AuditEventActionhttp://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 | true |
Summary | true |
Requirements | This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
14. 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 | true |
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())) |
16. 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 PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse The authorized purposeOfUse for the activity. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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())) |
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 | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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())) |
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 | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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.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 | true |
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())) |
26. 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 | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. 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 | See Choice of Data Types for 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 | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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())) |
30. 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 PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse The reason the activity took place. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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())) |
32. 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())) |
34. 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()) |
36. 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())) |
38. 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 | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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())) |
40. 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()) |
42. 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 | true |
Summary | true |
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 found here
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 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 | 0..* |
Binding | For example codes, see AuditEventID Type of event. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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()) ) |
20. AuditEvent.code | |
Definition | Describes what happened. The most specific code for the event. |
Short | Specific type of event |
Control | 1..1 |
Binding | The codes SHOULD be taken from ValueSet record-lifecycle-events |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Requirements | This field enables queries of messages by implementation-defined event categories. |
Alternate Names | subtype |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
22. 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 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 | true |
Summary | true |
Requirements | This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
24. 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 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()) ) |
26. 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 | See Choice of Data Types for 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()) ) |
28. 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 | true |
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()) ) |
30. 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()) ) |
32. 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 |
34. 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() ) |
36. 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() ) |
38. 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 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. |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
40. 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 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()) ) |
42. 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 The authorized purposeOfUse for the activity. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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()) ) |
44. 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()) ) |
46. 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()) ) |
48. 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()) ) |
50. 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 | 1..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) ) |
52. 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 |
54. 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() ) |
56. 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() ) |
58. 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 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()) ) |
60. 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 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()) ) |
62. 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 | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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()) ) |
64. 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 | true |
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()) ) |
66. 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 | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
68. 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()) ) |
70. 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 | See Choice of Data Types for 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 | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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()) ) |
72. 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 The reason the activity took place. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
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()) ) |
74. 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()) ) |
76. 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 |
78. 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() ) |
80. 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() ) |
82. 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()) ) |
84. 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()) ) |
86. 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 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()) ) |
88. 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 | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
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()) ) |
90. 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 |
92. 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() ) |
94. 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() ) |
96. 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 | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
98. 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 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()) ) |
100. 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 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()) ) |
102. 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()) ) |
104. 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()) ) |
106. 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 |
108. 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() ) |
110. 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() ) |
112. 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 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()) ) |
114. 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 | See Choice of Data Types for 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()) ) |
116. 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 | See ttp://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()) ) |