Generated Narrative: StructureDefinition ext-R5-AuditEvent.agent Name Flags Card. Type Description & Constraints Extension 1..* Extension(4.0.1) R5: agent #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 0..1 Extension R5: type #xD; url 1..1 uri "type" #xD; value[x] 0..1 CodeableConcept How agent participated Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event. #xD; extension:role 0..* Extension R5: role #xD; url 1..1 uri "role" #xD; value[x] 0..1 CodeableConcept Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. #xD; extension:who 1..1 Extension R5: who #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference" #xD; extension:requestor 0..1 Extension R5: requestor #xD; url 1..1 uri "requestor" #xD; value[x] 0..1 boolean Whether user is initiator #xD; extension:location 0..1 Extension R5: The agent location when the event occurred #xD; url 1..1 uri "location" #xD; value[x] 0..1 Reference(Cross-version Profile for R5.Location for use in FHIR R4(0.1.0) | Location) The agent location when the event occurred #xD; extension:policy 0..* Extension R5: Policy that authorized the agent participation in the event #xD; url 1..1 uri "policy" #xD; value[x] 0..1 uri Policy that authorized the agent participation in the event #xD; extension:network 0..1 Extension R5: This agent network location for the activity #xD; url 1..1 uri "network" #xD; value[x] 0..1 This agent network location for the activity #xD; valueReference Reference(Cross-version Profile for R5.Endpoint for use in FHIR R4(0.1.0) | Endpoint) #xD; valueUri uri #xD; valueString string #xD; extension:authorization 0..* Extension R5: Allowable authorization for this agent #xD; url 1..1 uri "authorization" #xD; value[x] 0..1 CodeableConcept Allowable authorization for this agent Binding: v3.PurposeOfUse (2014-03-26) (example): The reason the activity took place. #xD; url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
This extension is part of the cross-version definitions generated to enable use of the element `AuditEvent.agent` as defined in FHIR R5 in FHIR R4. The source element is defined as: `AuditEvent.agent` 1..* `BackboneElement` Across FHIR versions, the element set has been mapped as: * R5: `AuditEvent.agent` 1..* `BackboneElement` * R4B: `AuditEvent.agent` 1..* `BackboneElement` * R4: `AuditEvent.agent` 1..* `BackboneElement` Following are the generation technical comments: Element `AuditEvent.agent` is mapped to FHIR R4 element `AuditEvent.agent` as `Equivalent`. Creating extension because element `AuditEvent.agent` is a content reference and requires an extesion definition.
Element `AuditEvent.agent` is mapped to FHIR R4 element `AuditEvent.agent` as `Equivalent`. Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For 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. When 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Element `AuditEvent.agent.type` is mapped to FHIR R4 element `AuditEvent.agent.type` as `Equivalent`. For example: assembler, author, prescriber, signer, investigator, etc.
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` is mapped to FHIR R4 element `AuditEvent.agent.type` as `Equivalent`.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Source of the definition for the extension code - a logical name or a URL.
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.
The Functional Role of the user when performing the event.
For example: assembler, author, prescriber, signer, investigator, etc.
The Participation type of the agent to the event.
Element `AuditEvent.agent.role` is mapped to FHIR R4 element `AuditEvent.agent.role` as `Equivalent`. For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
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 R4 element `AuditEvent.agent.role` as `Equivalent`.
The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.
For example: Chief-of-Radiology, Nurse, Physician, Medical-Student, etc.
What security role enabled the agent to participate in the event.
Element `AuditEvent.agent.who` is mapped to FHIR R4 element `AuditEvent.agent.who` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam. Where a User ID is available it will go into who.identifier. Where a name of the user (human readable) it will go into who.display.
This field ties an audit event to a specific resource or identifier. Element `AuditEvent.agent.who` is mapped to FHIR R4 element `AuditEvent.agent.who` as `SourceIsBroaderThanTarget`. The standard extension `alternate-reference` has been mapped as the representation of FHIR R5 element `AuditEvent.agent.who` with unmapped reference targets: CareTeam.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
Element `AuditEvent.agent.requestor` is mapped to FHIR R4 element `AuditEvent.agent.requestor` as `Equivalent`. There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
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 R4 element `AuditEvent.agent.requestor` as `Equivalent`.
Indicator that the user is or is not the requestor, or initiator, for the event being audited.
There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
R5: The agent location when the event occurred
Element `AuditEvent.agent.location` is mapped to FHIR R4 element `AuditEvent.agent.location` as `Equivalent`.
The agent location when the event occurred
Where the agent location is known, the agent location when the event occurred.
R5: Policy that authorized the agent participation in the event
Element `AuditEvent.agent.policy` is mapped to FHIR R4 element `AuditEvent.agent.policy` as `Equivalent`. 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.
This value is used retrospectively to determine the authorization policies. Element `AuditEvent.agent.policy` is mapped to FHIR R4 element `AuditEvent.agent.policy` as `Equivalent`.
Policy that authorized the agent participation in the event
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.
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.
R5: This agent network location for the activity
Element `AuditEvent.agent.network[x]` is mapped to FHIR R4 element `AuditEvent.agent.network` as `Equivalent`. 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.
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 R4 element `AuditEvent.agent.network` as `Equivalent`.
This agent network location for the activity
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.
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.
R5: Allowable authorization for this agent
Element `AuditEvent.agent.authorization` is mapped to FHIR R4 element `AuditEvent.agent.purposeOfUse` as `Equivalent`. 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.
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 R4 element `AuditEvent.agent.purposeOfUse` as `Equivalent`.
The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
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.