{
"description": "AuditEvent",
"_filename": "StructureDefinition-AuditEvent.json",
"package_name": "hl7.fhir.nl.zorgviewer",
"date": "2025-04-01T10:39:46+00:00",
"derivation": "constraint",
"publisher": "RIVO-NN HL7NL",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "NL",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "AuditEvent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://nema.org/dicom",
"name": "DICOM Tag Mapping",
"identity": "dicom"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV",
"identity": "w3c.prov"
}, {
"uri": "http://hl7.org/fhir/provenance",
"name": "FHIR Provenance",
"identity": "fhirprovenance"
} ],
"abstract": false,
"type": "AuditEvent",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "AuditEvent",
"package_version": "1.13.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "AuditEvent",
"min": 0,
"definition": "A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.",
"short": "Event record kept for security purposes",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "ControlAct[moodCode=EVN]",
"identity": "rim"
}, {
"map": "Message",
"identity": "dicom"
}, {
"map": "infrastructure.information",
"identity": "w5"
} ],
"max": "*",
"id": "AuditEvent",
"comment": "Based on ATNA (RFC 3881).",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent"
}
}, {
"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.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "AuditEvent.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "AuditEvent.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "AuditEvent.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "AuditEvent.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"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"
}
}, {
"path": "AuditEvent.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "AuditEvent.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"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, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "AuditEvent.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "AuditEvent.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "AuditEvent.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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"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"
}
}, {
"path": "AuditEvent.type",
"requirements": "This identifies the performed function. For \"Execute\" Event Action Code audit records, this identifies the application function performed.",
"min": 1,
"definition": "Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.",
"short": "Type/identifier of event",
"mapping": [ {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventId",
"identity": "dicom"
}, {
"map": "Activity",
"identity": "w3c.prov"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventType"
} ],
"description": "Type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-type"
}
},
"max": "1",
"id": "AuditEvent.type",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.type"
},
"isSummary": true
}, {
"path": "AuditEvent.subtype",
"requirements": "This field enables queries of messages by implementation-defined event categories.",
"min": 0,
"definition": "Identifier for the category of event.",
"short": "More specific type/id for the event",
"mapping": [ {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventTypeCode",
"identity": "dicom"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSubType"
} ],
"description": "Sub-type of event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-sub-type"
}
},
"max": "*",
"id": "AuditEvent.subtype",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.subtype"
},
"isSummary": true
}, {
"path": "AuditEvent.action",
"requirements": "This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.",
"min": 0,
"definition": "Indicator for type of action performed during the event that generated the audit.",
"short": "Type of action performed during the event",
"mapping": [ {
"map": ".code (type, subtype and action are pre-coordinated or sent as translations)",
"identity": "rim"
}, {
"map": "EventActionCode",
"identity": "dicom"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventAction"
} ],
"description": "Indicator for type of action performed during the event that generated the event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-action"
}
},
"max": "1",
"id": "AuditEvent.action",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.action"
},
"isSummary": true
}, {
"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 occurred on the source.",
"short": "Time when the event occurred on source",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "EventDateTime",
"identity": "dicom"
}, {
"map": "Activity.when",
"identity": "w3c.prov"
}, {
"map": "Provenance.recorded",
"identity": "fhirprovenance"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"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
}, {
"path": "AuditEvent.outcome",
"min": 0,
"definition": "Indicates whether the event succeeded or failed.",
"short": "Whether the event succeeded or failed",
"mapping": [ {
"map": ".actionNegationInd",
"identity": "rim"
}, {
"map": "EventOutcomeIndicator",
"identity": "dicom"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventOutcome"
} ],
"description": "Indicates whether the event succeeded or failed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-event-outcome"
}
},
"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.outcomeDesc",
"min": 0,
"definition": "A free text description of the outcome of the event.",
"short": "Description of the event outcome",
"mapping": [ {
"map": ".outboundRelationship[typeCode=OUT].target.text",
"identity": "rim"
}, {
"map": "EventOutcomeDescription",
"identity": "dicom"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.outcomeDesc",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.outcomeDesc"
},
"isSummary": true
}, {
"path": "AuditEvent.purposeOfEvent",
"min": 0,
"definition": "The purposeOfUse (reason) that was used during the event being recorded.",
"short": "The purposeOfUse of the event",
"mapping": [ {
"map": "* .reasonCode [ControlActReason when Act.class = CACT Control Act]\n*.outboundRelationship[typeCode=RSON].target",
"identity": "rim"
}, {
"map": "EventPurposeOfUse",
"identity": "dicom"
}, {
"map": "Activity.Activity",
"identity": "w3c.prov"
}, {
"map": "Provenance.reason, Provenance.activity",
"identity": "fhirprovenance"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditPurposeOfUse"
} ],
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"max": "*",
"id": "AuditEvent.purposeOfEvent",
"comment": "Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.purposeOfEvent"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (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.",
"short": "Actor involved in the event",
"mapping": [ {
"map": ".participation",
"identity": "rim"
}, {
"map": "ActiveParticipant",
"identity": "dicom"
}, {
"map": "Agent",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent",
"identity": "fhirprovenance"
}, {
"map": "who",
"identity": "w5"
} ],
"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.",
"base": {
"max": "*",
"min": 1,
"path": "AuditEvent.agent"
}
}, {
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.agent.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "AuditEvent.agent.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"path": "AuditEvent.agent.role",
"requirements": "This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.",
"min": 0,
"definition": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.",
"short": "Agent role in the event",
"mapping": [ {
"map": ".role and/or .typeCode and/or .functionCode",
"identity": "rim"
}, {
"map": "RoleIdCode",
"identity": "dicom"
}, {
"map": "Agent.Attribution",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.role",
"identity": "fhirprovenance"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditAgentRole"
} ],
"description": "What security role enabled the agent to participate in the event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-role-type"
}
},
"max": "*",
"id": "AuditEvent.agent.role",
"comment": "Should be roles relevant to the event. Should not be an exhaustive list of roles.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.agent.role"
}
}, {
"path": "AuditEvent.agent.reference",
"requirements": "This field ties an audit event to a specific resource.",
"min": 0,
"definition": "Direct reference to a resource that identifies the agent.",
"short": "Direct reference to resource",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.actor",
"identity": "fhirprovenance"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
} ],
"max": "1",
"id": "AuditEvent.agent.reference",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.reference"
},
"isSummary": true
}, {
"path": "AuditEvent.agent.userId",
"requirements": "This field ties an audit event to a specific user.",
"min": 0,
"definition": "Unique identifier for the user actively participating in the event.",
"short": "Unique identifier for the user",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "UserId",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "Provenance.agent.userId",
"identity": "fhirprovenance"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.agent.userId",
"comment": "A unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.userId"
},
"isSummary": true
}, {
"path": "AuditEvent.agent.altId",
"requirements": "In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some \"single sign on\" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.",
"min": 0,
"definition": "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.",
"short": "Alternative User id e.g. authentication",
"mapping": [ {
"map": ".id (distinguish id type by root)",
"identity": "rim"
}, {
"map": "AlternativeUserId",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.agent.altId",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.altId"
}
}, {
"path": "AuditEvent.agent.name",
"requirements": "The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.",
"min": 0,
"definition": "Human-meaningful name for the agent.",
"short": "Human-meaningful name for the agent",
"mapping": [ {
"map": ".name",
"identity": "rim"
}, {
"map": "UserName",
"identity": "dicom"
}, {
"map": "Agent.Identity",
"identity": "w3c.prov"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.agent.name",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.name"
}
}, {
"path": "AuditEvent.agent.requestor",
"requirements": "This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.",
"min": 1,
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"short": "Whether user is initiator",
"mapping": [ {
"map": "If participation.typeCode was author, then true",
"identity": "rim"
}, {
"map": "UserIsRequestor",
"identity": "dicom"
}, {
"map": "who",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "AuditEvent.agent.requestor",
"comment": "There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.agent.requestor"
}
}, {
"path": "AuditEvent.agent.location",
"min": 0,
"definition": "Where the event occurred.",
"short": "Where",
"mapping": [ {
"map": "* Role.Class =SDLOC\n*Role.Code = ServiceDeliveryLocationRoleType\n *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC\n*EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place may or may not be constant.",
"identity": "rim"
}, {
"map": "Activity.location",
"identity": "w3c.prov"
}, {
"map": "Provenance.location",
"identity": "fhirprovenance"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
} ],
"max": "1",
"id": "AuditEvent.agent.location",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.location"
}
}, {
"path": "AuditEvent.agent.policy",
"requirements": "This value is used retrospectively to determine the authorization policies.",
"min": 0,
"definition": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.",
"short": "Policy that authorized event",
"fixedUri": "https://rivo-noord.nl/zorgviewer/toestemming",
"mapping": [ {
"map": "ActPolicyType",
"identity": "rim"
}, {
"map": "ParticipantRoleIDCode",
"identity": "dicom"
}, {
"map": "Provenance.policy",
"identity": "fhirprovenance"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"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"
}
}, {
"path": "AuditEvent.agent.media",
"requirements": "Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).",
"min": 0,
"definition": "Type of media involved. Used when the event is about exporting/importing onto media.",
"short": "Type of media",
"mapping": [ {
"map": ".player.description.mediaType",
"identity": "rim"
}, {
"map": "MediaType",
"identity": "dicom"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DICOMMediaType"
} ],
"description": "Used when the event is about exporting/importing onto media.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dicm-405-mediatype"
}
},
"max": "1",
"id": "AuditEvent.agent.media",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.media"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "AuditEvent.agent.network",
"min": 0,
"definition": "Logical network location for application activity, if the activity has a network location.",
"short": "Logical network location for application activity",
"mapping": [ {
"map": ".player.description.reference",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "AuditEvent.agent.network",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.network"
}
}, {
"path": "AuditEvent.agent.network.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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.agent.network.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "AuditEvent.agent.network.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "AuditEvent.agent.network.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"
}
}, {
"path": "AuditEvent.agent.network.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "AuditEvent.agent.network.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"
},
"isSummary": true
}, {
"path": "AuditEvent.agent.network.address",
"requirements": "This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.",
"min": 0,
"definition": "An identifier for the network access point of the user device for the audit event.",
"short": "Identifier for the network access point of the user device",
"mapping": [ {
"map": "pre-coordinated into URL",
"identity": "rim"
}, {
"map": "NetworkAccessPointID",
"identity": "dicom"
}, {
"map": "Agent.Location",
"identity": "w3c.prov"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.agent.network.address",
"comment": "This could be a device id, IP address or some other identifier associated with a device.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.network.address"
}
}, {
"path": "AuditEvent.agent.network.type",
"requirements": "This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.",
"min": 0,
"definition": "An identifier for the type of network access point that originated the audit event.",
"short": "The type of network access point",
"mapping": [ {
"map": "pre-coordinated into URL",
"identity": "rim"
}, {
"map": "NetworkAccessPointTypeCode",
"identity": "dicom"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventAgentNetworkType"
} ],
"description": "The type of network access point of this agent in the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/network-type"
}
},
"max": "1",
"id": "AuditEvent.agent.network.type",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.agent.network.type"
}
}, {
"path": "AuditEvent.agent.purposeOfUse",
"min": 0,
"definition": "The reason (purpose of use), specific to this agent, that was used during the event being recorded.",
"short": "Reason given for this user",
"mapping": [ {
"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": "why",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditPurposeOfUse"
} ],
"description": "The reason the activity took place.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse"
}
},
"max": "*",
"id": "AuditEvent.agent.purposeOfUse",
"comment": "Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.agent.purposeOfUse"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "AuditEvent.source",
"requirements": "The event is reported by one source.",
"min": 1,
"definition": "The system that is reporting the event.",
"short": "Audit Event Reporter",
"mapping": [ {
"map": ".participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]",
"identity": "rim"
}, {
"map": "AuditSourceIdentification",
"identity": "dicom"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "AuditEvent.source",
"comment": "Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.source"
}
}, {
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.source.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "AuditEvent.source.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"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.",
"short": "Logical source location within the enterprise",
"mapping": [ {
"map": ".scopedRole[classCode=LOCE].player.desc",
"identity": "rim"
}, {
"map": "AuditEnterpriseSiteId",
"identity": "dicom"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.source.site",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.source.site"
}
}, {
"path": "AuditEvent.source.identifier",
"requirements": "This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.",
"min": 1,
"definition": "Identifier of the source where the event was detected.",
"short": "The identity of source detecting the event",
"mapping": [ {
"map": ".id",
"identity": "rim"
}, {
"map": "AuditSourceId",
"identity": "dicom"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.source.identifier",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.source.identifier"
},
"isSummary": true
}, {
"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.",
"short": "The type of source where event originated",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "AuditSourceTypeCode",
"identity": "dicom"
}, {
"map": "who.witness",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventSourceType"
} ],
"description": "Code specifying the type of system that detected and recorded the event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-source-type"
}
},
"max": "*",
"id": "AuditEvent.source.type",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.source.type"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "sev-1",
"human": "Either a name or a query (NOT both)",
"xpath": "not(exists(f:name)) or not(exists(f:query))",
"source": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"severity": "error",
"expression": "name.empty() or query.empty()"
} ],
"path": "AuditEvent.entity",
"requirements": "The event may have other entities involved.",
"min": 0,
"definition": "Specific instances of data or objects that have been accessed.",
"short": "Data or objects used",
"mapping": [ {
"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"
}, {
"map": "what",
"identity": "w5"
} ],
"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"
}
}, {
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.entity.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "AuditEvent.entity.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.identifier",
"min": 0,
"definition": "Identifies a specific instance of the entity. The reference should always be version specific.",
"short": "Specific instance of object",
"mapping": [ {
"map": ".id.extension",
"identity": "rim"
}, {
"map": "ParticipantObjectID and ParticipantObjectIDTypeCode",
"identity": "dicom"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "1",
"id": "AuditEvent.entity.identifier",
"comment": "Identifier detail depends on entity type.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.identifier"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.reference",
"min": 0,
"definition": "Identifies a specific instance of the entity. The reference should be version specific.",
"short": "Specific instance of resource",
"mapping": [ {
"map": "[self]",
"identity": "rim"
}, {
"map": "ParticipantObjectID",
"identity": "dicom"
}, {
"map": "Provenance.target, Provenance.entity.reference",
"identity": "fhirprovenance"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "1",
"id": "AuditEvent.entity.reference",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.reference"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.type",
"requirements": "To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.",
"min": 0,
"definition": "The type of the object that was involved in this audit event.",
"short": "Type of entity involved",
"mapping": [ {
"map": "[self::Act].code or role.player.code",
"identity": "rim"
}, {
"map": "ParticipantObjectTypeCode",
"identity": "dicom"
}, {
"map": "Entity.type",
"identity": "w3c.prov"
}, {
"map": "Provenance.entity.type",
"identity": "fhirprovenance"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"mustSupport": true,
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityType"
} ],
"description": "Code for the entity type involved in the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/audit-entity-type"
}
},
"max": "1",
"id": "AuditEvent.entity.type",
"comment": "This value is distinct from the user's role or any user relationship to the entity.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.type"
}
}, {
"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.",
"short": "What role the entity played",
"mapping": [ {
"map": "role.code (not sure what this would mean for an Act)",
"identity": "rim"
}, {
"map": "ParticipantObjectTypeCodeRole",
"identity": "dicom"
}, {
"map": "Entity.role",
"identity": "w3c.prov"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityRole"
} ],
"description": "Code representing the role the entity played in the audit event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-role"
}
},
"max": "1",
"id": "AuditEvent.entity.role",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.role"
}
}, {
"path": "AuditEvent.entity.lifecycle",
"requirements": "Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.",
"min": 0,
"definition": "Identifier for the data life-cycle stage for the entity.",
"short": "Life-cycle stage for the entity",
"mapping": [ {
"map": "target of ObservationEvent[code=\"lifecycle\"].value",
"identity": "rim"
}, {
"map": "ParticipantObjectDataLifeCycle",
"identity": "dicom"
}, {
"map": "Entity.role",
"identity": "w3c.prov"
}, {
"map": "Provenance.entity.role",
"identity": "fhirprovenance"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AuditEventEntityLifecycle"
} ],
"description": "Identifier for the data life-cycle stage for the entity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/object-lifecycle-events"
}
},
"max": "1",
"id": "AuditEvent.entity.lifecycle",
"comment": "This can be used to provide an audit trail for data, over time, as it passes through the system.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.lifecycle"
}
}, {
"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.",
"short": "Security labels on the entity",
"mapping": [ {
"map": ".confidentialityCode",
"identity": "rim"
}, {
"map": "ParticipantObjectSensitivity",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
} ],
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels"
}
},
"max": "*",
"id": "AuditEvent.entity.securityLabel",
"comment": "Copied from entity meta security tags.",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity.securityLabel"
}
}, {
"path": "AuditEvent.entity.name",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"definition": "A name of the entity in the audit event.",
"short": "Descriptor for entity",
"mapping": [ {
"map": ".title",
"identity": "rim"
}, {
"map": "ParticipantObjectName",
"identity": "dicom"
}, {
"map": "Entity.Label",
"identity": "w3c.prov"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.entity.name",
"condition": [ "sev-1" ],
"comment": "This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.name"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.description",
"requirements": "Use only where entity can't be identified with an identifier.",
"min": 0,
"definition": "Text that describes the entity in more detail.",
"short": "Descriptive text",
"mapping": [ {
"map": ".text",
"identity": "rim"
}, {
"map": "ParticipantObjectDescription",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.entity.description",
"base": {
"max": "1",
"min": 0,
"path": "AuditEvent.entity.description"
}
}, {
"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.",
"short": "Query parameters",
"mapping": [ {
"map": "No mapping",
"identity": "rim"
}, {
"map": "ParticipantObjectQuery",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "AuditEvent.entity.query",
"condition": [ "sev-1" ],
"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",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "zv-ae-1",
"human": "At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.",
"xpath": "/f:entity/f:detail[f:type='X-Request-Id']",
"severity": "error",
"expression": "type='X-Request-Id'"
} ],
"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.",
"short": "Additional Information about the entity",
"mapping": [ {
"map": ".inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": true,
"max": "*",
"id": "AuditEvent.entity.detail",
"base": {
"max": "*",
"min": 0,
"path": "AuditEvent.entity.detail"
}
}, {
"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.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "AuditEvent.entity.detail.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"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. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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"
}
}, {
"path": "AuditEvent.entity.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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"
},
"isSummary": true
}, {
"path": "AuditEvent.entity.detail.type",
"min": 1,
"definition": "The type of extra detail provided in the value.",
"short": "Name of the property",
"mapping": [ {
"map": ".code",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.type",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "AuditEvent.entity.detail.type",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.entity.detail.type"
}
}, {
"path": "AuditEvent.entity.detail.value",
"requirements": "Should not duplicate the entity value unless absolutely necessary.",
"min": 1,
"definition": "The details, base64 encoded. Used to carry bulk information.",
"short": "Property value",
"mapping": [ {
"map": ".value",
"identity": "rim"
}, {
"map": "ParticipantObjectDetail.value",
"identity": "dicom"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "base64Binary"
} ],
"max": "1",
"id": "AuditEvent.entity.detail.value",
"comment": "The value is base64 encoded to enable various encodings or binary content.",
"base": {
"max": "1",
"min": 1,
"path": "AuditEvent.entity.detail.value"
}
} ]
},
"status": "active",
"id": "9d97e14c-82f7-41eb-846e-a19ce081c3ca",
"kind": "resource",
"url": "http://fhir.hl7.nl/zorgviewer/StructureDefinition/AuditEvent",
"version": "1.13.0",
"differential": {
"element": [ {
"id": "AuditEvent",
"path": "AuditEvent"
}, {
"id": "AuditEvent.type",
"path": "AuditEvent.type",
"mustSupport": true
}, {
"id": "AuditEvent.action",
"path": "AuditEvent.action",
"mustSupport": true
}, {
"id": "AuditEvent.recorded",
"path": "AuditEvent.recorded",
"mustSupport": true
}, {
"id": "AuditEvent.agent",
"path": "AuditEvent.agent",
"mustSupport": true
}, {
"id": "AuditEvent.agent.role",
"path": "AuditEvent.agent.role",
"mustSupport": true
}, {
"id": "AuditEvent.agent.userId",
"path": "AuditEvent.agent.userId",
"mustSupport": true
}, {
"id": "AuditEvent.agent.name",
"path": "AuditEvent.agent.name",
"mustSupport": true
}, {
"id": "AuditEvent.agent.policy",
"path": "AuditEvent.agent.policy",
"fixedUri": "https://rivo-noord.nl/zorgviewer/toestemming",
"mustSupport": true
}, {
"id": "AuditEvent.source.identifier",
"path": "AuditEvent.source.identifier",
"mustSupport": true
}, {
"id": "AuditEvent.entity",
"path": "AuditEvent.entity",
"mustSupport": true
}, {
"id": "AuditEvent.entity.identifier",
"path": "AuditEvent.entity.identifier",
"mustSupport": true
}, {
"id": "AuditEvent.entity.type",
"path": "AuditEvent.entity.type",
"mustSupport": true
}, {
"id": "AuditEvent.entity.detail",
"path": "AuditEvent.entity.detail",
"constraint": [ {
"key": "zv-ae-1",
"human": "At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.",
"xpath": "/f:entity/f:detail[f:type='X-Request-Id']",
"severity": "error",
"expression": "type='X-Request-Id'"
} ],
"mustSupport": true
} ]
},
"contact": [ {
"name": "RIVO-NN",
"telecom": [ {
"value": "https://rivo-noord.nl",
"system": "url"
} ]
}, {
"name": "HL7NL",
"telecom": [ {
"value": "https://hl7.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent"
}