STU 3 Ballot
Security and PrivacyThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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
{
"resourceType": "StructureDefinition",
"id": "AuditEvent",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}
],
"url": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"name": "AuditEvent",
"status": "draft",
"publisher": "Health Level Seven International (Security)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/secure/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for AuditEvent Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "dicom",
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "w3c.prov",
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV"
},
{
"identity": "fhirprovenance",
"uri": "http://hl7.org/fhir/provenance",
"name": "FHIR Provenance"
}
],
"kind": "resource",
"abstract": false,
"type": "AuditEvent",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "AuditEvent",
"path": "AuditEvent",
"short": "Event record kept for security purposes",
"definition": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comments": "Based on ATNA (RFC 3881).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "ControlAct[moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Message"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
},
{
"id": "AuditEvent.id",
"path": "AuditEvent.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "AuditEvent.meta",
"path": "AuditEvent.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "AuditEvent.implicitRules",
"path": "AuditEvent.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "AuditEvent.language",
"path": "AuditEvent.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "AuditEvent.text",
"path": "AuditEvent.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "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 in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "AuditEvent.contained",
"path": "AuditEvent.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.extension",
"path": "AuditEvent.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.modifierExtension",
"path": "AuditEvent.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.type",
"path": "AuditEvent.type",
"short": "Type/identifier of event",
"definition": "Identifier 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.",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventId"
},
{
"identity": "w3c.prov",
"map": "Activity"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.subtype",
"path": "AuditEvent.subtype",
"short": "More specific type/id for the event",
"definition": "Identifier for the category of event.",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Sub-type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-sub-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventTypeCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.action",
"path": "AuditEvent.action",
"short": "Type of action performed during the event",
"definition": "Indicator for type of action performed during the event that generated the audit.",
"requirements": "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicator for type of action performed during the event that generated the audit.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventActionCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.recorded",
"path": "AuditEvent.recorded",
"short": "Time when the event occurred on source",
"definition": "The time when the event occurred on the source.",
"comments": "In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.",
"requirements": "This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "EventDateTime"
},
{
"identity": "w3c.prov",
"map": "Activity.when"
},
{
"identity": "fhirprovenance",
"map": "Provenance.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "AuditEvent.outcome",
"path": "AuditEvent.outcome",
"short": "Whether the event succeeded or failed",
"definition": "Indicates whether the event succeeded or failed.",
"comments": "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates whether the event succeeded or failed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actionNegationInd"
},
{
"identity": "dicom",
"map": "EventOutcomeIndicator"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.outcomeDesc",
"path": "AuditEvent.outcomeDesc",
"short": "Description of the event outcome",
"definition": "A free text description of the outcome of the event.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
},
{
"identity": "dicom",
"map": "EventOutcomeDescription"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.purposeOfEvent",
"path": "AuditEvent.purposeOfEvent",
"short": "The purposeOfUse of the event",
"definition": "The purposeOfUse (reason) that was used during the event being recorded.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"mapping": [
{
"identity": "rim",
"map": "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target"
},
{
"identity": "dicom",
"map": "EventPurposeOfUse"
},
{
"identity": "w3c.prov",
"map": "Activity.Activity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.reason, Provenance.activity"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.agent",
"path": "AuditEvent.agent",
"short": "Actor involved in the event",
"definition": "An actor taking an active role in the event or activity that is logged.",
"comments": "Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.\n\nFor 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.",
"requirements": "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.",
"alias": [
"ActiveParticipant"
],
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation"
},
{
"identity": "dicom",
"map": "ActiveParticipant"
},
{
"identity": "w3c.prov",
"map": "Agent"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.id",
"path": "AuditEvent.agent.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.agent.extension",
"path": "AuditEvent.agent.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.agent.modifierExtension",
"path": "AuditEvent.agent.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.agent.role",
"path": "AuditEvent.agent.role",
"short": "Agent role in the event",
"definition": "Specification of the role(s) the user plays when performing the event. Additional may contain security role codes that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"comments": "should be roles relevant to the event. Should not be an exhaustive list of roles.",
"requirements": "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"description": "How the agent participated in the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicm-402-roleid"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode and/or .functionCode"
},
{
"identity": "dicom",
"map": "RoleIdCode"
},
{
"identity": "w3c.prov",
"map": "Agent.Attribution"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.role"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.reference",
"path": "AuditEvent.agent.reference",
"short": "Direct reference to resource",
"definition": "Direct reference to a resource that identifies the agent.",
"requirements": "This field ties an audit event to a specific resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".role"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.actor"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.userId",
"path": "AuditEvent.agent.userId",
"short": "Unique identifier for the user",
"definition": "Unique identifier for the user actively participating in the event.",
"comments": "a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"requirements": "This field ties an audit event to a specific user.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "UserId"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.userId"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.altId",
"path": "AuditEvent.agent.altId",
"short": "Alternative User id e.g. authentication",
"definition": "Alternative 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.",
"requirements": "In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id (distinguish id type by root)"
},
{
"identity": "dicom",
"map": "AlternativeUserId"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.name",
"path": "AuditEvent.agent.name",
"short": "Human-meaningful name for the agent",
"definition": "Human-meaningful name for the agent.",
"requirements": "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "dicom",
"map": "UserName"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.requestor",
"path": "AuditEvent.agent.requestor",
"short": "Whether user is initiator",
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comments": "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"requirements": "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": "If participation.typeCode was author, then true"
},
{
"identity": "dicom",
"map": "UserIsRequestor"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.location",
"path": "AuditEvent.agent.location",
"short": "Where",
"definition": "Where the event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "* Role.Class =SDLOC\n*Role.Code = ServiceDeliveryLocationRoleType\n *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC\n*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant."
},
{
"identity": "w3c.prov",
"map": "Activity.location"
},
{
"identity": "fhirprovenance",
"map": "Provenance.location"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.policy",
"path": "AuditEvent.agent.policy",
"short": "Policy that authorized event",
"definition": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "ActPolicyType"
},
{
"identity": "dicom",
"map": "ParticipantRoleIDCode"
},
{
"identity": "fhirprovenance",
"map": "Provenance.policy"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.agent.media",
"path": "AuditEvent.agent.media",
"short": "Type of media",
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements": "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Used when the event is about exporting/importing onto media.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicm-405-mediatype"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.description.mediaType"
},
{
"identity": "dicom",
"map": "MediaType"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network",
"path": "AuditEvent.agent.network",
"short": "Logical network location for application activity",
"definition": "Logical network location for application activity, if the activity has a network location.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.description.reference"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network.id",
"path": "AuditEvent.agent.network.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.agent.network.extension",
"path": "AuditEvent.agent.network.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.agent.network.modifierExtension",
"path": "AuditEvent.agent.network.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.agent.network.address",
"path": "AuditEvent.agent.network.address",
"short": "Identifier for the network access point of the user device",
"definition": "An identifier for the network access point of the user device for the audit event.",
"comments": "This could be a device id, IP address or some other identifier associated with a device.",
"requirements": "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "NetworkAccessPointID"
},
{
"identity": "w3c.prov",
"map": "Agent.Location"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network.type",
"path": "AuditEvent.agent.network.type",
"short": "The type of network access point",
"definition": "An identifier for the type of network access point that originated the audit event.",
"requirements": "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of network access point of this agent in the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/network-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "NetworkAccessPointTypeCode"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.purposeOfUse",
"path": "AuditEvent.agent.purposeOfUse",
"short": "Reason given for this user",
"definition": "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"mapping": [
{
"identity": "rim",
"map": "*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse\n(2.16.840.1.113883.1.11.20448)\n* .outboundRelationship[typeCode=RSON or SUBJ].target"
},
{
"identity": "w3c.prov",
"map": "Agent.Activity"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.source",
"path": "AuditEvent.source",
"short": "Audit Event Reporter",
"definition": "The system that is reporting the event.",
"comments": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.",
"requirements": "The event is reported by one source.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
},
{
"identity": "dicom",
"map": "AuditSourceIdentification"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.id",
"path": "AuditEvent.source.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.source.extension",
"path": "AuditEvent.source.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.source.modifierExtension",
"path": "AuditEvent.source.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.source.site",
"path": "AuditEvent.source.site",
"short": "Logical source location within the enterprise",
"definition": "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"requirements": "This value differentiates among the sites in a multi-site enterprise health information system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[classCode=LOCE].player.desc"
},
{
"identity": "dicom",
"map": "AuditEnterpriseSiteId"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.identifier",
"path": "AuditEvent.source.identifier",
"short": "The identity of source detecting the event",
"definition": "Identifier of the source where the event was detected.",
"requirements": "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "AuditSourceId"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.type",
"path": "AuditEvent.source.type",
"short": "The type of source where event originated",
"definition": "Code specifying the type of source where event originated.",
"requirements": "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code specifying the type of system that detected and recorded the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-source-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "AuditSourceTypeCode"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.entity",
"path": "AuditEvent.entity",
"short": "Data or objects used",
"definition": "Specific instances of data or objects that have been accessed.",
"comments": "Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.",
"requirements": "The event may have other entities involved.",
"alias": [
"ParticipantObject"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "sev-1",
"severity": "error",
"human": "Either a name or a query (NOT both)",
"expression": "name.empty() or query.empty()",
"xpath": "not(exists(f:name)) or not(exists(f:query))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "ParticipantObjectIdentification"
},
{
"identity": "w3c.prov",
"map": "Entity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.target, Provenance.entity"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.id",
"path": "AuditEvent.entity.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.entity.extension",
"path": "AuditEvent.entity.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.entity.modifierExtension",
"path": "AuditEvent.entity.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.entity.identifier",
"path": "AuditEvent.entity.identifier",
"short": "Specific instance of object",
"definition": "Identifies a specific instance of the entity. The reference should always be version specific.",
"comments": "Identifier detail depends on entity type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id.extension"
},
{
"identity": "dicom",
"map": "ParticipantObjectID and ParticipantObjectIDTypeCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.reference",
"path": "AuditEvent.entity.reference",
"short": "Specific instance of resource",
"definition": "Identifies a specific instance of the entity. The reference should be version specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "[self]"
},
{
"identity": "dicom",
"map": "ParticipantObjectID"
},
{
"identity": "fhirprovenance",
"map": "Provenance.target, Provenance.entity.reference"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.type",
"path": "AuditEvent.entity.type",
"short": "Type of entity involved",
"definition": "The type of the object that was involved in this audit event.",
"comments": "This value is distinct from the user's role or any user relationship to the entity.",
"requirements": "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code for the entity type involved audited.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "[self::Act].code or role.player.code"
},
{
"identity": "dicom",
"map": "ParticipantObjectTypeCode"
},
{
"identity": "w3c.prov",
"map": "Entity.type"
},
{
"identity": "fhirprovenance",
"map": "Provenance.entity.type"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.role",
"path": "AuditEvent.entity.role",
"short": "What role the entity played",
"definition": "Code representing the role the entity played in the event being audited.",
"requirements": "For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code representing the role the entity played in the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "role.code (not sure what this would mean for an Act)"
},
{
"identity": "dicom",
"map": "ParticipantObjectTypeCodeRole"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.lifecycle",
"path": "AuditEvent.entity.lifecycle",
"short": "Life-cycle stage for the entity",
"definition": "Identifier for the data life-cycle stage for the entity.",
"comments": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements": "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Identifier for the data life-cycle stage for the entity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-lifecycle"
}
},
"mapping": [
{
"identity": "rim",
"map": "target of ObservationEvent[code=\"lifecycle\"].value"
},
{
"identity": "dicom",
"map": "ParticipantObjectDataLifeCycle"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
},
{
"identity": "fhirprovenance",
"map": "Provenance.entity.role"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.securityLabel",
"path": "AuditEvent.entity.securityLabel",
"short": "Security labels on the entity",
"definition": "Denotes security labels for the identified entity.",
"comments": "copied from entity meta security tags.",
"requirements": "This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "dicom",
"map": "ParticipantObjectSensitivity"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.name",
"path": "AuditEvent.entity.name",
"short": "Descriptor for entity",
"definition": "A name of the entity in the audit event.",
"comments": "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifers (patient number, medical record number, encounter number, etc.) have been used.",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "ParticipantObjectName"
},
{
"identity": "w3c.prov",
"map": "Entity.Label"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.description",
"path": "AuditEvent.entity.description",
"short": "Descriptive text",
"definition": "Text that describes the entity in more detail.",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "ParticipantObjectDescription"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.query",
"path": "AuditEvent.entity.query",
"short": "Query parameters",
"definition": "The query parameters for a query-type entities.",
"requirements": "For query events it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"condition": [
"sev-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "No mapping"
},
{
"identity": "dicom",
"map": "ParticipantObjectQuery"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail",
"path": "AuditEvent.entity.detail",
"short": "Additional Information about the entity",
"definition": "Additional Information about the entity.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail.id",
"path": "AuditEvent.entity.detail.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.entity.detail.extension",
"path": "AuditEvent.entity.detail.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "AuditEvent.entity.detail.modifierExtension",
"path": "AuditEvent.entity.detail.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "AuditEvent.entity.detail.type",
"path": "AuditEvent.entity.detail.type",
"short": "Name of the property",
"definition": "Name of the property.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail.type"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail.value",
"path": "AuditEvent.entity.detail.value",
"short": "Property value",
"definition": "Property value.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail.value"
},
{
"identity": "w5",
"map": "context"
}
]
}
]
},
"differential": {
"element": [
{
"id": "AuditEvent",
"path": "AuditEvent",
"short": "Event record kept for security purposes",
"definition": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"comments": "Based on ATNA (RFC 3881).",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "ControlAct[moodCode=EVN]"
},
{
"identity": "dicom",
"map": "Message"
},
{
"identity": "w5",
"map": "infrastructure.information"
}
]
},
{
"id": "AuditEvent.type",
"path": "AuditEvent.type",
"short": "Type/identifier of event",
"definition": "Identifier 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.",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventId"
},
{
"identity": "w3c.prov",
"map": "Activity"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.subtype",
"path": "AuditEvent.subtype",
"short": "More specific type/id for the event",
"definition": "Identifier for the category of event.",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Sub-type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-sub-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventTypeCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.action",
"path": "AuditEvent.action",
"short": "Type of action performed during the event",
"definition": "Indicator for type of action performed during the event that generated the audit.",
"requirements": "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicator for type of action performed during the event that generated the audit.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-action"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)"
},
{
"identity": "dicom",
"map": "EventActionCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.recorded",
"path": "AuditEvent.recorded",
"short": "Time when the event occurred on source",
"definition": "The time when the event occurred on the source.",
"comments": "In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.",
"requirements": "This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "dicom",
"map": "EventDateTime"
},
{
"identity": "w3c.prov",
"map": "Activity.when"
},
{
"identity": "fhirprovenance",
"map": "Provenance.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "AuditEvent.outcome",
"path": "AuditEvent.outcome",
"short": "Whether the event succeeded or failed",
"definition": "Indicates whether the event succeeded or failed.",
"comments": "In some cases a \"success\" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates whether the event succeeded or failed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-outcome"
}
},
"mapping": [
{
"identity": "rim",
"map": ".actionNegationInd"
},
{
"identity": "dicom",
"map": "EventOutcomeIndicator"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.outcomeDesc",
"path": "AuditEvent.outcomeDesc",
"short": "Description of the event outcome",
"definition": "A free text description of the outcome of the event.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=OUT].target.text"
},
{
"identity": "dicom",
"map": "EventOutcomeDescription"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.purposeOfEvent",
"path": "AuditEvent.purposeOfEvent",
"short": "The purposeOfUse of the event",
"definition": "The purposeOfUse (reason) that was used during the event being recorded.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"mapping": [
{
"identity": "rim",
"map": "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target"
},
{
"identity": "dicom",
"map": "EventPurposeOfUse"
},
{
"identity": "w3c.prov",
"map": "Activity.Activity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.reason, Provenance.activity"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.agent",
"path": "AuditEvent.agent",
"short": "Actor involved in the event",
"definition": "An actor taking an active role in the event or activity that is logged.",
"comments": "Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.\n\nFor 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.",
"requirements": "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.",
"alias": [
"ActiveParticipant"
],
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation"
},
{
"identity": "dicom",
"map": "ActiveParticipant"
},
{
"identity": "w3c.prov",
"map": "Agent"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.role",
"path": "AuditEvent.agent.role",
"short": "Agent role in the event",
"definition": "Specification of the role(s) the user plays when performing the event. Additional may contain security role codes that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"comments": "should be roles relevant to the event. Should not be an exhaustive list of roles.",
"requirements": "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"description": "How the agent participated in the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicm-402-roleid"
}
},
"mapping": [
{
"identity": "rim",
"map": ".typeCode and/or .functionCode"
},
{
"identity": "dicom",
"map": "RoleIdCode"
},
{
"identity": "w3c.prov",
"map": "Agent.Attribution"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.role"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.reference",
"path": "AuditEvent.agent.reference",
"short": "Direct reference to resource",
"definition": "Direct reference to a resource that identifies the agent.",
"requirements": "This field ties an audit event to a specific resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Device"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".role"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.actor"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.userId",
"path": "AuditEvent.agent.userId",
"short": "Unique identifier for the user",
"definition": "Unique identifier for the user actively participating in the event.",
"comments": "a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"requirements": "This field ties an audit event to a specific user.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "UserId"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.agent.userId"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.altId",
"path": "AuditEvent.agent.altId",
"short": "Alternative User id e.g. authentication",
"definition": "Alternative 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.",
"requirements": "In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id (distinguish id type by root)"
},
{
"identity": "dicom",
"map": "AlternativeUserId"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.name",
"path": "AuditEvent.agent.name",
"short": "Human-meaningful name for the agent",
"definition": "Human-meaningful name for the agent.",
"requirements": "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".name"
},
{
"identity": "dicom",
"map": "UserName"
},
{
"identity": "w3c.prov",
"map": "Agent.Identity"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.requestor",
"path": "AuditEvent.agent.requestor",
"short": "Whether user is initiator",
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"comments": "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"requirements": "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": "If participation.typeCode was author, then true"
},
{
"identity": "dicom",
"map": "UserIsRequestor"
},
{
"identity": "w5",
"map": "who"
}
]
},
{
"id": "AuditEvent.agent.location",
"path": "AuditEvent.agent.location",
"short": "Where",
"definition": "Where the event occurred.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "rim",
"map": "* Role.Class =SDLOC\n*Role.Code = ServiceDeliveryLocationRoleType\n *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC\n*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant."
},
{
"identity": "w3c.prov",
"map": "Activity.location"
},
{
"identity": "fhirprovenance",
"map": "Provenance.location"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.policy",
"path": "AuditEvent.agent.policy",
"short": "Policy that authorized event",
"definition": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"comments": "For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "ActPolicyType"
},
{
"identity": "dicom",
"map": "ParticipantRoleIDCode"
},
{
"identity": "fhirprovenance",
"map": "Provenance.policy"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.agent.media",
"path": "AuditEvent.agent.media",
"short": "Type of media",
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"requirements": "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Used when the event is about exporting/importing onto media.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicm-405-mediatype"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.description.mediaType"
},
{
"identity": "dicom",
"map": "MediaType"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network",
"path": "AuditEvent.agent.network",
"short": "Logical network location for application activity",
"definition": "Logical network location for application activity, if the activity has a network location.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player.description.reference"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network.address",
"path": "AuditEvent.agent.network.address",
"short": "Identifier for the network access point of the user device",
"definition": "An identifier for the network access point of the user device for the audit event.",
"comments": "This could be a device id, IP address or some other identifier associated with a device.",
"requirements": "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "NetworkAccessPointID"
},
{
"identity": "w3c.prov",
"map": "Agent.Location"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.network.type",
"path": "AuditEvent.agent.network.type",
"short": "The type of network access point",
"definition": "An identifier for the type of network access point that originated the audit event.",
"requirements": "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The type of network access point of this agent in the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/network-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "pre-coordinated into URL"
},
{
"identity": "dicom",
"map": "NetworkAccessPointTypeCode"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "AuditEvent.agent.purposeOfUse",
"path": "AuditEvent.agent.purposeOfUse",
"short": "Reason given for this user",
"definition": "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
"comments": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"mapping": [
{
"identity": "rim",
"map": "*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse\n(2.16.840.1.113883.1.11.20448)\n* .outboundRelationship[typeCode=RSON or SUBJ].target"
},
{
"identity": "w3c.prov",
"map": "Agent.Activity"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "AuditEvent.source",
"path": "AuditEvent.source",
"short": "Audit Event Reporter",
"definition": "The system that is reporting the event.",
"comments": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.",
"requirements": "The event is reported by one source.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]"
},
{
"identity": "dicom",
"map": "AuditSourceIdentification"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.site",
"path": "AuditEvent.source.site",
"short": "Logical source location within the enterprise",
"definition": "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"requirements": "This value differentiates among the sites in a multi-site enterprise health information system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".scopedRole[classCode=LOCE].player.desc"
},
{
"identity": "dicom",
"map": "AuditEnterpriseSiteId"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.identifier",
"path": "AuditEvent.source.identifier",
"short": "The identity of source detecting the event",
"definition": "Identifier of the source where the event was detected.",
"requirements": "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "dicom",
"map": "AuditSourceId"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.source.type",
"path": "AuditEvent.source.type",
"short": "The type of source where event originated",
"definition": "Code specifying the type of source where event originated.",
"requirements": "This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code specifying the type of system that detected and recorded the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-source-type"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "AuditSourceTypeCode"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "AuditEvent.entity",
"path": "AuditEvent.entity",
"short": "Data or objects used",
"definition": "Specific instances of data or objects that have been accessed.",
"comments": "Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.",
"requirements": "The event may have other entities involved.",
"alias": [
"ParticipantObject"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "sev-1",
"severity": "error",
"human": "Either a name or a query (NOT both)",
"expression": "name.empty() or query.empty()",
"xpath": "not(exists(f:name)) or not(exists(f:query))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role"
},
{
"identity": "dicom",
"map": "ParticipantObjectIdentification"
},
{
"identity": "w3c.prov",
"map": "Entity"
},
{
"identity": "fhirprovenance",
"map": "Provenance.target, Provenance.entity"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.identifier",
"path": "AuditEvent.entity.identifier",
"short": "Specific instance of object",
"definition": "Identifies a specific instance of the entity. The reference should always be version specific.",
"comments": "Identifier detail depends on entity type.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".id.extension"
},
{
"identity": "dicom",
"map": "ParticipantObjectID and ParticipantObjectIDTypeCode"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.reference",
"path": "AuditEvent.entity.reference",
"short": "Specific instance of resource",
"definition": "Identifies a specific instance of the entity. The reference should be version specific.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "[self]"
},
{
"identity": "dicom",
"map": "ParticipantObjectID"
},
{
"identity": "fhirprovenance",
"map": "Provenance.target, Provenance.entity.reference"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.type",
"path": "AuditEvent.entity.type",
"short": "Type of entity involved",
"definition": "The type of the object that was involved in this audit event.",
"comments": "This value is distinct from the user's role or any user relationship to the entity.",
"requirements": "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code for the entity type involved audited.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "[self::Act].code or role.player.code"
},
{
"identity": "dicom",
"map": "ParticipantObjectTypeCode"
},
{
"identity": "w3c.prov",
"map": "Entity.type"
},
{
"identity": "fhirprovenance",
"map": "Provenance.entity.type"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "AuditEvent.entity.role",
"path": "AuditEvent.entity.role",
"short": "What role the entity played",
"definition": "Code representing the role the entity played in the event being audited.",
"requirements": "For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Code representing the role the entity played in the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "role.code (not sure what this would mean for an Act)"
},
{
"identity": "dicom",
"map": "ParticipantObjectTypeCodeRole"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.lifecycle",
"path": "AuditEvent.entity.lifecycle",
"short": "Life-cycle stage for the entity",
"definition": "Identifier for the data life-cycle stage for the entity.",
"comments": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"requirements": "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min": 0,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Identifier for the data life-cycle stage for the entity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-lifecycle"
}
},
"mapping": [
{
"identity": "rim",
"map": "target of ObservationEvent[code=\"lifecycle\"].value"
},
{
"identity": "dicom",
"map": "ParticipantObjectDataLifeCycle"
},
{
"identity": "w3c.prov",
"map": "Entity.role"
},
{
"identity": "fhirprovenance",
"map": "Provenance.entity.role"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.securityLabel",
"path": "AuditEvent.entity.securityLabel",
"short": "Security labels on the entity",
"definition": "Denotes security labels for the identified entity.",
"comments": "copied from entity meta security tags.",
"requirements": "This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"mapping": [
{
"identity": "rim",
"map": ".confidentialityCode"
},
{
"identity": "dicom",
"map": "ParticipantObjectSensitivity"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.name",
"path": "AuditEvent.entity.name",
"short": "Descriptor for entity",
"definition": "A name of the entity in the audit event.",
"comments": "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifers (patient number, medical record number, encounter number, etc.) have been used.",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"sev-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".title"
},
{
"identity": "dicom",
"map": "ParticipantObjectName"
},
{
"identity": "w3c.prov",
"map": "Entity.Label"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.description",
"path": "AuditEvent.entity.description",
"short": "Descriptive text",
"definition": "Text that describes the entity in more detail.",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
},
{
"identity": "dicom",
"map": "ParticipantObjectDescription"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.query",
"path": "AuditEvent.entity.query",
"short": "Query parameters",
"definition": "The query parameters for a query-type entities.",
"requirements": "For query events it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.",
"min": 0,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"condition": [
"sev-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "No mapping"
},
{
"identity": "dicom",
"map": "ParticipantObjectQuery"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail",
"path": "AuditEvent.entity.detail",
"short": "Additional Information about the entity",
"definition": "Additional Information about the entity.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail.type",
"path": "AuditEvent.entity.detail.type",
"short": "Name of the property",
"definition": "Name of the property.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail.type"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "AuditEvent.entity.detail.value",
"path": "AuditEvent.entity.detail.value",
"short": "Property value",
"definition": "Property value.",
"min": 1,
"max": "1",
"type": [
{
"code": "base64Binary"
}
],
"mapping": [
{
"identity": "rim",
"map": ".value"
},
{
"identity": "dicom",
"map": "ParticipantObjectDetail.value"
},
{
"identity": "w5",
"map": "context"
}
]
}
]
}
}
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 STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change