{
"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",
"_filename": "StructureDefinition-ehrsrle-auditevent.json",
"package_name": "hl7.fhir.uv.ehrs-rle",
"date": "2023-03-29T18:56:02+00:00",
"derivation": "constraint",
"publisher": "Health Level Seven International - Electronic Health Record Work Group",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "EHRSFunctionalModelRecordLifecycleEventsAuditEvent",
"mapping": [ {
"uri": "http://hl7.org/ehrs/ImplementationGuide/EHRSFMR2.1",
"name": "EHRS-FM R2.1",
"identity": "ehrsfm"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping",
"identity": "dicom"
}, {
"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": "false",
"resourceType": "StructureDefinition",
"title": "EHRS Functional Model - Record Lifecycle Events - AuditEvent",
"package_version": "1.1.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/ehrs-rle/ImplementationGuide/ehrs-rle"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/ehrs-rle/ImplementationGuide/ehrs-rle"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "AuditEvent",
"min": 0,
"definition": "A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.",
"isModifier": false,
"short": "Record of an event",
"mapping": [ {
"map": "Entity, Role, or Act,ControlAct[moodCode=EVN]",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "infrastructure.information",
"identity": "w5"
}, {
"map": "Message",
"identity": "dicom"
} ],
"mustSupport": false,
"max": "*",
"id": "AuditEvent",
"comment": "Based on IHE-ATNA.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent"
},
"isSummary": false
}, {
"path": "AuditEvent.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.implicitRules",
"min": 0,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.implicitRules",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "AuditEvent.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "AuditEvent.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "AuditEvent.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "AuditEvent.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.category",
"requirements": "Codes that classify the general type of event that happened.",
"min": 0,
"definition": "Classification of the type of event.",
"isModifier": false,
"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": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventType"
} ],
"description": "Type of event."
},
"alias": [ "type" ],
"max": "*",
"id": "AuditEvent.category",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.category"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.code",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 1,
"definition": "Describes what happened. The most specific code for the event.",
"isModifier": false,
"short": "Specific type of 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"
}, {
"map": "Provenance.activity",
"identity": "fhirprovenance"
}, {
"map": "TI.2.1.2.1#05",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-sub-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSubType"
} ],
"description": "Specific type of event."
},
"alias": [ "subtype" ],
"max": "1",
"id": "AuditEvent.code",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.action",
"requirements": "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min": 0,
"definition": "Indicator for type of action performed during the event that generated the audit.",
"isModifier": false,
"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"
}, {
"map": "TI.2.1.2.1#05",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-action|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Indicator for type of action performed during the event that generated the event."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventAction"
} ],
"description": "DICOM Audit Event Action"
},
"max": "1",
"id": "AuditEvent.action",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.action"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.severity",
"min": 0,
"definition": "Indicates and enables segmentation of various severity including debugging from critical.",
"isModifier": false,
"short": "emergency | alert | critical | error | warning | notice | informational | debug",
"mapping": [ {
"map": "N/A",
"identity": "rim"
}, {
"map": "PRI",
"identity": "dicom"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-severity|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "The severity of the audit entry."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSeverity"
} ],
"description": "This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3"
},
"max": "1",
"id": "AuditEvent.severity",
"comment": "ATNA will map this to the SYSLOG PRI element.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.severity"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.occurred[x]",
"min": 0,
"definition": "The time or period during which the activity occurred.",
"isModifier": false,
"short": "When the activity occurred",
"mapping": [ {
"map": "Event.occurrence",
"identity": "workflow"
}, {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "./effectiveTime[type=IVL_TS]",
"identity": "rim"
}, {
"map": "Activity.startTime & Activity.endTime",
"identity": "w3c.prov"
}, {
"map": "Provenance.occurred[x]",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "Period"
}, {
"code": "dateTime"
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.occurred[x]",
"comment": "The time or period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.occurred[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Time when the event was recorded",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "EventDateTime",
"identity": "dicom"
}, {
"map": "Activity.when",
"identity": "w3c.prov"
}, {
"map": "Provenance.recorded",
"identity": "fhirprovenance"
}, {
"map": "TI.2.1.2.1#06",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "instant"
} ],
"mustSupport": true,
"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.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.recorded"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.outcome",
"requirements": "when a code is given there must be one code from the given codeSystem, and may be other equivilant codes from other codeSystems (for example http response codes such as 2xx, 4xx, or 5xx).",
"min": 0,
"definition": "Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.",
"isModifier": false,
"short": "Whether the event succeeded or failed",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=OUT].target.text",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"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.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.outcome"
},
"isSummary": true
}, {
"path": "AuditEvent.outcome.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.outcome.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.outcome.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.outcome.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.outcome.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.outcome.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.outcome.code",
"requirements": "when a code is given there must be one code from the given codeSystem.",
"min": 1,
"definition": "Indicates whether the event succeeded or failed.",
"isModifier": false,
"short": "Whether the event succeeded or failed",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=OUT].target.text",
"identity": "rim"
}, {
"map": "EventOutcomeIndicator EventOutcomeIndicator",
"identity": "dicom"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-outcome",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Indicates whether the event succeeded or failed."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventOutcome"
} ],
"description": "DICOM Audit Event Outcome"
},
"max": "1",
"id": "AuditEvent.outcome.code",
"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.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.outcome.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.outcome.detail",
"min": 0,
"definition": "Additional details about the error. This may be a text description of the error or a system code that identifies the error.",
"isModifier": false,
"short": "Additional outcome detail",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".outboundRelationship[typeCode=OUT].target.text",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-outcome-detail",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventOutcomeDetail"
} ],
"description": "A code that provides details as the exact issue."
},
"max": "*",
"id": "AuditEvent.outcome.detail",
"comment": "A human readable description of the error issue SHOULD be placed in details.text.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.outcome.detail"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.authorization",
"requirements": "Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.",
"min": 0,
"definition": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"isModifier": false,
"short": "Authorization related to the event",
"mapping": [ {
"map": "Event.reason",
"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.authorization",
"identity": "fhirprovenance"
}, {
"map": "TI.2.1.2.1#08",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-PurposeOfUse",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditPurposeOfUse"
} ],
"description": "The authorized purposeOfUse for the activity."
},
"alias": [ "PurposeOfEvent" ],
"max": "*",
"id": "AuditEvent.authorization",
"comment": "Use AuditEvent.agent.authorization when you know that it is specific to the agent, otherwise use AuditEvent.authorization. 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.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.authorization"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.basedOn",
"min": 0,
"definition": "Allows tracing of authorizatino for the events and tracking whether proposals/recommendations were acted upon.",
"isModifier": false,
"short": "Workflow authorization within which this event occurred",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "Act.code",
"identity": "rim"
}, {
"map": "Activity.Activity",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/DeviceRequest", "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation", "http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "http://hl7.org/fhir/StructureDefinition/Task" ]
} ],
"mustSupport": false,
"max": "*",
"id": "AuditEvent.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.basedOn"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.patient",
"requirements": "When the .patient is populated it shall be accurate to the subject of the used data. The .patient shall not be populated when the used data used/created/updated/deleted (.entity) by the activity does not involve a subject. Note that when the patient is an agent, they will be recorded as an agent. When the Patient resource is Created, Updated, or Deleted it will be recorded as an entity.",
"min": 0,
"definition": "The patient element is available to enable deterministic tracking of activities that involve the patient as the subject of the data used in an activity.",
"isModifier": false,
"short": "The patient is the subject of the data used/created/updated/deleted during the activity",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "participation[typeCode=RTGT]",
"identity": "rim"
}, {
"map": "Entity.Identity",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ]
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "1",
"id": "AuditEvent.patient",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.patient"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.encounter",
"min": 0,
"definition": "This will typically be the encounter the event occurred, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission lab tests).",
"isModifier": false,
"short": "Encounter within which this event occurred or which the event is tightly associated",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "Act.code",
"identity": "rim"
}, {
"map": "Activity.Activity",
"identity": "w3c.prov"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.encounter",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.encounter"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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"
} ],
"mustSupport": true,
"alias": [ "ActiveParticipant" ],
"max": "*",
"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. \n\nWhen a network are used in an event being recorded, there should be distinct agent elements for the known actors using the network. The agent with a network detail would be the responsible agent for use of that network.",
"base": {
"max": "*",
"min": 1,
"path": "AuditEvent.agent"
},
"isSummary": true
}, {
"path": "AuditEvent.agent.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.agent.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.agent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.agent.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.agent.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.agent.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.type",
"requirements": "Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. This element will hold the functional role that the agent played in the activity that is the focus of this Provenance. Where an agent played multiple functional roles, they will be listed as multiple .agent elements representing each functional participation. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models.",
"min": 0,
"definition": "The Functional Role of the user when performing the event.",
"isModifier": false,
"short": "How agent participated",
"mapping": [ {
"map": "Event.performer.function",
"identity": "workflow"
}, {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".typeCode and/or .functionCode",
"identity": "rim"
}, {
"map": "prime RoleIdCode",
"identity": "dicom"
}, {
"map": "Agent.Attribution",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.type",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/participation-role-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditAgentType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The Participation type of the agent to the event."
},
"max": "1",
"id": "AuditEvent.agent.type",
"comment": "For example: assembler, author, prescriber, signer, investigator, etc.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.role",
"requirements": "Structural roles reflect the structural aspects of relationships between entities. Structural roles describe prerequisites, feasibilities, or competences for acts. Functional roles reflect functional aspects of relationships between entities. Functional roles are bound to the realization/performance of acts, where actions might be concatenated to an activity or even to a process. See ISO 21298:2018 - Health Informatics - Functional and structural roles, and ISO 22600-2:2014 - Health Informatics - Privilege Management and Access Control - Part 2: formal models..",
"min": 0,
"definition": "The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.",
"isModifier": false,
"short": "Agent role in the event",
"mapping": [ {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".role",
"identity": "rim"
}, {
"map": "all RoleIdCode",
"identity": "dicom"
}, {
"map": "Agent.Attribution",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.role",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/security-role-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditAgentRole"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "What security role enabled the agent to participate in the event."
},
"max": "*",
"id": "AuditEvent.agent.role",
"comment": "For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.agent.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.who",
"requirements": "This field ties an audit event to a specific resource or identifier.",
"min": 1,
"definition": "Reference to who this agent is that was involved in the event.",
"isModifier": false,
"short": "Identifier of who",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": "FiveWs.who",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "UserName and UserId",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.who",
"identity": "fhirprovenance"
}, {
"map": "TI.2.1.2.1#02 (Organization), TI.2.1.2.1#03 (Practitioner), TI.2.1.2.1#04 (Device)",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": true,
"alias": [ "userId" ],
"max": "1",
"id": "AuditEvent.agent.who",
"comment": "Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.agent.who"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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": 0,
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"isModifier": false,
"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"
} ],
"mustSupport": true,
"meaningWhenMissing": "false",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.requestor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.location",
"min": 0,
"definition": "Where the agent location is known, the agent location when the event occurred.",
"isModifier": false,
"short": "The agent location when the event occurred",
"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"
}, {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.agent.location",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.location"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.policy",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"definition": "Where the policy(ies) are known that authorized the agent participation in the event. 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.",
"isModifier": false,
"short": "Policy that authorized the agent participation in the event",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ActPolicyType",
"identity": "rim"
}, {
"map": "ParticipantRoleIDCode",
"identity": "dicom"
}, {
"map": "Provenance.policy",
"identity": "fhirprovenance"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "*",
"id": "AuditEvent.agent.policy",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.agent.policy"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.network[x]",
"requirements": "When a network protocol is used the endpoint is associated with the agent most directly using the endpoint. This is usually the software agent that has implemented the application level protocol. Preference is to define network in terms of a Reference(Endpoint), or URI; use string only when address or hostname is all that is known. When encoding using string it is best to encode using the formal canonical host name, but if you can't, then you can encode numeric in Literal address form using square brackets '[]' as a v4 string (in dotted notation), or v6 string (in colon notation).",
"min": 0,
"definition": "When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.",
"isModifier": false,
"short": "This agent network location for the activity",
"mapping": [ {
"map": "FiveWs.where[x]",
"identity": "w5"
}, {
"map": ".player.description",
"identity": "rim"
}, {
"map": "NetworkAccessPointID and NetworkAccessPointTypeCode",
"identity": "dicom"
}, {
"map": "Agent.Location",
"identity": "w3c.prov"
}, {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
},
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Endpoint" ]
}, {
"code": "uri"
}, {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.agent.network[x]",
"comment": "When remote network endpoint is known, another agent representing the remote agent would indicate the remote network endpoint used. Convention is to indicate data flowing from Source to Destination. The convention for Search, given data flows both ways (query parameters vs results), is to have the Source as the initiator of the Search Transaction, and the Destination the responder to the Search transaction.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.network[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.authorization",
"requirements": "Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags.",
"min": 0,
"definition": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"isModifier": false,
"short": "Allowable authorization for this agent",
"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"
}, {
"map": "TI.2.1.2#01",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"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."
},
"alias": [ "PurposeOfUse" ],
"max": "*",
"id": "AuditEvent.agent.authorization",
"comment": "Use AuditEvent.agent.authorization when you know that is specific to the agent, otherwise use AuditEvent.authorization. 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.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.agent.authorization"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.source",
"requirements": "The event is reported by one source.",
"min": 1,
"definition": "The actor that is reporting the event.",
"isModifier": false,
"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"
}, {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.source",
"comment": "Events are reported by the actor that detected them. This may be one of the participating actors, but may also be different. The actor may be a human such as a medical-records clerk disclosing data manually, that clerk would be the source for the record of disclosure.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.source"
},
"isSummary": true
}, {
"path": "AuditEvent.source.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.source.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.source.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.source.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.source.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.source.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.source.site",
"requirements": "This value differentiates among the sites in a multi-site enterprise health information system.",
"min": 0,
"definition": "Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.",
"isModifier": false,
"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"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.source.site",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.source.site"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"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/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ]
} ],
"mustSupport": false,
"alias": [ "SourceId" ],
"max": "1",
"id": "AuditEvent.source.observer",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.source.observer"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.source.type",
"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,
"definition": "Code specifying the type of source where event originated.",
"isModifier": false,
"short": "The type of source where event originated",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "AuditSourceTypeCode",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/security-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. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema."
},
"max": "*",
"id": "AuditEvent.source.type",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.source.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.entity",
"requirements": "The event may have other entities involved.",
"min": 0,
"definition": "Specific instances of data or objects that have been accessed.",
"isModifier": false,
"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"
} ],
"mustSupport": true,
"alias": [ "ParticipantObject" ],
"max": "*",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.entity.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.entity.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.entity.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.entity.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.entity.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.entity.what",
"min": 0,
"definition": "Identifies a specific instance of the entity. The reference should be version specific. This is allowed to be a Parameters resource.",
"isModifier": false,
"short": "Specific instance of resource",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "ParticipantObjectTypeCode, ParticipantObjectName, ParticipantObjectID and ParticipantObjectIDTypeCode",
"identity": "dicom"
}, {
"map": "Provenance.target, Provenance.entity.what",
"identity": "fhirprovenance"
}, {
"map": "TI.2.1.1#02, TI.2.1.2.9#09",
"identity": "ehrsfm"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.entity.what",
"comment": "Use .what.display when all you have is a string (e.g. ParticipantObjectName).",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.what"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"min": 0,
"definition": "Code representing the role the entity played in the event being audited.",
"isModifier": false,
"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": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/object-role",
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueString": "Code representing the role the entity played in the audit event."
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityRole"
} ],
"description": "DICOM Audit Event Entity Role"
},
"max": "1",
"id": "AuditEvent.entity.role",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.role"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"min": 0,
"definition": "Security labels for the identified entity.",
"isModifier": false,
"short": "Security labels on the entity",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": "ParticipantObjectSensitivity",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/security-label-examples",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Example Security Labels from the Healthcare Privacy and Security Classification System."
},
"max": "*",
"id": "AuditEvent.entity.securityLabel",
"comment": "Copied from entity meta security tags.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity.securityLabel"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"min": 0,
"definition": "The query parameters for a query-type entities.",
"isModifier": false,
"short": "Query parameters",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": "No mapping",
"identity": "rim"
}, {
"map": "ParticipantObjectQuery",
"identity": "dicom"
} ],
"type": [ {
"code": "base64Binary"
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.entity.query",
"comment": "The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, 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.\n\nThe DICOM AuditMessage schema does not support both .name and .query being populated.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.query"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.entity.detail",
"requirements": "Implementation-defined data about specific details of the object accessed or used.",
"min": 0,
"definition": "Tagged value pairs for conveying additional information about the entity.",
"isModifier": false,
"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"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "AuditEvent.entity.detail",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity.detail"
},
"isSummary": false
}, {
"path": "AuditEvent.entity.detail.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.entity.detail.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.entity.detail.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.entity.detail.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "AuditEvent.entity.detail.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.entity.detail.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.entity.detail.type",
"min": 1,
"definition": "The type of extra detail provided in the value.",
"isModifier": false,
"short": "Name of the property",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.type",
"identity": "dicom"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/audit-event-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventDetailType"
} ],
"description": "Additional detail about an entity used in an event."
},
"max": "1",
"id": "AuditEvent.entity.detail.type",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.entity.detail.type"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"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.",
"isModifier": false,
"short": "Property value",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
}, {
"map": ".value",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.value",
"identity": "dicom"
} ],
"type": [ {
"code": "Quantity"
}, {
"code": "CodeableConcept"
}, {
"code": "string"
}, {
"code": "boolean"
}, {
"code": "integer"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "time"
}, {
"code": "dateTime"
}, {
"code": "Period"
}, {
"code": "base64Binary"
} ],
"mustSupport": false,
"max": "1",
"id": "AuditEvent.entity.detail.value[x]",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.entity.detail.value[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "AuditEvent.entity.agent",
"min": 0,
"definition": "The entity is attributed to an agent to express the agent's responsibility for that entity in the activity. This is most used to indicate when persistence media (the entity) are used by an agent. For example when importing data from a device, the device would be described in an entity, and the user importing data from that media would be indicated as the entity.agent.",
"isModifier": false,
"short": "Entity is attributed to this agent",
"mapping": [ {
"map": "./author/role",
"identity": "rim"
}, {
"map": "ActiveParticipant.MediaType",
"identity": "dicom"
}, {
"map": "Provenance.entity.agent",
"identity": "fhirprovenance"
} ],
"contentReference": "http://hl7.org/fhir/StructureDefinition/AuditEvent#AuditEvent.agent",
"mustSupport": false,
"max": "*",
"id": "AuditEvent.entity.agent",
"comment": "A usecase where one AuditEvent.entity.agent is used where the Entity that was used in the creation/updating of a target resource, is not in the context of the same custodianship as the target resource, and thus the meaning of AuditEvent.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 V2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the provenance of that Entity's use in the context of this AuditEvent activity.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity.agent"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "99d9a3aa-dcd5-4301-8d4f-9aac0d315b34",
"kind": "resource",
"url": "http://hl7.org/fhir/uv/ehrs-rle/StructureDefinition/ehrsrle-auditevent",
"version": "1.1.0-ballot",
"differential": {
"element": [ {
"id": "AuditEvent",
"path": "AuditEvent"
}, {
"id": "AuditEvent.category",
"path": "AuditEvent.category",
"mustSupport": true
}, {
"id": "AuditEvent.code",
"path": "AuditEvent.code",
"mapping": [ {
"map": "TI.2.1.2.1#05",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.action",
"path": "AuditEvent.action",
"mapping": [ {
"map": "TI.2.1.2.1#05",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.recorded",
"path": "AuditEvent.recorded",
"mapping": [ {
"map": "TI.2.1.2.1#06",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.authorization",
"path": "AuditEvent.authorization",
"mapping": [ {
"map": "TI.2.1.2.1#08",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent",
"path": "AuditEvent.agent",
"mustSupport": true
}, {
"id": "AuditEvent.agent.who",
"path": "AuditEvent.agent.who",
"mapping": [ {
"map": "TI.2.1.2.1#02 (Organization), TI.2.1.2.1#03 (Practitioner), TI.2.1.2.1#04 (Device)",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent.requestor",
"path": "AuditEvent.agent.requestor",
"mustSupport": true
}, {
"id": "AuditEvent.agent.location",
"path": "AuditEvent.agent.location",
"mapping": [ {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent.network",
"path": "AuditEvent.agent.network",
"mapping": [ {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.agent.authorization",
"path": "AuditEvent.agent.authorization",
"mapping": [ {
"map": "TI.2.1.2#01",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.source",
"path": "AuditEvent.source",
"mapping": [ {
"map": "TI.2.1.2.1#07",
"identity": "ehrsfm"
} ],
"mustSupport": true
}, {
"id": "AuditEvent.entity",
"path": "AuditEvent.entity",
"mustSupport": true
}, {
"id": "AuditEvent.entity.what",
"path": "AuditEvent.entity.what",
"mapping": [ {
"map": "TI.2.1.1#02, TI.2.1.2.9#09",
"identity": "ehrsfm"
} ],
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/ehr",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent"
}