DataStandardsWales-AuditEvent
Overview
The AuditEvent resource records events for the purpose of security log maintenance. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.The DataStandardsWales-AuditEvent profile is derived from the HL7 R4 AuditEvent. It defines additional rules for use within health and care organisations in Wales.A direct link to the Data Standards Wales asset can be accessed here - Data Standards Wales AuditEventFormal Views of Profile Content
- Snapshot View
- Differential View
- Hybrid View
- Examples
| DataStandardsWalesAuditEvent (AuditEvent) | C | AuditEvent | There are no (further) constraints on this element Element idAuditEventShort description Event record kept for security purposes DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Based on IHE-ATNA.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAuditEvent.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAuditEvent.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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 it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idAuditEvent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have 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.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idAuditEvent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| type | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.typeShort description Type/identifier of event DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Type of event.
| ||
| subtype | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.subtypeShort description More specific type/id for the event DefinitionIdentifier for the category of event. This field enables queries of messages by implementation-defined event categories. Sub-type of event. AuditEventSub-Type (extensible) Constraints
| ||
| action | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.actionShort description Type of action performed during the event DefinitionIndicator for type of action performed during the event that generated the audit. This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Indicator for type of action performed during the event that generated the event.
| ||
| period | 0..1 | Period | There are no (further) constraints on this element Element idAuditEvent.periodShort description When the activity occurred DefinitionThe period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
| |||
| recorded | Σ | 1..1 | instant | There are no (further) constraints on this element Element idAuditEvent.recordedShort description Time when the event was recorded DefinitionThe time when the event was recorded. 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. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
| ||
| outcome | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.outcomeShort description Whether the event succeeded or failed DefinitionIndicates whether the event succeeded or failed. 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. Indicates whether the event succeeded or failed.
| ||
| outcomeDesc | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.outcomeDescShort description Description of the event outcome DefinitionA free text description of the outcome of the event.
| ||
| purposeOfEvent | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.purposeOfEventShort description The purposeOfUse of the event DefinitionThe purposeOfUse (reason) that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| ||
| agent | 1..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agentShort description Actor involved in the event Alternate namesActiveParticipant DefinitionAn actor taking an active role in the event or activity that is logged. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.typeShort description How agent participated DefinitionSpecification of the participation type the user plays when performing the event. The Participation type of the agent to the event. ParticipationRoleType (extensible) Constraints
| |||
| role | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAuditEvent.agent.roleShort description Agent role in the event DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. 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. Should be roles relevant to the event. Should not be an exhaustive list of roles. What security role enabled the agent to participate in the event.
| |||
| who | Σ | 0..1 | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) | Element idAuditEvent.agent.whoShort description Identifier of who Alternate namesuserId DefinitionReference to who this agent is that was involved in the event. This field ties an audit event to a specific resource or identifier. Where a User ID is available it will go into who.identifier. Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) Constraints
| ||
| altId | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.altIdShort description Alternative User identity DefinitionAlternative agent 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. 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.
| |||
| name | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.nameShort description Human friendly name for the agent DefinitionHuman-meaningful name for the agent. The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.
| |||
| requestor | Σ | 1..1 | boolean | There are no (further) constraints on this element Element idAuditEvent.agent.requestorShort description Whether user is initiator DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited. 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. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
| ||
| location | 0..1 | Reference(DataStandardsWalesLocation) | Element idAuditEvent.agent.locationShort description Where DefinitionWhere the event occurred. Reference(DataStandardsWalesLocation) Constraints
| |||
| policy | 0..* | uri | There are no (further) constraints on this element Element idAuditEvent.agent.policyShort description Policy that authorized event DefinitionThe 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. This value is used retrospectively to determine the authorization policies. 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.
| |||
| media | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.agent.mediaShort description Type of media DefinitionType of media involved. Used when the event is about exporting/importing onto media. 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). Used when the event is about exporting/importing onto media.
| |||
| network | 0..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agent.networkShort description Logical network location for application activity DefinitionLogical network location for application activity, if the activity has a network location.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| address | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.addressShort description Identifier for the network access point of the user device DefinitionAn identifier for the network access point of the user device for the audit event. 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. This could be a device id, IP address or some other identifier associated with a device.
| |||
| type | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.agent.network.typeShort description The type of network access point DefinitionAn identifier for the type of network access point that originated the audit event. 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. The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) Constraints
| |||
| purposeOfUse | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.purposeOfUseShort description Reason given for this user DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| |||
| source | 1..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.sourceShort description Audit Event Reporter DefinitionThe system that is reporting the event. The event is reported by one source. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| site | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.siteShort description Logical source location within the enterprise DefinitionLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. This value differentiates among the sites in a multi-site enterprise health information system.
| |||
| observer | Σ | 1..1 | Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) | Element idAuditEvent.source.observerShort description The identity of source detecting the event Alternate namesSourceId DefinitionIdentifier of the source where the event was detected. 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. Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) Constraints
| ||
| type | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.source.typeShort description The type of source where event originated DefinitionCode specifying the type of source where event originated. 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. Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) Constraints
| |||
| entity | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entityShort description Data or objects used Alternate namesParticipantObject DefinitionSpecific instances of data or objects that have been accessed. The event may have other entities involved. 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.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| what | Σ | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idAuditEvent.entity.whatShort description Specific instance of resource DefinitionIdentifies a specific instance of the entity. The reference should be version specific.
| ||
| type | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.typeShort description Type of entity involved DefinitionThe type of the object that was involved in this audit event. 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. This value is distinct from the user's role or any user relationship to the entity. Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints
| |||
| role | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.roleShort description What role the entity played DefinitionCode representing the role the entity played in the event being audited. For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves. Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints
| |||
| lifecycle | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.lifecycleShort description Life-cycle stage for the entity DefinitionIdentifier for the data life-cycle stage for the entity. 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. This can be used to provide an audit trail for data, over time, as it passes through the system. Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints
| |||
| securityLabel | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.securityLabelShort description Security labels on the entity DefinitionSecurity labels for the identified entity. This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. Copied from entity meta security tags. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints
| |||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.nameShort description Descriptor for entity DefinitionA name of the entity in the audit event. Use only where entity can't be identified with an identifier. This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used. The cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| description | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.descriptionShort description Descriptive text DefinitionText that describes the entity in more detail. Use only where entity can't be identified with an identifier.
| |||
| query | Σ C | 0..1 | base64Binary | There are no (further) constraints on this element Element idAuditEvent.entity.queryShort description Query parameters DefinitionThe query parameters for a query-type entities. 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. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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 cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| detail | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entity.detailShort description Additional Information about the entity DefinitionTagged value pairs for conveying additional information about the entity. Implementation-defined data about specific details of the object accessed or used.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 1..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.typeShort description Name of the property DefinitionThe type of extra detail provided in the value.
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idAuditEvent.entity.detail.value[x]Short description Property value DefinitionThe value of the extra detail. Should not duplicate the entity value unless absolutely necessary. The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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.
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type |
| DataStandardsWalesAuditEvent (AuditEvent) | C | AuditEvent | There are no (further) constraints on this element Element idAuditEventShort description Event record kept for security purposes DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Based on IHE-ATNA.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAuditEvent.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAuditEvent.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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 it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idAuditEvent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have 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.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idAuditEvent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| type | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.typeShort description Type/identifier of event DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Type of event.
| ||
| subtype | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.subtypeShort description More specific type/id for the event DefinitionIdentifier for the category of event. This field enables queries of messages by implementation-defined event categories. Sub-type of event. AuditEventSub-Type (extensible) Constraints
| ||
| action | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.actionShort description Type of action performed during the event DefinitionIndicator for type of action performed during the event that generated the audit. This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Indicator for type of action performed during the event that generated the event.
| ||
| period | 0..1 | Period | There are no (further) constraints on this element Element idAuditEvent.periodShort description When the activity occurred DefinitionThe period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
| |||
| recorded | Σ | 1..1 | instant | There are no (further) constraints on this element Element idAuditEvent.recordedShort description Time when the event was recorded DefinitionThe time when the event was recorded. 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. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
| ||
| outcome | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.outcomeShort description Whether the event succeeded or failed DefinitionIndicates whether the event succeeded or failed. 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. Indicates whether the event succeeded or failed.
| ||
| outcomeDesc | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.outcomeDescShort description Description of the event outcome DefinitionA free text description of the outcome of the event.
| ||
| purposeOfEvent | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.purposeOfEventShort description The purposeOfUse of the event DefinitionThe purposeOfUse (reason) that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| ||
| agent | 1..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agentShort description Actor involved in the event Alternate namesActiveParticipant DefinitionAn actor taking an active role in the event or activity that is logged. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.typeShort description How agent participated DefinitionSpecification of the participation type the user plays when performing the event. The Participation type of the agent to the event. ParticipationRoleType (extensible) Constraints
| |||
| role | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAuditEvent.agent.roleShort description Agent role in the event DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. 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. Should be roles relevant to the event. Should not be an exhaustive list of roles. What security role enabled the agent to participate in the event.
| |||
| who | Σ | 0..1 | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) | Element idAuditEvent.agent.whoShort description Identifier of who Alternate namesuserId DefinitionReference to who this agent is that was involved in the event. This field ties an audit event to a specific resource or identifier. Where a User ID is available it will go into who.identifier. Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) Constraints
| ||
| altId | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.altIdShort description Alternative User identity DefinitionAlternative agent 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. 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.
| |||
| name | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.nameShort description Human friendly name for the agent DefinitionHuman-meaningful name for the agent. The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.
| |||
| requestor | Σ | 1..1 | boolean | There are no (further) constraints on this element Element idAuditEvent.agent.requestorShort description Whether user is initiator DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited. 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. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
| ||
| location | 0..1 | Reference(DataStandardsWalesLocation) | Element idAuditEvent.agent.locationShort description Where DefinitionWhere the event occurred. Reference(DataStandardsWalesLocation) Constraints
| |||
| policy | 0..* | uri | There are no (further) constraints on this element Element idAuditEvent.agent.policyShort description Policy that authorized event DefinitionThe 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. This value is used retrospectively to determine the authorization policies. 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.
| |||
| media | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.agent.mediaShort description Type of media DefinitionType of media involved. Used when the event is about exporting/importing onto media. 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). Used when the event is about exporting/importing onto media.
| |||
| network | 0..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agent.networkShort description Logical network location for application activity DefinitionLogical network location for application activity, if the activity has a network location.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| address | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.addressShort description Identifier for the network access point of the user device DefinitionAn identifier for the network access point of the user device for the audit event. 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. This could be a device id, IP address or some other identifier associated with a device.
| |||
| type | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.agent.network.typeShort description The type of network access point DefinitionAn identifier for the type of network access point that originated the audit event. 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. The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) Constraints
| |||
| purposeOfUse | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.purposeOfUseShort description Reason given for this user DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| |||
| source | 1..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.sourceShort description Audit Event Reporter DefinitionThe system that is reporting the event. The event is reported by one source. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| site | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.siteShort description Logical source location within the enterprise DefinitionLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. This value differentiates among the sites in a multi-site enterprise health information system.
| |||
| observer | Σ | 1..1 | Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) | Element idAuditEvent.source.observerShort description The identity of source detecting the event Alternate namesSourceId DefinitionIdentifier of the source where the event was detected. 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. Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) Constraints
| ||
| type | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.source.typeShort description The type of source where event originated DefinitionCode specifying the type of source where event originated. 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. Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) Constraints
| |||
| entity | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entityShort description Data or objects used Alternate namesParticipantObject DefinitionSpecific instances of data or objects that have been accessed. The event may have other entities involved. 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.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| what | Σ | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idAuditEvent.entity.whatShort description Specific instance of resource DefinitionIdentifies a specific instance of the entity. The reference should be version specific.
| ||
| type | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.typeShort description Type of entity involved DefinitionThe type of the object that was involved in this audit event. 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. This value is distinct from the user's role or any user relationship to the entity. Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints
| |||
| role | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.roleShort description What role the entity played DefinitionCode representing the role the entity played in the event being audited. For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves. Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints
| |||
| lifecycle | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.lifecycleShort description Life-cycle stage for the entity DefinitionIdentifier for the data life-cycle stage for the entity. 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. This can be used to provide an audit trail for data, over time, as it passes through the system. Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints
| |||
| securityLabel | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.securityLabelShort description Security labels on the entity DefinitionSecurity labels for the identified entity. This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. Copied from entity meta security tags. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints
| |||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.nameShort description Descriptor for entity DefinitionA name of the entity in the audit event. Use only where entity can't be identified with an identifier. This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used. The cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| description | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.descriptionShort description Descriptive text DefinitionText that describes the entity in more detail. Use only where entity can't be identified with an identifier.
| |||
| query | Σ C | 0..1 | base64Binary | There are no (further) constraints on this element Element idAuditEvent.entity.queryShort description Query parameters DefinitionThe query parameters for a query-type entities. 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. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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 cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| detail | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entity.detailShort description Additional Information about the entity DefinitionTagged value pairs for conveying additional information about the entity. Implementation-defined data about specific details of the object accessed or used.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 1..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.typeShort description Name of the property DefinitionThe type of extra detail provided in the value.
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idAuditEvent.entity.detail.value[x]Short description Property value DefinitionThe value of the extra detail. Should not duplicate the entity value unless absolutely necessary. The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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.
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type |
| DataStandardsWalesAuditEvent (AuditEvent) | C | AuditEvent | There are no (further) constraints on this element Element idAuditEventShort description Event record kept for security purposes DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Based on IHE-ATNA.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idAuditEvent.metaShort description Metadata about the resource DefinitionThe 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.
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAuditEvent.implicitRulesShort description A set of rules under which this content was created DefinitionA 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. 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 it's narrative along with other profiles, value sets, etc.
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idAuditEvent.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have 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.
| |||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idAuditEvent.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. 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.
| ||
| type | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.typeShort description Type/identifier of event DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Type of event.
| ||
| subtype | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.subtypeShort description More specific type/id for the event DefinitionIdentifier for the category of event. This field enables queries of messages by implementation-defined event categories. Sub-type of event. AuditEventSub-Type (extensible) Constraints
| ||
| action | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.actionShort description Type of action performed during the event DefinitionIndicator for type of action performed during the event that generated the audit. This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Indicator for type of action performed during the event that generated the event.
| ||
| period | 0..1 | Period | There are no (further) constraints on this element Element idAuditEvent.periodShort description When the activity occurred DefinitionThe period during which the activity occurred. The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.
| |||
| recorded | Σ | 1..1 | instant | There are no (further) constraints on this element Element idAuditEvent.recordedShort description Time when the event was recorded DefinitionThe time when the event was recorded. 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. In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
| ||
| outcome | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.outcomeShort description Whether the event succeeded or failed DefinitionIndicates whether the event succeeded or failed. 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. Indicates whether the event succeeded or failed.
| ||
| outcomeDesc | Σ | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.outcomeDescShort description Description of the event outcome DefinitionA free text description of the outcome of the event.
| ||
| purposeOfEvent | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.purposeOfEventShort description The purposeOfUse of the event DefinitionThe purposeOfUse (reason) that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| ||
| agent | 1..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agentShort description Actor involved in the event Alternate namesActiveParticipant DefinitionAn actor taking an active role in the event or activity that is logged. An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.typeShort description How agent participated DefinitionSpecification of the participation type the user plays when performing the event. The Participation type of the agent to the event. ParticipationRoleType (extensible) Constraints
| |||
| role | 0..* | CodeableConcept | There are no (further) constraints on this element Element idAuditEvent.agent.roleShort description Agent role in the event DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. 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. Should be roles relevant to the event. Should not be an exhaustive list of roles. What security role enabled the agent to participate in the event.
| |||
| who | Σ | 0..1 | Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) | Element idAuditEvent.agent.whoShort description Identifier of who Alternate namesuserId DefinitionReference to who this agent is that was involved in the event. This field ties an audit event to a specific resource or identifier. Where a User ID is available it will go into who.identifier. Reference(DataStandardsWalesPractitioner | DataStandardsWalesPatient | DataStandardsWalesOrganization | DataStandardsWalesPractitionerRole | DataStandardsWalesDevice | DataStandardsWalesRelatedPerson) Constraints
| ||
| altId | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.altIdShort description Alternative User identity DefinitionAlternative agent 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. 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.
| |||
| name | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.nameShort description Human friendly name for the agent DefinitionHuman-meaningful name for the agent. The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.
| |||
| requestor | Σ | 1..1 | boolean | There are no (further) constraints on this element Element idAuditEvent.agent.requestorShort description Whether user is initiator DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited. 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. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
| ||
| location | 0..1 | Reference(DataStandardsWalesLocation) | Element idAuditEvent.agent.locationShort description Where DefinitionWhere the event occurred. Reference(DataStandardsWalesLocation) Constraints
| |||
| policy | 0..* | uri | There are no (further) constraints on this element Element idAuditEvent.agent.policyShort description Policy that authorized event DefinitionThe 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. This value is used retrospectively to determine the authorization policies. 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.
| |||
| media | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.agent.mediaShort description Type of media DefinitionType of media involved. Used when the event is about exporting/importing onto media. 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). Used when the event is about exporting/importing onto media.
| |||
| network | 0..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.agent.networkShort description Logical network location for application activity DefinitionLogical network location for application activity, if the activity has a network location.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.agent.network.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| address | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.agent.network.addressShort description Identifier for the network access point of the user device DefinitionAn identifier for the network access point of the user device for the audit event. 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. This could be a device id, IP address or some other identifier associated with a device.
| |||
| type | 0..1 | codeBinding | There are no (further) constraints on this element Element idAuditEvent.agent.network.typeShort description The type of network access point DefinitionAn identifier for the type of network access point that originated the audit event. 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. The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) Constraints
| |||
| purposeOfUse | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idAuditEvent.agent.purposeOfUseShort description Reason given for this user DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded. Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. 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. The reason the activity took place.
| |||
| source | 1..1 | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.sourceShort description Audit Event Reporter DefinitionThe system that is reporting the event. The event is reported by one source. 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.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.source.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| site | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.source.siteShort description Logical source location within the enterprise DefinitionLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. This value differentiates among the sites in a multi-site enterprise health information system.
| |||
| observer | Σ | 1..1 | Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) | Element idAuditEvent.source.observerShort description The identity of source detecting the event Alternate namesSourceId DefinitionIdentifier of the source where the event was detected. 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. Reference(DataStandardsWalesPractitionerRole | DataStandardsWalesPractitioner | DataStandardsWalesOrganization | DataStandardsWalesPatient | DataStandardsWalesRelatedPerson | DataStandardsWalesDevice) Constraints
| ||
| type | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.source.typeShort description The type of source where event originated DefinitionCode specifying the type of source where event originated. 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. Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) Constraints
| |||
| entity | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entityShort description Data or objects used Alternate namesParticipantObject DefinitionSpecific instances of data or objects that have been accessed. The event may have other entities involved. 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.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| what | Σ | 0..1 | Reference(Resource) | There are no (further) constraints on this element Element idAuditEvent.entity.whatShort description Specific instance of resource DefinitionIdentifies a specific instance of the entity. The reference should be version specific.
| ||
| type | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.typeShort description Type of entity involved DefinitionThe type of the object that was involved in this audit event. 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. This value is distinct from the user's role or any user relationship to the entity. Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints
| |||
| role | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.roleShort description What role the entity played DefinitionCode representing the role the entity played in the event being audited. For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves. Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints
| |||
| lifecycle | 0..1 | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.lifecycleShort description Life-cycle stage for the entity DefinitionIdentifier for the data life-cycle stage for the entity. 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. This can be used to provide an audit trail for data, over time, as it passes through the system. Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints
| |||
| securityLabel | 0..* | CodingBinding | There are no (further) constraints on this element Element idAuditEvent.entity.securityLabelShort description Security labels on the entity DefinitionSecurity labels for the identified entity. This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. Copied from entity meta security tags. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints
| |||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.nameShort description Descriptor for entity DefinitionA name of the entity in the audit event. Use only where entity can't be identified with an identifier. This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used. The cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| description | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.descriptionShort description Descriptive text DefinitionText that describes the entity in more detail. Use only where entity can't be identified with an identifier.
| |||
| query | Σ C | 0..1 | base64Binary | There are no (further) constraints on this element Element idAuditEvent.entity.queryShort description Query parameters DefinitionThe query parameters for a query-type entities. 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. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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 cardinality or value of this element may be affected by these constraints: sev-1 Constraints
| ||
| detail | 0..* | BackboneElement | There are no (further) constraints on this element Element idAuditEvent.entity.detailShort description Additional Information about the entity DefinitionTagged value pairs for conveying additional information about the entity. Implementation-defined data about specific details of the object accessed or used.
| |||
| id | 0..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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 manageable, 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. 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.
| ||
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idAuditEvent.entity.detail.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 manageable, 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). 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. 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.
| ||
| type | 1..1 | string | There are no (further) constraints on this element Element idAuditEvent.entity.detail.typeShort description Name of the property DefinitionThe type of extra detail provided in the value.
| |||
| value[x] | 1..1 | There are no (further) constraints on this element Element idAuditEvent.entity.detail.value[x]Short description Property value DefinitionThe value of the extra detail. Should not duplicate the entity value unless absolutely necessary. The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, 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.
| ||||
| valueString | string | There are no (further) constraints on this element Data type | ||||
| valueBase64Binary | base64Binary | There are no (further) constraints on this element Data type |