{
"description": "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.",
"_filename": "AuditEvent.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2019-11-01T09:29:23+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2022-01-10T02:25:04.425+00:00"
},
"publisher": "Health Level Seven International (Security)",
"fhirVersion": "4.0.1",
"name": "AuditEvent",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping",
"identity": "dicom"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV",
"identity": "w3c.prov"
}, {
"uri": "http://hl7.org/fhir/provenance",
"name": "FHIR Provenance Mapping",
"identity": "fhirprovenance"
} ],
"abstract": false,
"type": "AuditEvent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Security"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "not-classified"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "sec"
} ],
"status": "draft",
"id": "426a2dbb-c805-410e-8984-dc61e9a4184f",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/AuditEvent",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "AuditEvent",
"path": "AuditEvent",
"short": "Event record kept for security purposes",
"comment": "Based on IHE-ATNA.",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "ControlAct[moodCode=EVN]",
"identity": "rim"
}, {
"map": "Message",
"identity": "dicom"
} ],
"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."
}, {
"path": "AuditEvent.type",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"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.",
"short": "Type/identifier of event",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventId",
"identity": "dicom"
}, {
"map": "Activity",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventType"
} ],
"description": "Type of event."
},
"max": "1",
"id": "AuditEvent.type",
"isSummary": true
}, {
"path": "AuditEvent.subtype",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"definition": "Identifier for the category of event.",
"short": "More specific type/id for the event",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventTypeCode",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-sub-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSubType"
} ],
"description": "Sub-type of event."
},
"id": "AuditEvent.subtype",
"isSummary": true
}, {
"path": "AuditEvent.action",
"requirements": "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"definition": "Indicator for type of action performed during the event that generated the audit.",
"short": "Type of action performed during the event",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventActionCode",
"identity": "dicom"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventAction"
} ],
"description": "Indicator for type of action performed during the event that generated the event."
},
"max": "1",
"id": "AuditEvent.action",
"isSummary": true
}, {
"id": "AuditEvent.period",
"max": "1",
"path": "AuditEvent.period",
"type": [ {
"code": "Period"
} ],
"short": "When the activity occurred",
"comment": "The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"mapping": [ {
"map": "Event.occurred[x]",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "./effectiveTime[type=IVL_TS]",
"identity": "rim"
}, {
"map": "EventDateTime",
"identity": "dicom"
}, {
"map": "Activity.startTime & Activity.endTime",
"identity": "w3c.prov"
}, {
"map": "Provenance.occurred[x]",
"identity": "fhirprovenance"
} ],
"definition": "The period during which the activity occurred."
}, {
"path": "AuditEvent.recorded",
"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,
"definition": "The time when the event was recorded.",
"short": "Time when the event was recorded",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "Activity.when",
"identity": "w3c.prov"
}, {
"map": "Provenance.recorded",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "instant"
} ],
"max": "1",
"id": "AuditEvent.recorded",
"comment": "In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.",
"isSummary": true
}, {
"path": "AuditEvent.outcome",
"definition": "Indicates whether the event succeeded or failed.",
"short": "Whether the event succeeded or failed",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".actionNegationInd",
"identity": "rim"
}, {
"map": "EventOutcomeIndicator",
"identity": "dicom"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventOutcome"
} ],
"description": "Indicates whether the event succeeded or failed."
},
"max": "1",
"id": "AuditEvent.outcome",
"comment": "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.",
"isSummary": true
}, {
"id": "AuditEvent.outcomeDesc",
"max": "1",
"path": "AuditEvent.outcomeDesc",
"type": [ {
"code": "string"
} ],
"short": "Description of the event outcome",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=OUT].target.text",
"identity": "rim"
}, {
"map": "EventOutcomeDescription",
"identity": "dicom"
} ],
"isSummary": true,
"definition": "A free text description of the outcome of the event."
}, {
"path": "AuditEvent.purposeOfEvent",
"definition": "The purposeOfUse (reason) that was used during the event being recorded.",
"short": "The purposeOfUse of the event",
"mapping": [ {
"map": "Event.reasonCode",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "EventPurposeOfUse",
"identity": "dicom"
}, {
"map": "Activity.Activity",
"identity": "w3c.prov"
}, {
"map": "Provenance.reason, Provenance.activity",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditPurposeOfUse"
} ],
"description": "The reason the activity took place."
},
"id": "AuditEvent.purposeOfEvent",
"comment": "Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"isSummary": true
}, {
"path": "AuditEvent.agent",
"requirements": "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.",
"min": 1,
"definition": "An actor taking an active role in the event or activity that is logged.",
"short": "Actor involved in the event",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".participation",
"identity": "rim"
}, {
"map": "ActiveParticipant",
"identity": "dicom"
}, {
"map": "Agent",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"alias": [ "ActiveParticipant" ],
"id": "AuditEvent.agent",
"comment": "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."
}, {
"id": "AuditEvent.agent.type",
"max": "1",
"path": "AuditEvent.agent.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "How agent participated",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditAgentType"
} ],
"description": "The Participation type of the agent to the event."
},
"mapping": [ {
"map": "Event.performer.function",
"identity": "workflow"
}, {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".typeCode and/or .functionCode",
"identity": "rim"
}, {
"map": "RoleIdCode",
"identity": "dicom"
}, {
"map": "Agent.Attribution",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.type",
"identity": "fhirprovenance"
} ],
"definition": "Specification of the participation type the user plays when performing the event."
}, {
"path": "AuditEvent.agent.role",
"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.",
"definition": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"short": "Agent role in the event",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".role",
"identity": "rim"
}, {
"map": "RoleIdCode",
"identity": "dicom"
}, {
"map": "Agent.Attribution",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.role",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/security-role-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditAgentRole"
} ],
"description": "What security role enabled the agent to participate in the event."
},
"id": "AuditEvent.agent.role",
"comment": "Should be roles relevant to the event. Should not be an exhaustive list of roles."
}, {
"path": "AuditEvent.agent.who",
"requirements": "This field ties an audit event to a specific resource or identifier.",
"definition": "Reference to who this agent is that was involved in the event.",
"short": "Identifier of who",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "UserId",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.who",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"alias": [ "userId" ],
"max": "1",
"id": "AuditEvent.agent.who",
"comment": "Where a User ID is available it will go into who.identifier.",
"isSummary": true
}, {
"id": "AuditEvent.agent.altId",
"max": "1",
"path": "AuditEvent.agent.altId",
"type": [ {
"code": "string"
} ],
"short": "Alternative User identity",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".id (distinguish id type by root)",
"identity": "rim"
}, {
"map": "AlternativeUserId",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
} ],
"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."
}, {
"id": "AuditEvent.agent.name",
"max": "1",
"path": "AuditEvent.agent.name",
"type": [ {
"code": "string"
} ],
"short": "Human friendly name for the agent",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".name",
"identity": "rim"
}, {
"map": "UserName",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
} ],
"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."
}, {
"path": "AuditEvent.agent.requestor",
"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,
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"short": "Whether user is initiator",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": "If participation.typeCode was author, then true",
"identity": "rim"
}, {
"map": "UserIsRequestor",
"identity": "dicom"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "AuditEvent.agent.requestor",
"comment": "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"isSummary": true
}, {
"id": "AuditEvent.agent.location",
"max": "1",
"path": "AuditEvent.agent.location",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"short": "Where",
"mapping": [ {
"map": "Event.location",
"identity": "workflow"
}, {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"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 might or might not be constant.",
"identity": "rim"
}, {
"map": "Activity.location",
"identity": "w3c.prov"
}, {
"map": "Provenance.location",
"identity": "fhirprovenance"
} ],
"definition": "Where the event occurred."
}, {
"id": "AuditEvent.agent.policy",
"path": "AuditEvent.agent.policy",
"type": [ {
"code": "uri"
} ],
"short": "Policy that authorized event",
"comment": "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.",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ActPolicyType",
"identity": "rim"
}, {
"map": "ParticipantRoleIDCode",
"identity": "dicom"
}, {
"map": "Provenance.policy",
"identity": "fhirprovenance"
} ],
"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.",
"requirements": "This value is used retrospectively to determine the authorization policies."
}, {
"path": "AuditEvent.agent.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).",
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"short": "Type of media",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": ".player.description.mediaType",
"identity": "rim"
}, {
"map": "MediaType",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/dicm-405-mediatype",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DICOMMediaType"
} ],
"description": "Used when the event is about exporting/importing onto media."
},
"max": "1",
"id": "AuditEvent.agent.media"
}, {
"id": "AuditEvent.agent.network",
"max": "1",
"path": "AuditEvent.agent.network",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Logical network location for application activity",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": ".player.description.reference",
"identity": "rim"
} ],
"definition": "Logical network location for application activity, if the activity has a network location."
}, {
"path": "AuditEvent.agent.network.address",
"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.",
"definition": "An identifier for the network access point of the user device for the audit event.",
"short": "Identifier for the network access point of the user device",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": "pre-coordinated into URL",
"identity": "rim"
}, {
"map": "NetworkAccessPointID",
"identity": "dicom"
}, {
"map": "Agent.Location",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.agent.network.address",
"comment": "This could be a device id, IP address or some other identifier associated with a device."
}, {
"path": "AuditEvent.agent.network.type",
"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.",
"definition": "An identifier for the type of network access point that originated the audit event.",
"short": "The type of network access point",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": "pre-coordinated into URL",
"identity": "rim"
}, {
"map": "NetworkAccessPointTypeCode",
"identity": "dicom"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/network-type|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventAgentNetworkType"
} ],
"description": "The type of network access point of this agent in the audit event."
},
"max": "1",
"id": "AuditEvent.agent.network.type"
}, {
"id": "AuditEvent.agent.purposeOfUse",
"path": "AuditEvent.agent.purposeOfUse",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Reason given for this user",
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditPurposeOfUse"
} ],
"description": "The reason the activity took place."
},
"comment": "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.",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse\n(2.16.840.1.113883.1.11.20448)\n* .outboundRelationship[typeCode=RSON or SUBJ].target",
"identity": "rim"
}, {
"map": "Agent.Activity",
"identity": "w3c.prov"
} ],
"definition": "The reason (purpose of use), specific to this agent, that was used during the event being recorded."
}, {
"path": "AuditEvent.source",
"requirements": "The event is reported by one source.",
"min": 1,
"definition": "The system that is reporting the event.",
"short": "Audit Event Reporter",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]",
"identity": "rim"
}, {
"map": "AuditSourceIdentification",
"identity": "dicom"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "AuditEvent.source",
"comment": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified."
}, {
"id": "AuditEvent.source.site",
"max": "1",
"path": "AuditEvent.source.site",
"type": [ {
"code": "string"
} ],
"short": "Logical source location within the enterprise",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".scopedRole[classCode=LOCE].player.desc",
"identity": "rim"
}, {
"map": "AuditEnterpriseSiteId",
"identity": "dicom"
} ],
"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."
}, {
"path": "AuditEvent.source.observer",
"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,
"definition": "Identifier of the source where the event was detected.",
"short": "The identity of source detecting the event",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "AuditSourceId",
"identity": "dicom"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"alias": [ "SourceId" ],
"max": "1",
"id": "AuditEvent.source.observer",
"isSummary": true
}, {
"id": "AuditEvent.source.type",
"path": "AuditEvent.source.type",
"type": [ {
"code": "Coding"
} ],
"short": "The type of source where event originated",
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-source-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSourceType"
} ],
"description": "Code specifying the type of system that detected and recorded the event."
},
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "AuditSourceTypeCode",
"identity": "dicom"
} ],
"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."
}, {
"constraint": [ {
"key": "sev-1",
"human": "Either a name or a query (NOT both)",
"xpath": "not(exists(f:name)) or not(exists(f:query))",
"source": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"severity": "error",
"expression": "name.empty() or query.empty()"
} ],
"path": "AuditEvent.entity",
"requirements": "The event may have other entities involved.",
"definition": "Specific instances of data or objects that have been accessed.",
"short": "Data or objects used",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role",
"identity": "rim"
}, {
"map": "ParticipantObjectIdentification",
"identity": "dicom"
}, {
"map": "Entity",
"identity": "w3c.prov"
}, {
"map": "Provenance.target, Provenance.entity",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"alias": [ "ParticipantObject" ],
"id": "AuditEvent.entity",
"comment": "Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values."
}, {
"id": "AuditEvent.entity.what",
"max": "1",
"path": "AuditEvent.entity.what",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "Specific instance of resource",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "ParticipantObjectID and ParticipantObjectIDTypeCode",
"identity": "dicom"
}, {
"map": "Provenance.target, Provenance.entity.what",
"identity": "fhirprovenance"
} ],
"isSummary": true,
"definition": "Identifies a specific instance of the entity. The reference should be version specific."
}, {
"path": "AuditEvent.entity.type",
"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.",
"definition": "The type of the object that was involved in this audit event.",
"short": "Type of entity involved",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "[self::Act].code or role.player.code",
"identity": "rim"
}, {
"map": "ParticipantObjectTypeCode",
"identity": "dicom"
}, {
"map": "Entity.type",
"identity": "w3c.prov"
}, {
"map": "Provenance.entity.type",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-entity-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityType"
} ],
"description": "Code for the entity type involved in the audit event."
},
"max": "1",
"id": "AuditEvent.entity.type",
"comment": "This value is distinct from the user's role or any user relationship to the entity."
}, {
"path": "AuditEvent.entity.role",
"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.",
"definition": "Code representing the role the entity played in the event being audited.",
"short": "What role the entity played",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "role.code (not sure what this would mean for an Act)",
"identity": "rim"
}, {
"map": "ParticipantObjectTypeCodeRole",
"identity": "dicom"
}, {
"map": "Entity.role",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/object-role",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityRole"
} ],
"description": "Code representing the role the entity played in the audit event."
},
"max": "1",
"id": "AuditEvent.entity.role"
}, {
"path": "AuditEvent.entity.lifecycle",
"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.",
"definition": "Identifier for the data life-cycle stage for the entity.",
"short": "Life-cycle stage for the entity",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "target of ObservationEvent[code=\"lifecycle\"].value",
"identity": "rim"
}, {
"map": "ParticipantObjectDataLifeCycle",
"identity": "dicom"
}, {
"map": "Entity.role",
"identity": "w3c.prov"
}, {
"map": "Provenance.entity.role",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/object-lifecycle-events",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityLifecycle"
} ],
"description": "Identifier for the data life-cycle stage for the entity."
},
"max": "1",
"id": "AuditEvent.entity.lifecycle",
"comment": "This can be used to provide an audit trail for data, over time, as it passes through the system."
}, {
"path": "AuditEvent.entity.securityLabel",
"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.",
"definition": "Security labels for the identified entity.",
"short": "Security labels on the entity",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": "ParticipantObjectSensitivity",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/security-labels",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System."
},
"id": "AuditEvent.entity.securityLabel",
"comment": "Copied from entity meta security tags."
}, {
"path": "AuditEvent.entity.name",
"requirements": "Use only where entity can't be identified with an identifier.",
"definition": "A name of the entity in the audit event.",
"short": "Descriptor for entity",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".title",
"identity": "rim"
}, {
"map": "ParticipantObjectName",
"identity": "dicom"
}, {
"map": "Entity.Label",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.entity.name",
"condition": [ "sev-1" ],
"comment": "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.",
"isSummary": true
}, {
"id": "AuditEvent.entity.description",
"max": "1",
"path": "AuditEvent.entity.description",
"type": [ {
"code": "string"
} ],
"short": "Descriptive text",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".text",
"identity": "rim"
}, {
"map": "ParticipantObjectDescription",
"identity": "dicom"
} ],
"definition": "Text that describes the entity in more detail.",
"requirements": "Use only where entity can't be identified with an identifier."
}, {
"path": "AuditEvent.entity.query",
"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.",
"definition": "The query parameters for a query-type entities.",
"short": "Query parameters",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "No mapping",
"identity": "rim"
}, {
"map": "ParticipantObjectQuery",
"identity": "dicom"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "AuditEvent.entity.query",
"condition": [ "sev-1" ],
"comment": "The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.",
"isSummary": true
}, {
"id": "AuditEvent.entity.detail",
"path": "AuditEvent.entity.detail",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Additional Information about the entity",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail",
"identity": "dicom"
} ],
"definition": "Tagged value pairs for conveying additional information about the entity.",
"requirements": "Implementation-defined data about specific details of the object accessed or used."
}, {
"id": "AuditEvent.entity.detail.type",
"max": "1",
"min": 1,
"path": "AuditEvent.entity.detail.type",
"type": [ {
"code": "string"
} ],
"short": "Name of the property",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.type",
"identity": "dicom"
} ],
"definition": "The type of extra detail provided in the value."
}, {
"path": "AuditEvent.entity.detail.value[x]",
"requirements": "Should not duplicate the entity value unless absolutely necessary.",
"min": 1,
"definition": "The value of the extra detail.",
"short": "Property value",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".value",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.value",
"identity": "dicom"
} ],
"type": [ {
"code": "string"
}, {
"code": "base64Binary"
} ],
"max": "1",
"id": "AuditEvent.entity.detail.value[x]",
"comment": "The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/secure/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}