DSTU2 Ballot Source
This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for auditevent
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="AuditEvent"/> <meta> <lastUpdated value="2015-04-03T14:24:32.000+11:00"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <url value="http://hl7.org/fhir/StructureDefinition/AuditEvent"/> <name value="AuditEvent"/> <publisher value="HL7 FHIR Project (Security)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/secure/index.cfm"/> </telecom> </contact> <description value="Base StructureDefinition for AuditEvent Resource"/> <status value="draft"/> <date value="2015-04-03T14:24:32+11:00"/> <mapping> <identity value="dicom"/> <uri value="http://nema.org/dicom"/> <name value="DICOM"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <type value="resource"/> <abstract value="true"/> <snapshot> <element> <path value="AuditEvent"/> <short value="Event record kept for security purposes"/> <definition value="A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage."/> <comments value="Based on ATNA (RFC 3881)."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <mapping> <identity value="dicom"/> <map value="Message"/> </mapping> <mapping> <identity value="rim"/> <map value="ControlAct[moodCode=EVN]"/> </mapping> </element> <element> <path value="AuditEvent.id"/> <short value="Logical id of this artefact"/> <definition value="The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> </element> <element> <path value="AuditEvent.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <type> <code value="Meta"/> </type> </element> <element> <path value="AuditEvent.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible."/> <min value="0"/> <max value="1"/> <type> <code value="uri"/> </type> <isModifier value="true"/> </element> <element> <path value="AuditEvent.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="Language"/> <strength value="required"/> <description value="A human language"/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="AuditEvent.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety."/> <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="AuditEvent.contained"/> <short value="Contained, inline Resources"/> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope."/> <comments value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.event"/> <short value="What was done"/> <definition value="Identifies the name, action type, time, and disposition of the audited event."/> <requirements value="The event must be identified."/> <min value="1"/> <max value="1"/> <mapping> <identity value="dicom"/> <map value="EventIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A (no nesting in v3)"/> </mapping> </element> <element> <path value="AuditEvent.event.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.event.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.event.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.event.type"/> <short value="Type/identifier of event"/> <definition value="Identifier for a family of the event."/> <comments value="e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function."/> <requirements value="This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventType"/> <strength value="required"/> <description value="Type of event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventId"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.subtype"/> <short value="More specific type/id for the event"/> <definition value="Identifier for the category of event."/> <requirements value="This field enables queries of messages by implementation-defined event categories."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventSubType"/> <strength value="required"/> <description value="Sub-type of event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-sub-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.action"/> <short value="Type of action performed during the event"/> <definition value="Indicator for type of action performed during the event that generated the audit."/> <requirements value="This broadly indicates what kind of action was done on the Participant Object."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventAction"/> <strength value="required"/> <description value="Indicator for type of action performed during the event that generated the audit."/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-action"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventActionCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.dateTime"/> <short value="Time when the event occurred on source"/> <definition value="The time when the event occurred on the source."/> <comments value="In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic."/> <requirements value="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."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <mapping> <identity value="dicom"/> <map value="@EventDateTime"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </element> <element> <path value="AuditEvent.event.outcome"/> <short value="Whether the event succeeded or failed"/> <definition value="Indicates whether the event succeeded or failed."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventOutcome"/> <strength value="required"/> <description value="Indicates whether the event succeeded or failed"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-outcome"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventOutcomeIndicator"/> </mapping> <mapping> <identity value="rim"/> <map value=".actionNegationInd"/> </mapping> </element> <element> <path value="AuditEvent.event.outcomeDesc"/> <short value="Description of the event outcome"/> <definition value="A free text description of the outcome of the event."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@EventOutcomeDescription"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target.text"/> </mapping> </element> <element> <path value="AuditEvent.event.purposeOfEvent"/> <short value="The purposeOfUse of the event"/> <definition value="The purposeOfUse (reason) that was used during the event being recorded."/> <comments value="Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why)."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> </element> <element> <path value="AuditEvent.participant"/> <short value="A person, a hardware device or software process"/> <definition value="A person, a hardware device or software process."/> <comments value="There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event."/> <requirements value="The event has one or more active participants."/> <min value="1"/> <max value="*"/> <constraint> <key value="sev-3"/> <name value="Participant Identification"/> <severity value="error"/> <human value="Either a userId or a reference, but not both"/> <xpath value="exists(f:userId) != exists(f:reference)"/> </constraint> <mapping> <identity value="dicom"/> <map value="ActiveParticipant"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation"/> </mapping> </element> <element> <path value="AuditEvent.participant.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.participant.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.participant.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.participant.role"/> <short value="User roles (e.g. local RBAC codes)"/> <definition value="Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="DICOMRoleId"/> <strength value="required"/> <description value="Role(s) the user plays (from RBAC)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/dicm-402-roleid"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="RoleIdCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".typeCode and/or .functionCode"/> </mapping> </element> <element> <path value="AuditEvent.participant.reference"/> <short value="Direct reference to resource"/> <definition value="Direct reference to a resource that identifies the participant."/> <requirements value="This field ties an audit event to a specific resource."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <condition value="sev-3"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> </element> <element> <path value="AuditEvent.participant.userId"/> <short value="Unique identifier for the user"/> <definition value="Unique identifier for the user actively participating in the event."/> <comments value="a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name."/> <requirements value="This field ties an audit event to a specific user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sev-3"/> <mapping> <identity value="dicom"/> <map value="@UserId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="AuditEvent.participant.altId"/> <short value="Alternative User id e.g. authentication"/> <definition value="Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AlternativeUserId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id (distinguish id type by root)"/> </mapping> </element> <element> <path value="AuditEvent.participant.name"/> <short value="Human-meaningful name for the user"/> <definition value="Human-meaningful name for the user."/> <requirements value="The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@UserName"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> </element> <element> <path value="AuditEvent.participant.requestor"/> <short value="Whether user is initiator"/> <definition value="Indicator that the user is or is not the requestor, or initiator, for the event being audited."/> <comments value="There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator."/> <requirements value="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."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <mapping> <identity value="dicom"/> <map value="@UserIsRequestor"/> </mapping> <mapping> <identity value="rim"/> <map value="If participation.typeCode was author, then true"/> </mapping> </element> <element> <path value="AuditEvent.participant.location"/> <short value="Where"/> <definition value="Where the event occurred."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> </element> <element> <path value="AuditEvent.participant.policy"/> <short value="Policy that authorized event"/> <definition value="The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used."/> <comments value="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."/> <requirements value="This value is used retrospectively to determine the authorization policies."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> </element> <element> <path value="AuditEvent.participant.media"/> <short value="Type of media"/> <definition value="Type of media involved. Used when the event is about exporting/importing onto media."/> <requirements value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> <mapping> <identity value="dicom"/> <map value="MediaType"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.description.mediaType"/> </mapping> </element> <element> <path value="AuditEvent.participant.network"/> <short value="Logical network location for application activity"/> <definition value="Logical network location for application activity, if the activity has a network location."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player.description.reference"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.identifier"/> <short value="Identifier for the network access point of the user device"/> <definition value="An identifier for the network access point of the user device for the audit event."/> <comments value="This could be a device id, IP address or some other identifier associated with a device."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointID"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.type"/> <short value="The type of network access point"/> <definition value="An identifier for the type of network access point that originated the audit event."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventParticipantNetworkType"/> <strength value="required"/> <description value="The type of network access point of this participant in the audit event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/network-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> </element> <element> <path value="AuditEvent.participant.purposeOfUse"/> <short value="Participant purposeOfUse"/> <definition value="The purposeOfUse (reason) specific to this participant that was used during the event being recorded."/> <comments value="Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why)."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> </element> <element> <path value="AuditEvent.source"/> <short value="Application systems and processes"/> <definition value="Application systems and processes."/> <comments value="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."/> <requirements value="The event is reported by one source."/> <min value="1"/> <max value="1"/> <mapping> <identity value="dicom"/> <map value="AuditSourceIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"/> </mapping> </element> <element> <path value="AuditEvent.source.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.source.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.source.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.source.site"/> <short value="Logical source location within the enterprise"/> <definition value="Logical source location within the healthcare enterprise network."/> <comments value="a hospital or other provider location within a multi-entity provider group."/> <requirements value="This value differentiates among the sites in a multi-site enterprise health information system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AuditEnterpriseSiteId"/> </mapping> <mapping> <identity value="rim"/> <map value=".scopedRole[classCode=LOCE].player.desc"/> </mapping> </element> <element> <path value="AuditEvent.source.identifier"/> <short value="The id of source where event originated"/> <definition value="Identifier of the source where the event originated."/> <requirements value="This field ties the event to a specific source system. It may be used to group events for analysis according to where the event occurred."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AuditSourceId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="AuditEvent.source.type"/> <short value="The type of source where event originated"/> <definition value="Code specifying the type of source where event originated."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <binding> <name value="AuditEventSourceType"/> <strength value="required"/> <description value="Code specifying the type of system that detected and recorded the event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-source-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="AuditSourceTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="AuditEvent.object"/> <short value="Specific instances of data or objects that have been accessed"/> <definition value="Specific instances of data or objects that have been accessed."/> <comments value="required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values."/> <requirements value="The event may have other objects involved."/> <min value="0"/> <max value="*"/> <constraint> <key value="sev-2"/> <name value="Object Identification"/> <severity value="error"/> <human value="Either an identifier or a reference, but not both"/> <xpath value="exists(f:identifier) != exists(f:reference)"/> </constraint> <constraint> <key value="sev-1"/> <name value="Object Name"/> <severity value="error"/> <human value="Either a name or a query (or both)"/> <xpath value="not(exists(f:name)) or not(exists(f:query))"/> </constraint> <mapping> <identity value="dicom"/> <map value="ParticipantObjectIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"/> </mapping> </element> <element> <path value="AuditEvent.object.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.object.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.object.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.object.identifier"/> <short value="Specific instance of object (e.g. versioned)"/> <definition value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <comments value="Identifier details depends on object type."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <condition value="sev-2"/> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> <mapping> <identity value="rim"/> <map value=".id.extension"/> </mapping> </element> <element> <path value="AuditEvent.object.reference"/> <short value="Specific instance of resource (e.g. versioned)"/> <definition value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <condition value="sev-2"/> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> <mapping> <identity value="rim"/> <map value="[self]"/> </mapping> </element> <element> <path value="AuditEvent.object.type"/> <short value="Type of object involved"/> <definition value="The type of the object that was involved in this audit event."/> <comments value="This value is distinct from the user's role or any user relationship to the participant object."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectType"/> <strength value="required"/> <description value="Code for the object type involved audited"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value="[self::Act].code or role.player.code"/> </mapping> </element> <element> <path value="AuditEvent.object.role"/> <short value="What role the Object played"/> <definition value="Code representing the functional application role of Participant Object being audited."/> <comments value="See RFC 3881 for rules concerning matches between role and type."/> <requirements value="For some detailed audit analysis it may be necessary to indicate a more granular type of participant, based on the application role it serves."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectRole"/> <strength value="required"/> <description value="Code representing the role the Object played in the event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-role"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCodeRole"/> </mapping> <mapping> <identity value="rim"/> <map value="role.code (not sure what this would mean for an Act)"/> </mapping> </element> <element> <path value="AuditEvent.object.lifecycle"/> <short value="Life-cycle stage for the object"/> <definition value="Identifier for the data life-cycle stage for the participant object."/> <comments value="This can be used to provide an audit trail for data, over time, as it passes through the system."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectLifecycle"/> <strength value="required"/> <description value="Identifier for the data life-cycle stage for the object"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-lifecycle"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectDataLifeCycle"/> </mapping> <mapping> <identity value="rim"/> <map value="target of ObservationEvent[code="lifecycle"].value"/> </mapping> </element> <element> <path value="AuditEvent.object.sensitivity"/> <short value="Policy-defined sensitivity for the object"/> <definition value="Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."/> <comments value="Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here."/> <requirements value="This field identifies a specific instance of an object, such as a patient, to detect/track privacy and security issues."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventObjectSensitivity"/> <strength value="example"/> <description value="The sensitivity of an object. May also encompass confidentiality and rudimentary access control (e.g. HCS)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-sensitivity"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectSensitivity"/> </mapping> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> </element> <element> <path value="AuditEvent.object.name"/> <short value="Instance-specific descriptor for Object"/> <definition value="An instance-specific descriptor of the Participant Object ID audited, such as a person's name."/> <comments value="This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sev-1"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectName"/> </mapping> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </element> <element> <path value="AuditEvent.object.description"/> <short value="Descriptive text"/> <definition value="Text that describes the object in more detail."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDescription"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element> <path value="AuditEvent.object.query"/> <short value="Actual query for object"/> <definition value="The actual query for a query-type participant object."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <condition value="sev-1"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectQuery"/> </mapping> <mapping> <identity value="rim"/> <map value="No mapping"/> </mapping> </element> <element> <path value="AuditEvent.object.detail"/> <short value="Additional Information about the Object"/> <definition value="Additional Information about the Object."/> <min value="0"/> <max value="*"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions."/> <comments value="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."/> <alias value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.type"/> <short value="Name of the property"/> <definition value="Name of the property."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@type"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.value"/> <short value="Property value"/> <definition value="Property value."/> <min value="1"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <mapping> <identity value="dicom"/> <map value="@value"/> </mapping> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </element> </snapshot> <differential> <element> <path value="AuditEvent"/> <short value="Event record kept for security purposes"/> <definition value="A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage."/> <comments value="Based on ATNA (RFC 3881)."/> <min value="1"/> <max value="1"/> <type> <code value="DomainResource"/> </type> <mapping> <identity value="dicom"/> <map value="Message"/> </mapping> <mapping> <identity value="rim"/> <map value="ControlAct[moodCode=EVN]"/> </mapping> </element> <element> <path value="AuditEvent.event"/> <short value="What was done"/> <definition value="Identifies the name, action type, time, and disposition of the audited event."/> <requirements value="The event must be identified."/> <min value="1"/> <max value="1"/> <mapping> <identity value="dicom"/> <map value="EventIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value="N/A (no nesting in v3)"/> </mapping> </element> <element> <path value="AuditEvent.event.type"/> <short value="Type/identifier of event"/> <definition value="Identifier for a family of the event."/> <comments value="e.g., a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function."/> <requirements value="This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventType"/> <strength value="required"/> <description value="Type of event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventId"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.subtype"/> <short value="More specific type/id for the event"/> <definition value="Identifier for the category of event."/> <requirements value="This field enables queries of messages by implementation-defined event categories."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventSubType"/> <strength value="required"/> <description value="Sub-type of event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-sub-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.action"/> <short value="Type of action performed during the event"/> <definition value="Indicator for type of action performed during the event that generated the audit."/> <requirements value="This broadly indicates what kind of action was done on the Participant Object."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventAction"/> <strength value="required"/> <description value="Indicator for type of action performed during the event that generated the audit."/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-action"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventActionCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code (type, subtype and action are pre-coordinated or sent as translations)"/> </mapping> </element> <element> <path value="AuditEvent.event.dateTime"/> <short value="Time when the event occurred on source"/> <definition value="The time when the event occurred on the source."/> <comments value="In a distributed system, some sort of common time base, e.g., an NTP [RFC1305] server, is a good implementation tactic."/> <requirements value="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."/> <min value="1"/> <max value="1"/> <type> <code value="instant"/> </type> <mapping> <identity value="dicom"/> <map value="@EventDateTime"/> </mapping> <mapping> <identity value="rim"/> <map value=".effectiveTime"/> </mapping> </element> <element> <path value="AuditEvent.event.outcome"/> <short value="Whether the event succeeded or failed"/> <definition value="Indicates whether the event succeeded or failed."/> <comments value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventOutcome"/> <strength value="required"/> <description value="Indicates whether the event succeeded or failed"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-outcome"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@EventOutcomeIndicator"/> </mapping> <mapping> <identity value="rim"/> <map value=".actionNegationInd"/> </mapping> </element> <element> <path value="AuditEvent.event.outcomeDesc"/> <short value="Description of the event outcome"/> <definition value="A free text description of the outcome of the event."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@EventOutcomeDescription"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=OUT].target.text"/> </mapping> </element> <element> <path value="AuditEvent.event.purposeOfEvent"/> <short value="The purposeOfUse of the event"/> <definition value="The purposeOfUse (reason) that was used during the event being recorded."/> <comments value="Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why)."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> </element> <element> <path value="AuditEvent.participant"/> <short value="A person, a hardware device or software process"/> <definition value="A person, a hardware device or software process."/> <comments value="There may be more than one user per event, for example, in cases of actions initiated by one user for other users, or in events that involve more than one user, hardware device, or system process. However, only one user may be the initiator/requestor for the event."/> <requirements value="The event has one or more active participants."/> <min value="1"/> <max value="*"/> <constraint> <key value="sev-3"/> <name value="Participant Identification"/> <severity value="error"/> <human value="Either a userId or a reference, but not both"/> <xpath value="exists(f:userId) != exists(f:reference)"/> </constraint> <mapping> <identity value="dicom"/> <map value="ActiveParticipant"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation"/> </mapping> </element> <element> <path value="AuditEvent.participant.role"/> <short value="User roles (e.g. local RBAC codes)"/> <definition value="Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the role-based access control security system used in the local context."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="DICOMRoleId"/> <strength value="required"/> <description value="Role(s) the user plays (from RBAC)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/dicm-402-roleid"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="RoleIdCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".typeCode and/or .functionCode"/> </mapping> </element> <element> <path value="AuditEvent.participant.reference"/> <short value="Direct reference to resource"/> <definition value="Direct reference to a resource that identifies the participant."/> <requirements value="This field ties an audit event to a specific resource."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Organization"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Device"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <condition value="sev-3"/> <mapping> <identity value="rim"/> <map value=".role"/> </mapping> </element> <element> <path value="AuditEvent.participant.userId"/> <short value="Unique identifier for the user"/> <definition value="Unique identifier for the user actively participating in the event."/> <comments value="a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name."/> <requirements value="This field ties an audit event to a specific user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sev-3"/> <mapping> <identity value="dicom"/> <map value="@UserId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="AuditEvent.participant.altId"/> <short value="Alternative User id e.g. authentication"/> <definition value="Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g., single sign-on), if available."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AlternativeUserId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id (distinguish id type by root)"/> </mapping> </element> <element> <path value="AuditEvent.participant.name"/> <short value="Human-meaningful name for the user"/> <definition value="Human-meaningful name for the user."/> <requirements value="The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@UserName"/> </mapping> <mapping> <identity value="rim"/> <map value=".name"/> </mapping> </element> <element> <path value="AuditEvent.participant.requestor"/> <short value="Whether user is initiator"/> <definition value="Indicator that the user is or is not the requestor, or initiator, for the event being audited."/> <comments value="There can only be one initiator. If the initiator is not clear, then do not choose any one participant as the initiator."/> <requirements value="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."/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> <mapping> <identity value="dicom"/> <map value="@UserIsRequestor"/> </mapping> <mapping> <identity value="rim"/> <map value="If participation.typeCode was author, then true"/> </mapping> </element> <element> <path value="AuditEvent.participant.location"/> <short value="Where"/> <definition value="Where the event occurred."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Location"/> </type> </element> <element> <path value="AuditEvent.participant.policy"/> <short value="Policy that authorized event"/> <definition value="The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used."/> <comments value="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."/> <requirements value="This value is used retrospectively to determine the authorization policies."/> <min value="0"/> <max value="*"/> <type> <code value="uri"/> </type> </element> <element> <path value="AuditEvent.participant.media"/> <short value="Type of media"/> <definition value="Type of media involved. Used when the event is about exporting/importing onto media."/> <requirements value="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)."/> <min value="0"/> <max value="1"/> <type> <code value="Coding"/> </type> <mapping> <identity value="dicom"/> <map value="MediaType"/> </mapping> <mapping> <identity value="rim"/> <map value=".player.description.mediaType"/> </mapping> </element> <element> <path value="AuditEvent.participant.network"/> <short value="Logical network location for application activity"/> <definition value="Logical network location for application activity, if the activity has a network location."/> <min value="0"/> <max value="1"/> <mapping> <identity value="rim"/> <map value=".player.description.reference"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.identifier"/> <short value="Identifier for the network access point of the user device"/> <definition value="An identifier for the network access point of the user device for the audit event."/> <comments value="This could be a device id, IP address or some other identifier associated with a device."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointID"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> </element> <element> <path value="AuditEvent.participant.network.type"/> <short value="The type of network access point"/> <definition value="An identifier for the type of network access point that originated the audit event."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventParticipantNetworkType"/> <strength value="required"/> <description value="The type of network access point of this participant in the audit event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/network-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@NetworkAccessPointTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value="pre-coordinated into URL"/> </mapping> </element> <element> <path value="AuditEvent.participant.purposeOfUse"/> <short value="Participant purposeOfUse"/> <definition value="The purposeOfUse (reason) specific to this participant that was used during the event being recorded."/> <comments value="Use participant.purposeOfUse when you know that is specific to the participant, otherwise use event.purposeOfEvent. (e.g. during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why)."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> </element> <element> <path value="AuditEvent.source"/> <short value="Application systems and processes"/> <definition value="Application systems and processes."/> <comments value="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."/> <requirements value="The event is reported by one source."/> <min value="1"/> <max value="1"/> <mapping> <identity value="dicom"/> <map value="AuditSourceIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"/> </mapping> </element> <element> <path value="AuditEvent.source.site"/> <short value="Logical source location within the enterprise"/> <definition value="Logical source location within the healthcare enterprise network."/> <comments value="a hospital or other provider location within a multi-entity provider group."/> <requirements value="This value differentiates among the sites in a multi-site enterprise health information system."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AuditEnterpriseSiteId"/> </mapping> <mapping> <identity value="rim"/> <map value=".scopedRole[classCode=LOCE].player.desc"/> </mapping> </element> <element> <path value="AuditEvent.source.identifier"/> <short value="The id of source where event originated"/> <definition value="Identifier of the source where the event originated."/> <requirements value="This field ties the event to a specific source system. It may be used to group events for analysis according to where the event occurred."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@AuditSourceId"/> </mapping> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> </element> <element> <path value="AuditEvent.source.type"/> <short value="The type of source where event originated"/> <definition value="Code specifying the type of source where event originated."/> <requirements value="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."/> <min value="0"/> <max value="*"/> <type> <code value="Coding"/> </type> <binding> <name value="AuditEventSourceType"/> <strength value="required"/> <description value="Code specifying the type of system that detected and recorded the event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-source-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="AuditSourceTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="AuditEvent.object"/> <short value="Specific instances of data or objects that have been accessed"/> <definition value="Specific instances of data or objects that have been accessed."/> <comments value="required unless the values for Event Identification, Active Participant Identification, and Audit Source Identification are sufficient to document the entire auditable event. Because events may have more than one participant object, this group can be a repeating set of values."/> <requirements value="The event may have other objects involved."/> <min value="0"/> <max value="*"/> <constraint> <key value="sev-2"/> <name value="Object Identification"/> <severity value="error"/> <human value="Either an identifier or a reference, but not both"/> <xpath value="exists(f:identifier) != exists(f:reference)"/> </constraint> <constraint> <key value="sev-1"/> <name value="Object Name"/> <severity value="error"/> <human value="Either a name or a query (or both)"/> <xpath value="not(exists(f:name)) or not(exists(f:query))"/> </constraint> <mapping> <identity value="dicom"/> <map value="ParticipantObjectIdentification"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"/> </mapping> </element> <element> <path value="AuditEvent.object.identifier"/> <short value="Specific instance of object (e.g. versioned)"/> <definition value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <comments value="Identifier details depends on object type."/> <min value="0"/> <max value="1"/> <type> <code value="Identifier"/> </type> <condition value="sev-2"/> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> <mapping> <identity value="rim"/> <map value=".id.extension"/> </mapping> </element> <element> <path value="AuditEvent.object.reference"/> <short value="Specific instance of resource (e.g. versioned)"/> <definition value="Identifies a specific instance of the participant object. The reference should always be version specific."/> <min value="0"/> <max value="1"/> <type> <code value="Reference"/> <profile value="http://hl7.org/fhir/StructureDefinition/Resource"/> </type> <condition value="sev-2"/> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectID"/> </mapping> <mapping> <identity value="rim"/> <map value="[self]"/> </mapping> </element> <element> <path value="AuditEvent.object.type"/> <short value="Type of object involved"/> <definition value="The type of the object that was involved in this audit event."/> <comments value="This value is distinct from the user's role or any user relationship to the participant object."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectType"/> <strength value="required"/> <description value="Code for the object type involved audited"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-type"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCode"/> </mapping> <mapping> <identity value="rim"/> <map value="[self::Act].code or role.player.code"/> </mapping> </element> <element> <path value="AuditEvent.object.role"/> <short value="What role the Object played"/> <definition value="Code representing the functional application role of Participant Object being audited."/> <comments value="See RFC 3881 for rules concerning matches between role and type."/> <requirements value="For some detailed audit analysis it may be necessary to indicate a more granular type of participant, based on the application role it serves."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectRole"/> <strength value="required"/> <description value="Code representing the role the Object played in the event"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-role"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectTypeCodeRole"/> </mapping> <mapping> <identity value="rim"/> <map value="role.code (not sure what this would mean for an Act)"/> </mapping> </element> <element> <path value="AuditEvent.object.lifecycle"/> <short value="Life-cycle stage for the object"/> <definition value="Identifier for the data life-cycle stage for the participant object."/> <comments value="This can be used to provide an audit trail for data, over time, as it passes through the system."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="code"/> </type> <binding> <name value="AuditEventObjectLifecycle"/> <strength value="required"/> <description value="Identifier for the data life-cycle stage for the object"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/object-lifecycle"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectDataLifeCycle"/> </mapping> <mapping> <identity value="rim"/> <map value="target of ObservationEvent[code="lifecycle"].value"/> </mapping> </element> <element> <path value="AuditEvent.object.sensitivity"/> <short value="Policy-defined sensitivity for the object"/> <definition value="Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status or similar topics."/> <comments value="Values from ATNA are institution- and implementation-defined text strings (in sensitivity.text). HL7 defines confidentiality codes for records, documents etc. that can also be used here."/> <requirements value="This field identifies a specific instance of an object, such as a patient, to detect/track privacy and security issues."/> <min value="0"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <binding> <name value="AuditEventObjectSensitivity"/> <strength value="example"/> <description value="The sensitivity of an object. May also encompass confidentiality and rudimentary access control (e.g. HCS)"/> <valueSetReference> <reference value="http://hl7.org/fhir/vs/audit-event-sensitivity"/> </valueSetReference> </binding> <mapping> <identity value="dicom"/> <map value="@ParticipantObjectSensitivity"/> </mapping> <mapping> <identity value="rim"/> <map value=".confidentialityCode"/> </mapping> </element> <element> <path value="AuditEvent.object.name"/> <short value="Instance-specific descriptor for Object"/> <definition value="An instance-specific descriptor of the Participant Object ID audited, such as a person's name."/> <comments value="This field may be used in a query/report to identify audit events for a specific person, e.g., where multiple synonymous Participant Object IDs (patient number, medical record number, encounter number, etc.) have been used."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <condition value="sev-1"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectName"/> </mapping> <mapping> <identity value="rim"/> <map value=".title"/> </mapping> </element> <element> <path value="AuditEvent.object.description"/> <short value="Descriptive text"/> <definition value="Text that describes the object in more detail."/> <min value="0"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDescription"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> </element> <element> <path value="AuditEvent.object.query"/> <short value="Actual query for object"/> <definition value="The actual query for a query-type participant object."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <condition value="sev-1"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectQuery"/> </mapping> <mapping> <identity value="rim"/> <map value="No mapping"/> </mapping> </element> <element> <path value="AuditEvent.object.detail"/> <short value="Additional Information about the Object"/> <definition value="Additional Information about the Object."/> <min value="0"/> <max value="*"/> <mapping> <identity value="dicom"/> <map value="ParticipantObjectDetail"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.type"/> <short value="Name of the property"/> <definition value="Name of the property."/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="dicom"/> <map value="@type"/> </mapping> <mapping> <identity value="rim"/> <map value=".code"/> </mapping> </element> <element> <path value="AuditEvent.object.detail.value"/> <short value="Property value"/> <definition value="Property value."/> <min value="1"/> <max value="1"/> <type> <code value="base64Binary"/> </type> <mapping> <identity value="dicom"/> <map value="@value"/> </mapping> <mapping> <identity value="rim"/> <map value=".value"/> </mapping> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:29+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change