{ "resourceType": "StructureDefinition", "id": "ehrsrle-auditevent", "text": { "status": "generated", "div": "

The narrative has been removed to reduce the size of the distribution of the Hl7.Fhir.Specification library

" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "ehr" } ], "url": "http://hl7.org/fhir/StructureDefinition/ehrsrle-auditevent", "name": "EHRS FM Record Lifecycle Event - Audit Event", "status": "draft", "experimental": false, "publisher": "Health Level Seven International (Electronic Health Record)", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/special/committees/ehr.html" } ] } ], "description": "Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard", "fhirVersion": "3.0.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/AuditEvent", "derivation": "constraint", "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.", "comment": "Based on ATNA (RFC 3881).", "min": 0, "max": "*", "base": { "path": "Resource", "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)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "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)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "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))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "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))]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "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.", "comment": "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": "1" }, "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": "1" }, "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.", "comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "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.", "comment": "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": "1" }, "type": [ { "code": "code" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" } ], "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.", "comment": "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": "1" }, "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.", "comment": "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": "Entity. Role, or Act" }, { "identity": "rim", "map": "N/A" } ] }, { "id": "AuditEvent.extension", "path": "AuditEvent.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "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.", "comment": "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", "base": { "path": "AuditEvent.type", "min": 1, "max": "1" }, "type": [ { "code": "Coding" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AuditEventType" } ], "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": "*", "base": { "path": "AuditEvent.subtype", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AuditEventSubType" } ], "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", "base": { "path": "AuditEvent.action", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AuditEventAction" } ], "strength": "required", "description": "Indicator for type of action performed during the event that generated the event", "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.", "comment": "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", "base": { "path": "AuditEvent.recorded", "min": 1, "max": "1" }, "type": [ { "code": "instant" } ], "mustSupport": true, "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.", "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.", "min": 0, "max": "1", "base": { "path": "AuditEvent.outcome", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AuditEventOutcome" } ], "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", "base": { "path": "AuditEvent.outcomeDesc", "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.", "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.", "min": 0, "max": "*", "base": { "path": "AuditEvent.purposeOfEvent", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AuditPurposeOfUse" } ], "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.", "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.", "requirements": "An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.", "alias": [ "ActiveParticipant" ], "min": 1, "max": "*", "base": { "path": "AuditEvent.agent", "min": 1, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "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.source", "path": "AuditEvent.source", "short": "Audit Event Reporter", "definition": "The system that is reporting the event.", "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.", "requirements": "The event is reported by one source.", "min": 1, "max": "1", "base": { "path": "AuditEvent.source", "min": 1, "max": "1" }, "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "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.entity", "path": "AuditEvent.entity", "short": "Data or objects used", "definition": "Specific instances of data or objects that have been accessed.", "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.", "requirements": "The event may have other entities involved.", "alias": [ "ParticipantObject" ], "min": 0, "max": "*", "base": { "path": "AuditEvent.entity", "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))", "source": "http://hl7.org/fhir/StructureDefinition/AuditEvent" } ], "mustSupport": true, "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" } ] } ] }, "differential": { "element": [ { "id": "AuditEvent", "path": "AuditEvent", "min": 0, "max": "*" }, { "id": "AuditEvent.type", "path": "AuditEvent.type", "mustSupport": true }, { "id": "AuditEvent.subtype", "path": "AuditEvent.subtype", "mustSupport": true }, { "id": "AuditEvent.action", "path": "AuditEvent.action", "mustSupport": true }, { "id": "AuditEvent.recorded", "path": "AuditEvent.recorded", "mustSupport": true }, { "id": "AuditEvent.purposeOfEvent", "path": "AuditEvent.purposeOfEvent", "mustSupport": true }, { "id": "AuditEvent.agent", "path": "AuditEvent.agent", "mustSupport": true }, { "id": "AuditEvent.agent.role", "path": "AuditEvent.agent.role", "mustSupport": true }, { "id": "AuditEvent.agent.reference", "path": "AuditEvent.agent.reference", "mustSupport": true }, { "id": "AuditEvent.agent.userId", "path": "AuditEvent.agent.userId", "mustSupport": true }, { "id": "AuditEvent.agent.requestor", "path": "AuditEvent.agent.requestor", "mustSupport": true }, { "id": "AuditEvent.agent.location", "path": "AuditEvent.agent.location", "mustSupport": true }, { "id": "AuditEvent.agent.policy", "path": "AuditEvent.agent.policy", "mustSupport": true }, { "id": "AuditEvent.agent.network", "path": "AuditEvent.agent.network", "mustSupport": true }, { "id": "AuditEvent.agent.network.address", "path": "AuditEvent.agent.network.address", "mustSupport": true }, { "id": "AuditEvent.agent.network.type", "path": "AuditEvent.agent.network.type", "mustSupport": true }, { "id": "AuditEvent.agent.purposeOfUse", "path": "AuditEvent.agent.purposeOfUse", "mustSupport": true }, { "id": "AuditEvent.source", "path": "AuditEvent.source", "mustSupport": true }, { "id": "AuditEvent.source.site", "path": "AuditEvent.source.site", "mustSupport": true }, { "id": "AuditEvent.source.identifier", "path": "AuditEvent.source.identifier", "mustSupport": true }, { "id": "AuditEvent.source.type", "path": "AuditEvent.source.type", "mustSupport": true }, { "id": "AuditEvent.entity", "path": "AuditEvent.entity", "mustSupport": true }, { "id": "AuditEvent.entity.identifier", "path": "AuditEvent.entity.identifier", "mustSupport": true }, { "id": "AuditEvent.entity.reference", "path": "AuditEvent.entity.reference", "mustSupport": true }, { "id": "AuditEvent.entity.type", "path": "AuditEvent.entity.type", "mustSupport": true }, { "id": "AuditEvent.entity.role", "path": "AuditEvent.entity.role", "mustSupport": true }, { "id": "AuditEvent.entity.lifecycle", "path": "AuditEvent.entity.lifecycle", "mustSupport": true }, { "id": "AuditEvent.entity.securityLabel", "path": "AuditEvent.entity.securityLabel", "mustSupport": true } ] } }