This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Formal definitions for the elements in the SecurityEvent resource.
| SecurityEvent | |
| 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 | 1..1 |
| Comments | Based on ATNA (RFC 3881). |
| SecurityEvent.event | |
| Definition | Identifies the name, action type, time, and disposition of the audited event. |
| Control | 1..1 |
| Requirements | The event must be identified. |
| SecurityEvent.event.type | |
| Definition | Identifier for a family of the event. |
| Control | 1..1 |
| Binding | SecurityEventType: (See http://hl7.org/fhir/vs/security-event-type) |
| Type | CodeableConcept |
| 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. |
| SecurityEvent.event.subtype | |
| Definition | Identifier for the category of event. |
| Control | 0..* |
| Binding | SecurityEventSubType: (See http://hl7.org/fhir/vs/security-event-sub-type) |
| Type | CodeableConcept |
| Requirements | This field enables queries of messages by implementation-defined event categories. |
| SecurityEvent.event.action | |
| Definition | Indicator for type of action performed during the event that generated the audit. |
| Control | 0..1 |
| Binding | SecurityEventAction: Indicator for type of action performed during the event that generated the audit. (see http://hl7.org/fhir/security-event-action for values) |
| Type | code |
| Requirements | This broadly indicates what kind of action was done on the Participant Object. |
| SecurityEvent.event.dateTime | |
| Definition | The time when the event occurred on the source. |
| Control | 1..1 |
| Type | instant |
| 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. |
| SecurityEvent.event.outcome | |
| Definition | Indicates whether the event succeeded or failed. |
| Control | 0..1 |
| Binding | SecurityEventOutcome: Indicates whether the event succeeded or failed (see http://hl7.org/fhir/security-event-outcome for values) |
| 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. |
| SecurityEvent.event.outcomeDesc | |
| Definition | A free text description of the outcome of the event. |
| Control | 0..1 |
| Type | string |
| SecurityEvent.participant | |
| Definition | A person, a hardware device or software process. |
| Control | 1..* |
| 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. |
| Invariants | Defined on this element Inv-3: Either a userId or a reference, but not both (xpath: exists(f:userId) != exists(f:reference)) |
| SecurityEvent.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 | DICOMRoleId: (See http://hl7.org/fhir/vs/dicm-402-roleid) |
| Type | CodeableConcept |
| 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. |
| SecurityEvent.participant.reference | |
| Definition | Direct reference to a resource that identifies the participant. |
| Control | 0..1 |
| Type | Resource(Practitioner | Patient | Device) |
| Requirements | This field ties an audit event to a specific resource. |
| Invariants | Affect this element Inv-3: Either a userId or a reference, but not both (xpath: exists(f:userId) != exists(f:reference)) |
| SecurityEvent.participant.userId | |
| Definition | Unique identifier for the user actively participating in the event. |
| Control | 0..1 |
| Type | string |
| 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. |
| Invariants | Affect this element Inv-3: Either a userId or a reference, but not both (xpath: exists(f:userId) != exists(f:reference)) |
| SecurityEvent.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. |
| SecurityEvent.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. |
| SecurityEvent.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 |
| 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. |
| SecurityEvent.participant.media | |
| Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
| Control | 0..1 |
| 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). |
| To Do | Do we need an element for Media Id (as opposed to type). |
| SecurityEvent.participant.network | |
| Definition | Logical network location for application activity, if the activity has a network location. |
| Control | 0..1 |
| SecurityEvent.participant.network.identifier | |
| 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. |
| SecurityEvent.participant.network.type | |
| Definition | An identifier for the type of network access point that originated the audit event. |
| Control | 0..1 |
| Binding | SecurityEventParticipantNetworkType: The type of network access point that originated the audit event (see http://hl7.org/fhir/network-type for values) |
| Type | code |
| 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. |
| SecurityEvent.source | |
| Definition | Application systems and processes. |
| Control | 1..1 |
| 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. |
| SecurityEvent.source.site | |
| Definition | Logical source location within the healthcare enterprise network. |
| Control | 0..1 |
| Type | string |
| 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. |
| SecurityEvent.source.identifier | |
| Definition | Identifier of the source where the event originated. |
| Control | 1..1 |
| Type | string |
| 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 occurred. |
| SecurityEvent.source.type | |
| Definition | Code specifying the type of source where event originated. |
| Control | 0..* |
| Binding | SecurityEventSourceType: (See http://hl7.org/fhir/vs/security-source-type) |
| Type | Coding |
| 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. |
| SecurityEvent.object | |
| Definition | Specific instances of data or objects that have been accessed. |
| Control | 0..* |
| 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 Inv-1: Either a name or a query (or both) (xpath: not(exists(f:name)) or not(exists(f:query))) Inv-2: Either an identifier or a reference, but not both (xpath: exists(f:identifier) != exists(f:reference)) |
| SecurityEvent.object.identifier | |
| Definition | Identifies a specific instance of the participant object. The reference should always be version specific. |
| Control | 0..1 |
| Type | Identifier |
| Comments | Identifier details depends on object type. |
| Invariants | Affect this element Inv-2: Either an identifier or a reference, but not both (xpath: exists(f:identifier) != exists(f:reference)) |
| SecurityEvent.object.reference | |
| Definition | Identifies a specific instance of the participant object. The reference should always be version specific. |
| Control | 0..1 |
| Type | Resource(Any) |
| Invariants | Affect this element Inv-2: Either an identifier or a reference, but not both (xpath: exists(f:identifier) != exists(f:reference)) |
| SecurityEvent.object.type | |
| Definition | Object type being audited. |
| Control | 0..1 |
| Binding | SecurityEventObjectType: Code for the participant object type being audited (see http://hl7.org/fhir/object-type for values) |
| Type | code |
| 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. |
| SecurityEvent.object.role | |
| Definition | Code representing the functional application role of Participant Object being audited. |
| Control | 0..1 |
| Binding | SecurityEventObjectRole: Code representing the functional application role of Participant Object being audited (see http://hl7.org/fhir/object-role for values) |
| Type | code |
| 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. |
| SecurityEvent.object.lifecycle | |
| Definition | Identifier for the data life-cycle stage for the participant object. |
| Control | 0..1 |
| Binding | SecurityEventObjectLifecycle: Identifier for the data life-cycle stage for the participant object (see http://hl7.org/fhir/object-lifecycle for values) |
| Type | code |
| 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. |
| SecurityEvent.object.sensitivity | |
| Definition | Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics. |
| Control | 0..1 |
| Binding | SecurityEventObjectSensitivity: (See http://hl7.org/fhir/vs/security-event-sensitivity) |
| Type | CodeableConcept |
| Requirements | This field identifies a specific instance of an object, such as a patient, to detect/track privacy and security issues. |
| Comments | Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here. |
| SecurityEvent.object.name | |
| Definition | An instance-specific descriptor of the Participant Object ID audited, such as a person's name. |
| Control | 0..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. |
| Invariants | Affect this element Inv-1: Either a name or a query (or both) (xpath: not(exists(f:name)) or not(exists(f:query))) |
| SecurityEvent.object.description | |
| Definition | Text that describes the object in more detail. |
| Control | 0..1 |
| Type | string |
| SecurityEvent.object.query | |
| Definition | The actual query for a query-type participant object. |
| Control | 0..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. |
| Invariants | Affect this element Inv-1: Either a name or a query (or both) (xpath: not(exists(f:name)) or not(exists(f:query))) |
| SecurityEvent.object.detail | |
| Definition | Additional Information about the Object. |
| Control | 0..* |
| SecurityEvent.object.detail.type | |
| Definition | Name of the property. |
| Control | 1..1 |
| Type | string |
| SecurityEvent.object.detail.value | |
| Definition | Property value. |
| Control | 1..1 |
| Type | base64Binary |
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:10+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change