{
"description": "R5: `AuditEvent.agent`",
"_filename": "StructureDefinition-ext-R5-AuditEvent.agent.json",
"package_name": "hl7.fhir.uv.xver-r5.r3",
"date": "2026-03-17T21:02:03.8104715+00:00",
"derivation": "constraint",
"publisher": "FHIR Infrastructure",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `AuditEvent.agent` as defined in FHIR R5\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`AuditEvent.agent` 1..* `BackboneElement`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R5: `AuditEvent.agent` 1..* `BackboneElement`\n* R4B: `AuditEvent.agent` 1..* `BackboneElement`\n* R4: `AuditEvent.agent` 1..* `BackboneElement`\n* STU3: `AuditEvent.agent` 1..* `BackboneElement`\r\n\r\nFollowing are the generation technical comments:\r\nElement `AuditEvent.agent` is mapped to FHIR STU3 element `AuditEvent.agent` as `Equivalent`.\nCreating extension because element `AuditEvent.agent` is a content reference and requires an extesion definition.",
"name": "ExtensionAuditEvent_Agent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "R5: agent",
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/package-source",
"extension": [ {
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r3"
}, {
"url": "version",
"valueString": "0.1.0"
}, {
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
} ]
}
} ],
"snapshot": {
"element": [ {
"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": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 1,
"definition": "R5: `AuditEvent.agent`",
"isModifier": false,
"short": "R5: agent",
"max": "*",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "Element `AuditEvent.agent` is mapped to FHIR STU3 element `AuditEvent.agent` as `Equivalent`.\nSeveral 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": 0,
"path": "Extension"
}
}, {
"path": "Extension.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": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension",
"min": 1,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"ordered": false,
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Extension.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension",
"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. Element `AuditEvent.agent.type` has a context of AuditEvent.agent based on following the parent source element upwards and mapping to `AuditEvent`.\nElement `AuditEvent.agent.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `AuditEvent.agent.type` (new:CodeableConcept)",
"short": "R5: How agent participated (new)",
"type": [ {
"code": "Extension"
} ],
"sliceName": "type",
"max": "1",
"id": "Extension.extension:type",
"comment": "Element `AuditEvent.agent.type` has a context of AuditEvent.agent based on following the parent source element upwards and mapping to `AuditEvent`.\nElement `AuditEvent.agent.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nFor example: assembler, author, prescriber, signer, investigator, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:type.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:type.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "type",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:type.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The Functional Role of the user when performing the event.",
"short": "How agent participated",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "The Participation type of the agent to the event.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-participation-role-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:type.value[x]",
"comment": "For example: assembler, author, prescriber, signer, investigator, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"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.. Element `AuditEvent.agent.role` is mapped to FHIR STU3 element `AuditEvent.agent.role` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.role`",
"short": "R5: role",
"type": [ {
"code": "Extension"
} ],
"sliceName": "role",
"max": "*",
"id": "Extension.extension:role",
"comment": "Element `AuditEvent.agent.role` is mapped to FHIR STU3 element `AuditEvent.agent.role` as `Equivalent`.\nFor example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:role.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:role.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "role",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:role.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "Agent role in the event",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "What security role enabled the agent to participate in the event.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-security-role-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:role.value[x]",
"comment": "For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "This field ties an audit event to a specific resource or identifier. Element `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.reference` as `SourceIsBroaderThanTarget`.\nElement `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.userId` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.",
"min": 1,
"definition": "R5: `AuditEvent.agent.who`",
"short": "R5: Identifier of who",
"type": [ {
"code": "Extension"
} ],
"sliceName": "who",
"max": "1",
"id": "Extension.extension:who",
"comment": "Element `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.reference` as `SourceIsBroaderThanTarget`.\nElement `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.userId` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nWhere 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": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:who.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:who.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/alternate-reference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:who.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Extension.extension:who.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"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. Element `AuditEvent.agent.requestor` is mapped to FHIR STU3 element `AuditEvent.agent.requestor` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.requestor`",
"short": "R5: requestor",
"type": [ {
"code": "Extension"
} ],
"sliceName": "requestor",
"max": "1",
"id": "Extension.extension:requestor",
"comment": "Element `AuditEvent.agent.requestor` is mapped to FHIR STU3 element `AuditEvent.agent.requestor` as `Equivalent`.\nThere can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:requestor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:requestor.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "requestor",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:requestor.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"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": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.extension:requestor.value[x]",
"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": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `AuditEvent.agent.location` is mapped to FHIR STU3 element `AuditEvent.agent.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `AuditEvent.agent.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.location` with unmapped reference targets: Location.",
"min": 0,
"definition": "R5: `AuditEvent.agent.location` additional types from child elements (display, identifier, reference, type)",
"short": "R5: The agent location when the event occurred additional types",
"type": [ {
"code": "Extension"
} ],
"sliceName": "location",
"max": "1",
"id": "Extension.extension:location",
"comment": "Element `AuditEvent.agent.location` is mapped to FHIR STU3 element `AuditEvent.agent.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `AuditEvent.agent.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.location` with unmapped reference targets: Location.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:location.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:location.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/alternate-reference",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:location.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Extension.extension:location.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "This value is used retrospectively to determine the authorization policies. Element `AuditEvent.agent.policy` is mapped to FHIR STU3 element `AuditEvent.agent.policy` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.policy`",
"short": "R5: Policy that authorized the agent participation in the event",
"type": [ {
"code": "Extension"
} ],
"sliceName": "policy",
"max": "*",
"id": "Extension.extension:policy",
"comment": "Element `AuditEvent.agent.policy` is mapped to FHIR STU3 element `AuditEvent.agent.policy` as `Equivalent`.\nFor 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": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:policy.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:policy.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "policy",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:policy.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "Policy that authorized the agent participation in the event",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Extension.extension:policy.value[x]",
"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": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"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). Element `AuditEvent.agent.network[x]` is mapped to FHIR STU3 element `AuditEvent.agent.network` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.network[x]`",
"short": "R5: This agent network location for the activity",
"type": [ {
"code": "Extension"
} ],
"sliceName": "network",
"max": "1",
"id": "Extension.extension:network",
"comment": "Element `AuditEvent.agent.network[x]` is mapped to FHIR STU3 element `AuditEvent.agent.network` as `Equivalent`.\nWhen 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": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:network.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension: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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "network",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:network.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "This agent network location for the activity",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/5.0/StructureDefinition/profile-Endpoint|0.1.0"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}, {
"code": "uri"
}, {
"code": "string"
} ],
"max": "1",
"id": "Extension.extension:network.value[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": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags. Element `AuditEvent.agent.authorization` is mapped to FHIR STU3 element `AuditEvent.agent.purposeOfUse` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.authorization`",
"short": "R5: Allowable authorization for this agent",
"type": [ {
"code": "Extension"
} ],
"sliceName": "authorization",
"max": "*",
"id": "Extension.extension:authorization",
"comment": "Element `AuditEvent.agent.authorization` is mapped to FHIR STU3 element `AuditEvent.agent.purposeOfUse` as `Equivalent`.\nUse 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": "Element.extension"
}
}, {
"path": "Extension.extension.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": "Extension.extension:authorization.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Extension.extension.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"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Extension.extension:authorization.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": "Extension.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "authorization",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.extension:authorization.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"short": "Allowable authorization for this agent",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "The reason the activity took place.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse|2014-03-26"
},
"max": "1",
"id": "Extension.extension:authorization.value[x]",
"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": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"path": "Extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "0",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
} ]
},
"status": "active",
"id": "0f5d4eec-e0f9-488e-8eff-630d4e8d23d6",
"kind": "complex-type",
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent",
"context": [ "AuditEvent.agent" ],
"version": "0.1.0",
"differential": {
"element": [ {
"path": "Extension",
"min": 1,
"definition": "R5: `AuditEvent.agent`",
"isModifier": false,
"short": "R5: agent",
"max": "*",
"id": "Extension",
"comment": "Element `AuditEvent.agent` is mapped to FHIR STU3 element `AuditEvent.agent` as `Equivalent`.\nSeveral 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": 0,
"path": "Extension"
}
}, {
"id": "Extension.extension",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
},
"path": "Extension.extension",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"path": "Extension.extension",
"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. Element `AuditEvent.agent.type` has a context of AuditEvent.agent based on following the parent source element upwards and mapping to `AuditEvent`.\nElement `AuditEvent.agent.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"definition": "R5: `AuditEvent.agent.type` (new:CodeableConcept)",
"short": "R5: How agent participated (new)",
"sliceName": "type",
"max": "1",
"id": "Extension.extension:type",
"comment": "Element `AuditEvent.agent.type` has a context of AuditEvent.agent based on following the parent source element upwards and mapping to `AuditEvent`.\nElement `AuditEvent.agent.type` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nFor example: assembler, author, prescriber, signer, investigator, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:type.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "type"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The Functional Role of the user when performing the event.",
"short": "How agent participated",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "preferred",
"description": "The Participation type of the agent to the event.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-participation-role-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:type.value[x]",
"comment": "For example: assembler, author, prescriber, signer, investigator, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"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.. Element `AuditEvent.agent.role` is mapped to FHIR STU3 element `AuditEvent.agent.role` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.role`",
"short": "R5: role",
"sliceName": "role",
"max": "*",
"id": "Extension.extension:role",
"comment": "Element `AuditEvent.agent.role` is mapped to FHIR STU3 element `AuditEvent.agent.role` as `Equivalent`.\nFor example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:role.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "role"
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "Agent role in the event",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "What security role enabled the agent to participate in the event.",
"valueSetUri": "http://hl7.org/fhir/uv/xver/ValueSet/R5-security-role-type-for-R3|0.1.0"
},
"max": "1",
"id": "Extension.extension:role.value[x]",
"comment": "For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "This field ties an audit event to a specific resource or identifier. Element `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.reference` as `SourceIsBroaderThanTarget`.\nElement `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.userId` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.",
"min": 1,
"definition": "R5: `AuditEvent.agent.who`",
"short": "R5: Identifier of who",
"sliceName": "who",
"max": "1",
"id": "Extension.extension:who",
"comment": "Element `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.reference` as `SourceIsBroaderThanTarget`.\nElement `AuditEvent.agent.who` is mapped to FHIR STU3 element `AuditEvent.agent.userId` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nWhere 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": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:who.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}, {
"path": "Extension.extension",
"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. Element `AuditEvent.agent.requestor` is mapped to FHIR STU3 element `AuditEvent.agent.requestor` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.requestor`",
"short": "R5: requestor",
"sliceName": "requestor",
"max": "1",
"id": "Extension.extension:requestor",
"comment": "Element `AuditEvent.agent.requestor` is mapped to FHIR STU3 element `AuditEvent.agent.requestor` as `Equivalent`.\nThere can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:requestor.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "requestor"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "Indicator that the user is or is not the requestor, or initiator, for the event being audited.",
"short": "Whether user is initiator",
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.extension:requestor.value[x]",
"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": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Element `AuditEvent.agent.location` is mapped to FHIR STU3 element `AuditEvent.agent.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `AuditEvent.agent.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.location` with unmapped reference targets: Location.",
"min": 0,
"definition": "R5: `AuditEvent.agent.location` additional types from child elements (display, identifier, reference, type)",
"short": "R5: The agent location when the event occurred additional types",
"sliceName": "location",
"max": "1",
"id": "Extension.extension:location",
"comment": "Element `AuditEvent.agent.location` is mapped to FHIR STU3 element `AuditEvent.agent.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `AuditEvent.agent.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.location` with unmapped reference targets: Location.",
"base": {
"max": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:location.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}, {
"path": "Extension.extension",
"requirements": "This value is used retrospectively to determine the authorization policies. Element `AuditEvent.agent.policy` is mapped to FHIR STU3 element `AuditEvent.agent.policy` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.policy`",
"short": "R5: Policy that authorized the agent participation in the event",
"sliceName": "policy",
"max": "*",
"id": "Extension.extension:policy",
"comment": "Element `AuditEvent.agent.policy` is mapped to FHIR STU3 element `AuditEvent.agent.policy` as `Equivalent`.\nFor 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": "Extension.extension"
}
}, {
"id": "Extension.extension:policy.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "policy"
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "Policy that authorized the agent participation in the event",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Extension.extension:policy.value[x]",
"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": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"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). Element `AuditEvent.agent.network[x]` is mapped to FHIR STU3 element `AuditEvent.agent.network` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.network[x]`",
"short": "R5: This agent network location for the activity",
"sliceName": "network",
"max": "1",
"id": "Extension.extension:network",
"comment": "Element `AuditEvent.agent.network[x]` is mapped to FHIR STU3 element `AuditEvent.agent.network` as `Equivalent`.\nWhen 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": "*",
"min": 0,
"path": "Extension.extension"
}
}, {
"id": "Extension.extension:network.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "network"
}, {
"path": "Extension.extension.value[x]",
"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.",
"short": "This agent network location for the activity",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/5.0/StructureDefinition/profile-Endpoint|0.1.0"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint"
}, {
"code": "uri"
}, {
"code": "string"
} ],
"max": "1",
"id": "Extension.extension:network.value[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": "Extension.value[x]"
}
}, {
"path": "Extension.extension",
"requirements": "Record of any relevant security context, not restricted to purposeOfUse valueSet. May include security compartments, refrain, obligation, or other security tags. Element `AuditEvent.agent.authorization` is mapped to FHIR STU3 element `AuditEvent.agent.purposeOfUse` as `Equivalent`.",
"min": 0,
"definition": "R5: `AuditEvent.agent.authorization`",
"short": "R5: Allowable authorization for this agent",
"sliceName": "authorization",
"max": "*",
"id": "Extension.extension:authorization",
"comment": "Element `AuditEvent.agent.authorization` is mapped to FHIR STU3 element `AuditEvent.agent.purposeOfUse` as `Equivalent`.\nUse 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": "Extension.extension"
}
}, {
"id": "Extension.extension:authorization.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.extension.url",
"fixedUri": "authorization"
}, {
"path": "Extension.extension.value[x]",
"min": 0,
"definition": "The authorization (e.g., PurposeOfUse) that was used during the event being recorded.",
"short": "Allowable authorization for this agent",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "The reason the activity took place.",
"valueSetUri": "http://hl7.org/fhir/ValueSet/v3-PurposeOfUse|2014-03-26"
},
"max": "1",
"id": "Extension.extension:authorization.value[x]",
"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": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"id": "Extension.url",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent"
}, {
"id": "Extension.value[x]",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"path": "Extension.value[x]"
} ]
},
"contact": [ {
"name": "FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"contextType": "resource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}