This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2
Definitions for the ehrsrle-auditevent Profile.
AuditEvent(EHRSRLE-AuditEvent) | |
Definition | A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. |
Control | 0..* |
Type | AuditEvent |
Comments | Based on ATNA (RFC 3881). |
AuditEvent.id | |
Definition | The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
AuditEvent.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
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 as much as possible. |
AuditEvent.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
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). |
AuditEvent.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
AuditEvent.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained 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. |
AuditEvent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
AuditEvent.event | |
Definition | Identifies the name, action type, time, and disposition of the audited event. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Requirements | The event must be identified. |
AuditEvent.event.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.event.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
AuditEvent.event.extension (http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent-location) | |
Definition | The phyiscal location of the event (e.g. Building, room, etc.). |
Control | 0..1 |
Type | Extension (Extension Type: Reference(Location)) |
AuditEvent.event.extension (http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent-reason) | |
Definition | The reason that the activity was taking place. |
Control | 0..1 |
Type | Extension (Extension Type: CodeableConcept) |
AuditEvent.event.extension (http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent-policy) | |
Definition | Policy or plan the event was defined by. Typically, a single event may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. |
Control | 0..1 |
Type | Extension (Extension Type: uri) |
AuditEvent.event.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.event.type | |
Definition | Identifier for a family of the event. |
Control | 1..1 |
Binding | Type of event The codes SHALL be taken from Audit Event ID; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. |
Comments | e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
AuditEvent.event.subtype | |
Definition | Identifier for the category of event. |
Control | 0..* |
Binding | Sub-type of event The codes SHALL be taken from Audit Event Sub-Type; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | This field enables queries of messages by implementation-defined event categories. |
AuditEvent.event.action | |
Definition | Indicator for type of action performed during the event that generated the audit. |
Control | 0..1 |
Binding | Indicator for type of action performed during the event that generated the audit. The codes SHALL be taken from AuditEventAction |
Type | code |
Must Support | true |
Requirements | This broadly indicates what kind of action was done on the Participant Object. |
AuditEvent.event.dateTime | |
Definition | The time when the event occurred on the source. |
Control | 1..1 |
Type | instant |
Must Support | 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. |
Comments | In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic. |
AuditEvent.event.outcome | |
Definition | Indicates whether the event succeeded or failed. |
Control | 0..1 |
Binding | Indicates whether the event succeeded or failed The codes SHALL be taken from AuditEventOutcome |
Type | code |
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. |
AuditEvent.event.outcomeDesc | |
Definition | A free text description of the outcome of the event. |
Control | 0..1 |
Type | string |
AuditEvent.event.purposeOfEvent | |
Definition | The purposeOfUse (reason) that was used during the event being recorded. |
Control | 0..* |
Binding | The reason the activity took place The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable |
Type | Coding |
Comments | Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why). |
AuditEvent.participant | |
Definition | A person, a hardware device or software process. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Requirements | The event has one or more active participants. |
Comments | There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event. |
AuditEvent.participant.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.participant.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
AuditEvent.participant.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.participant.role | |
Definition | Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context. |
Control | 0..* |
Binding | Role(s) the user plays (from RBAC) The codes SHALL be taken from Audit Active Participant Role ID Code; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
Requirements | This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories. |
AuditEvent.participant.reference | |
Definition | Direct reference to a resource that identifies the participant. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner), Reference(Organization), Reference(Device), Reference(Patient), Reference(RelatedPerson) |
Must Support | true |
Requirements | This field ties an audit event to a specific resource. |
AuditEvent.participant.userId | |
Definition | Unique identifier for the user actively participating in the event. |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Requirements | This field ties an audit event to a specific user. |
Comments | a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name. |
AuditEvent.participant.altId | |
Definition | Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available. |
Control | 0..1 |
Type | string |
Requirements | In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application. |
AuditEvent.participant.name | |
Definition | Human-meaningful name for the user. |
Control | 0..1 |
Type | string |
Requirements | The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user. |
AuditEvent.participant.requestor | |
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
Control | 1..1 |
Type | boolean |
Must Support | 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. |
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator. |
AuditEvent.participant.location | |
Definition | Where the event occurred. |
Control | 0..1 |
Type | Reference(Location) |
AuditEvent.participant.policy | |
Definition | The policy or plan that authorized the activity being recorded. 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. |
Control | 0..* |
Type | uri |
Requirements | This value is used retrospectively to determine the authorization policies. |
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. |
AuditEvent.participant.media | |
Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
Control | 0..1 |
Binding | Used when the event is about exporting/importing onto media The codes SHALL be taken from Media Type Code; other codes may be used where these codes are not suitable |
Type | Coding |
Requirements | Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD). |
AuditEvent.participant.network | |
Definition | Logical network location for application activity, if the activity has a network location. |
Control | 0..1 |
Type | BackboneElement |
Must Support | true |
AuditEvent.participant.network.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.participant.network.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
AuditEvent.participant.network.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.participant.network.address | |
Definition | An identifier for the network access point of the user device for the audit event. |
Control | 0..1 |
Type | string |
Requirements | This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers. |
Comments | This could be a device id, IP address or some other identifier associated with a device. |
AuditEvent.participant.network.type | |
Definition | An identifier for the type of network access point that originated the audit event. |
Control | 0..1 |
Binding | The type of network access point of this participant in the audit event The codes SHALL be taken from AuditEventParticipantNetworkType |
Type | code |
Must Support | true |
Requirements | This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type. |
AuditEvent.participant.purposeOfUse | |
Definition | The reason (purpose of use), specific to this participant, that was used during the event being recorded. |
Control | 0..* |
Binding | The reason the activity took place The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable |
Type | Coding |
Comments | Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why). |
AuditEvent.source | |
Definition | Application systems and processes. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
Requirements | The event is reported by one source. |
Comments | Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants, e.g., low-level network transports, need not be identified. |
AuditEvent.source.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.source.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.source.site | |
Definition | Logical source location within the healthcare enterprise network. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | This value differentiates among the sites in a multi-site enterprise health information system. |
Comments | a hospital or other provider location within a multi-entity provider group. |
AuditEvent.source.identifier | |
Definition | Identifier of the source where the event was detected. |
Control | 1..1 |
Type | Identifier |
Must Support | 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. |
AuditEvent.source.type | |
Definition | Code specifying the type of source where event originated. |
Control | 1..1 |
Binding | Code specifying the type of system that detected and recorded the event The codes SHALL be taken from Audit Event Source Type; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
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. |
AuditEvent.object | |
Definition | Specific instances of data or objects that have been accessed. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Requirements | The event may have other objects involved. |
Comments | required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values. |
Invariants | Defined on this element sev-1: Either a name or a query (NOT both) (xpath: not(exists(f:name)) or not(exists(f:query))) |
AuditEvent.object.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.object.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
AuditEvent.object.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.object.identifier | |
Definition | Identifies a specific instance of the participant object. The reference should always be version specific. |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Comments | Identifier details depends on object type. |
AuditEvent.object.reference | |
Definition | Identifies a specific instance of the participant object. The reference should always be version specific. |
Control | 0..1 |
Type | Reference(Resource) |
Must Support | true |
AuditEvent.object.type | |
Definition | The type of the object that was involved in this audit event. |
Control | 0..1 |
Binding | Code for the object type involved audited The codes SHALL be taken from AuditEventObjectType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. |
Comments | This value is distinct from the user's role or any user relationship to the participant object. |
AuditEvent.object.role | |
Definition | Code representing the functional application role of Participant Object being audited. |
Control | 0..1 |
Binding | Code representing the role the Object played in the event The codes SHALL be taken from AuditEventObjectRole; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | For some detailed audit analysis it may be necessary to indicate a more granular type of participant, based on the application role it serves. |
Comments | See RFC 3881 for rules concerning matches between role and type. |
AuditEvent.object.lifecycle | |
Definition | Identifier for the data life-cycle stage for the participant object. |
Control | 0..1 |
Binding | Identifier for the data life-cycle stage for the object The codes SHALL be taken from AuditEventObjectLifecycle; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. |
Comments | This can be used to provide an audit trail for data, over time, as it passes through the system. |
AuditEvent.object.securityLabel | |
Definition | Denotes security labels for the identified object. |
Control | 0..* |
Binding | Security Labels from the Healthcare Privacy and Security Classification System The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable |
Type | Coding |
Requirements | This field identifies the security lables for a specific instance of an object, such as a patient, to detect/track privacy and security issues. |
AuditEvent.object.name | |
Definition | An instance-specific descriptor of the Participant Object ID audited, such as a person's name. |
Control | 0..1 This element is affected by the following invariants: sev-1 |
Type | string |
Comments | This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used. |
AuditEvent.object.description | |
Definition | Text that describes the object in more detail. |
Control | 0..1 |
Type | string |
AuditEvent.object.query | |
Definition | The actual query for a query-type participant object. |
Control | 0..1 This element is affected by the following invariants: sev-1 |
Type | base64Binary |
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. |
AuditEvent.object.detail | |
Definition | Additional Information about the Object. |
Control | 0..* |
Type | BackboneElement |
AuditEvent.object.detail.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
AuditEvent.object.detail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
AuditEvent.object.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
AuditEvent.object.detail.type | |
Definition | Name of the property. |
Control | 1..1 |
Type | string |
AuditEvent.object.detail.value | |
Definition | Property value. |
Control | 1..1 |
Type | base64Binary |