EPAAuditEvent
Das Profil EPAAuditEvent
wird von dem ePA Audit Event Service verwendet, um Protokolleinträge an den ePA-Client bereitzustellen. Dieses Profil stellt sicher, dass alle relevanten Ereignisse im Zusammenhang mit der Nutzung der ePA korrekt und umfassend dokumentiert werden, um den Anforderungen an Datenschutz und Nachvollziehbarkeit gerecht zu werden.
Profile
EPAAuditEvent (AuditEvent) | I | AuditEvent | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
type | Σ | 1..1 | CodingBinding |
subtype | Σ | 0..0 | CodingBinding |
action | S Σ | 1..1 | codeBinding |
period | I | 0..0 | Period |
recorded | S Σ | 1..1 | instant |
outcome | S Σ | 1..1 | codeBinding |
outcomeDesc | Σ | 0..0 | string |
purposeOfEvent | S Σ | 0..* | CodeableConceptBinding |
agent | S | 1..* | BackboneElement |
(All Slices) | |||
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 0..1 | CodeableConceptBinding | |
role | 0..* | CodeableConcept | |
who | Σ I | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
altId | 0..1 | string | |
name | 0..1 | string | |
requestor | Σ | 1..1 | boolean |
location | I | 0..1 | Reference(Location) |
policy | 0..* | uri | |
media | 0..1 | CodingBinding | |
network | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
address | 0..1 | string | |
type | 0..1 | codeBinding | |
purposeOfUse | 0..* | CodeableConceptBinding | |
user | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
healthcareFacilityType | S I | 0..1 | Extension(Coding) |
modifierExtension | Σ ?! I | 0..* | Extension |
type | S | 1..1 | CodeableConceptBinding |
role | S | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | S Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | S Σ | 1..1 | code |
display | S Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
who | S Σ I | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 |
display | Σ | 0..1 | string |
altId | S | 0..1 | string |
name | S | 1..1 | string |
requestor | Σ | 1..1 | booleanFixed Value |
location | I | 0..0 | Reference(Location) |
policy | 0..0 | uri | |
media | 0..0 | CodingBinding | |
network | 0..0 | BackboneElement | |
purposeOfUse | 0..* | CodeableConceptBinding | |
client | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | S | 1..1 | CodeableConceptBinding |
role | S | 0..* | CodeableConcept |
who | S Σ I | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | S Σ | 1..1 | IdentifierTelematikId |
display | Σ | 0..1 | string |
altId | S | 0..1 | string |
name | S | 1..1 | string |
requestor | Σ | 1..1 | booleanFixed Value |
location | I | 0..0 | Reference(Location) |
policy | 0..0 | uri | |
media | 0..0 | CodingBinding | |
network | 0..0 | BackboneElement | |
purposeOfUse | 0..* | CodeableConceptBinding | |
internal | S | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | S | 1..1 | CodeableConceptBinding |
role | 0..0 | CodeableConcept | |
who | Σ I | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
altId | S | 0..1 | stringFixed Value |
name | S | 1..1 | stringFixed Value |
requestor | Σ | 1..1 | booleanFixed Value |
location | I | 0..0 | Reference(Location) |
policy | 0..0 | uri | |
media | 0..0 | CodingBinding | |
network | 0..0 | BackboneElement | |
purposeOfUse | 0..* | CodeableConceptBinding | |
source | S | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
site | 0..1 | string | |
observer | Σ I | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | stringFixed Value |
type | S | 1..1 | CodingBinding |
entity | S I | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
what | Σ I | 0..0 | Reference(Resource) |
type | 0..0 | CodingBinding | |
role | 0..0 | CodingBinding | |
lifecycle | 0..0 | CodingBinding | |
securityLabel | 0..0 | CodingBinding | |
name | S Σ I | 0..1 | string |
description | S | 0..1 | string |
query | Σ I | 0..0 | base64Binary |
detail | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | S | 1..1 | string |
value[x] | 1..1 | ||
(All Slices) | |||
valueBase64Binary | base64Binary | ||
valueString | S | 1..1 | string |
AuditEvent | |
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. |
Cardinality | 0...* |
Comments | Based on IHE-ATNA. |
Invariants |
|
Mappings |
|
AuditEvent.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
AuditEvent.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
AuditEvent.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
AuditEvent.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | 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). |
Invariants |
|
Mappings |
|
AuditEvent.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | 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 information is added later. |
Invariants |
|
Mappings |
|
AuditEvent.contained | |
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. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
AuditEvent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.type | |
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. |
Cardinality | 1...1 |
Type | Coding |
Binding | Type of event. |
Summary | True |
Requirements | This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.subtype | |
Definition | Identifier for the category of event. |
Cardinality | 0...0 |
Type | Coding |
Binding | Sub-type of event. |
Summary | True |
Requirements | This field enables queries of messages by implementation-defined event categories. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.action | |
Definition | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E |
Cardinality | 1...1 |
Type | code |
Binding | Indicator for type of action performed during the event that generated the event. |
Must Support | True |
Summary | True |
Requirements | This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.period | |
Definition | The period during which the activity occurred. |
Cardinality | 0...0 |
Type | Period |
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
Invariants |
|
Mappings |
|
AuditEvent.recorded | |
Definition | The time when the event was recorded. |
Cardinality | 1...1 |
Type | instant |
Must Support | True |
Summary | True |
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. |
Comments | In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic. |
Invariants |
|
Mappings |
|
AuditEvent.outcome | |
Definition | success: 0; failure: 4; major failure: 12 |
Cardinality | 1...1 |
Type | code |
Binding | Indicates whether the event succeeded or failed. |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.outcomeDesc | |
Definition | A free text description of the outcome of the event. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.purposeOfEvent | |
Definition | The purposeOfUse (reason) that was used during the event being recorded. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Must Support | True |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent | |
Definition | An actor taking an active role in the event or activity that is logged. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Alias | ActiveParticipant |
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. |
Comments | 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. |
Slicing | Unordered, Open, by type(Pattern) |
Invariants |
|
Mappings |
|
AuditEvent.agent.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent.type | |
Definition | Specification of the participation type the user plays when performing the event. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The Participation type of the agent to the event. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AuditEvent.agent.role | |
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. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | What security role enabled the agent to participate in the event. |
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. |
Comments | Should be roles relevant to the event. Should not be an exhaustive list of roles. |
Invariants |
|
Mappings |
|
AuditEvent.agent.who | |
Definition | Reference to who this agent is that was involved in the event. |
Cardinality | 0...1 |
Type | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
Summary | True |
Alias | userId |
Requirements | This field ties an audit event to a specific resource or identifier. |
Comments | Where a User ID is available it will go into who.identifier. |
Invariants |
|
Mappings |
|
AuditEvent.agent.altId | |
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. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent.name | |
Definition | Human-meaningful name for the agent. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent.requestor | |
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
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. |
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. |
Invariants |
|
Mappings |
|
AuditEvent.agent.location | |
Definition | Where the event occurred. |
Cardinality | 0...1 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.agent.policy | |
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. |
Cardinality | 0...* |
Type | uri |
Requirements | This value is used retrospectively to determine the authorization policies. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent.media | |
Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
Cardinality | 0...1 |
Type | Coding |
Binding | Used when the event is about exporting/importing onto 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). |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.agent.network | |
Definition | Logical network location for application activity, if the activity has a network location. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
AuditEvent.agent.network.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent.network.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent.network.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent.network.address | |
Definition | An identifier for the network access point of the user device for the audit event. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | This could be a device id, IP address or some other identifier associated with a device. |
Invariants |
|
Mappings |
|
AuditEvent.agent.network.type | |
Definition | An identifier for the type of network access point that originated the audit event. |
Cardinality | 0...1 |
Type | code |
Binding | The type of network access point of this agent in the audit event. |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent.purposeOfUse | |
Definition | The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user | |
Definition | The agent user refers to the service provider (LE) or the service provider institution (LEI) |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Alias | ActiveParticipant |
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:user.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.extension:healthcareFacilityType | |
Definition | EPAHealthcareFacilityType Extension |
Cardinality | 0...1 |
Type | Extension(Coding) |
Must Support | True |
Alias | extensions, user content |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.type | |
Definition | Specification of the participation type the user plays when performing the event. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The Participation type of the agent to the event. |
Must Support | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role | |
Definition | Professional role of the service provider |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | What security role enabled the agent to participate in the event. |
Must Support | True |
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. |
Comments | Should be roles relevant to the event. Should not be an exhaustive list of roles. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:user.role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:user.role.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.role.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who | |
Definition | The subject Id of the IDToken |
Cardinality | 0...1 |
Type | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
Must Support | True |
Summary | True |
Alias | userId |
Requirements | This field ties an audit event to a specific resource or identifier. |
Comments | Where a User ID is available it will go into who.identifier. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:user.who.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 1...1 |
Type | IdentifierTelematikId, IdentifierKvid10 |
Must Support | True |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.who.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.altId | |
Definition | Alternative User identity (e.g. Telematik-ID or the KVNR) |
Cardinality | 0...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.name | |
Definition | Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/' |
Cardinality | 1...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.requestor | |
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
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. |
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. |
Invariants |
|
Fixed Value | true |
Mappings |
|
AuditEvent.agent:user.location | |
Definition | Where the event occurred. |
Cardinality | 0...0 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.policy | |
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. |
Cardinality | 0...0 |
Type | uri |
Requirements | This value is used retrospectively to determine the authorization policies. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.media | |
Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
Cardinality | 0...0 |
Type | Coding |
Binding | Used when the event is about exporting/importing onto 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). |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.network | |
Definition | Logical network location for application activity, if the activity has a network location. |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.network.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:user.network.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.network.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.network.address | |
Definition | An identifier for the network access point of the user device for the audit event. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | This could be a device id, IP address or some other identifier associated with a device. |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.network.type | |
Definition | An identifier for the type of network access point that originated the audit event. |
Cardinality | 0...1 |
Type | code |
Binding | The type of network access point of this agent in the audit event. |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:user.purposeOfUse | |
Definition | The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client | |
Definition | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Alias | ActiveParticipant |
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:client.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.type | |
Definition | Specification of the participation type the user plays when performing the event. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The Participation type of the agent to the event. |
Must Support | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.role | |
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. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | What security role enabled the agent to participate in the event. |
Must Support | True |
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. |
Comments | Should be roles relevant to the event. Should not be an exhaustive list of roles. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who | |
Definition | The subject Id of the IDToken |
Cardinality | 1...1 |
Type | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
Must Support | True |
Summary | True |
Alias | userId |
Requirements | This field ties an audit event to a specific resource or identifier. |
Comments | Where a User ID is available it will go into who.identifier. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:client.who.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 1...1 |
Type | IdentifierTelematikId |
Must Support | True |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.who.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.altId | |
Definition | Alternative client identity (e.g. Telematik-ID) |
Cardinality | 0...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.name | |
Definition | Name of a service e.g. eRezept, EU access/country name or DiGA |
Cardinality | 1...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.requestor | |
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
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. |
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. |
Invariants |
|
Fixed Value | true |
Mappings |
|
AuditEvent.agent:client.location | |
Definition | Where the event occurred. |
Cardinality | 0...0 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.policy | |
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. |
Cardinality | 0...0 |
Type | uri |
Requirements | This value is used retrospectively to determine the authorization policies. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.media | |
Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
Cardinality | 0...0 |
Type | Coding |
Binding | Used when the event is about exporting/importing onto 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). |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.network | |
Definition | Logical network location for application activity, if the activity has a network location. |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.network.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:client.network.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.network.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.network.address | |
Definition | An identifier for the network access point of the user device for the audit event. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | This could be a device id, IP address or some other identifier associated with a device. |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.network.type | |
Definition | An identifier for the type of network access point that originated the audit event. |
Cardinality | 0...1 |
Type | code |
Binding | The type of network access point of this agent in the audit event. |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:client.purposeOfUse | |
Definition | The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal | |
Definition | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Alias | ActiveParticipant |
Requirements | An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:internal.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.type | |
Definition | Specification of the participation type the user plays when performing the event. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The Participation type of the agent to the event. |
Must Support | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.role | |
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. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | What security role enabled the agent to participate in the event. |
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. |
Comments | Should be roles relevant to the event. Should not be an exhaustive list of roles. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.who | |
Definition | Reference to who this agent is that was involved in the event. |
Cardinality | 0...1 |
Type | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
Summary | True |
Alias | userId |
Requirements | This field ties an audit event to a specific resource or identifier. |
Comments | Where a User ID is available it will go into who.identifier. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.altId | |
Definition | altId MUST be epa |
Cardinality | 0...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Fixed Value | epa |
Mappings |
|
AuditEvent.agent:internal.name | |
Definition | Name MUST be ePA |
Cardinality | 1...1 |
Type | string |
Must Support | True |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Fixed Value | ePA |
Mappings |
|
AuditEvent.agent:internal.requestor | |
Definition | Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
Cardinality | 1...1 |
Type | boolean |
Summary | True |
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. |
Comments | There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator. |
Invariants |
|
Fixed Value | true |
Mappings |
|
AuditEvent.agent:internal.location | |
Definition | Where the event occurred. |
Cardinality | 0...0 |
Type | Reference(Location) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.policy | |
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. |
Cardinality | 0...0 |
Type | uri |
Requirements | This value is used retrospectively to determine the authorization policies. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.media | |
Definition | Type of media involved. Used when the event is about exporting/importing onto media. |
Cardinality | 0...0 |
Type | Coding |
Binding | Used when the event is about exporting/importing onto 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). |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.network | |
Definition | Logical network location for application activity, if the activity has a network location. |
Cardinality | 0...0 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.network.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.agent:internal.network.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.network.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.network.address | |
Definition | An identifier for the network access point of the user device for the audit event. |
Cardinality | 0...1 |
Type | string |
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. |
Comments | This could be a device id, IP address or some other identifier associated with a device. |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.network.type | |
Definition | An identifier for the type of network access point that originated the audit event. |
Cardinality | 0...1 |
Type | code |
Binding | The type of network access point of this agent in the audit event. |
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. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.agent:internal.purposeOfUse | |
Definition | The reason (purpose of use), specific to this agent, that was used during the event being recorded. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.source | |
Definition | The system that is reporting the event. |
Cardinality | 1...1 |
Type | BackboneElement |
Must Support | True |
Requirements | The event is reported by one source. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.source.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.source.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.source.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.source.site | |
Definition | Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. |
Cardinality | 0...1 |
Type | string |
Requirements | This value differentiates among the sites in a multi-site enterprise health information system. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.source.observer | |
Definition | Identifier of the source where the event was detected. |
Cardinality | 1...1 |
Type | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) |
Summary | True |
Alias | SourceId |
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. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.source.observer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.source.observer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.source.observer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
AuditEvent.source.observer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
AuditEvent.source.observer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
AuditEvent.source.observer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Fixed Value | Elektronische Patientenakte Fachdienst |
Mappings |
|
AuditEvent.source.type | |
Definition | Code specifying the type of source where event originated. |
Cardinality | 1...1 |
Type | Coding |
Binding | Code specifying the type of system that detected and recorded the event. |
Must Support | True |
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. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.entity | |
Definition | Specific instances of data or objects that have been accessed. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Alias | ParticipantObject |
Requirements | The event may have other entities involved. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.entity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.entity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.entity.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.entity.what | |
Definition | Identifies a specific instance of the entity. The reference should be version specific. |
Cardinality | 0...0 |
Type | Reference(Resource) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AuditEvent.entity.type | |
Definition | The type of the object that was involved in this audit event. |
Cardinality | 0...0 |
Type | Coding |
Binding | Code for the entity type involved in the audit event. |
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. |
Comments | This value is distinct from the user's role or any user relationship to the entity. |
Invariants |
|
Mappings |
|
AuditEvent.entity.role | |
Definition | Code representing the role the entity played in the event being audited. |
Cardinality | 0...0 |
Type | Coding |
Binding | Code representing the role the entity played in the audit event. |
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. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AuditEvent.entity.lifecycle | |
Definition | Identifier for the data life-cycle stage for the entity. |
Cardinality | 0...0 |
Type | Coding |
Binding | Identifier for the data life-cycle stage for the entity. |
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. |
Comments | This can be used to provide an audit trail for data, over time, as it passes through the system. |
Invariants |
|
Mappings |
|
AuditEvent.entity.securityLabel | |
Definition | Security labels for the identified entity. |
Cardinality | 0...0 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
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. |
Comments | Copied from entity meta security tags. |
Invariants |
|
Mappings |
|
AuditEvent.entity.name | |
Definition | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...). |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Use only where entity can't be identified with an identifier. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.entity.description | |
Definition | The OperationId |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Requirements | Use only where entity can't be identified with an identifier. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.entity.query | |
Definition | The query parameters for a query-type entities. |
Cardinality | 0...0 |
Type | base64Binary |
Summary | True |
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. |
Comments | The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail | |
Definition | Tagged value pairs for conveying additional information about the entity. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Requirements | Implementation-defined data about specific details of the object accessed or used. |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AuditEvent.entity.detail.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | 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. |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail.type | |
Definition | The Name of the property (e.g. Document Format, DocumentID, ...). |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail.value[x] | |
Definition | The value of the extra detail. |
Cardinality | 1...1 |
Type | string |
Requirements | Should not duplicate the entity value unless absolutely necessary. |
Comments | The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
AuditEvent.entity.detail.value[x]:valueString | |
Definition | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0) |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Requirements | Should not duplicate the entity value unless absolutely necessary. |
Comments | The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="epa-auditevent" /> <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" /> <version value="1.1.0" /> <name value="EPAAuditEvent" /> <title value="AuditEvent for the ePA" /> <status value="active" /> <experimental value="false" /> <date value="2024-08-14" /> <publisher value="gematik GmbH" /> <description value="Defines the data structure for audit events in the ePA system." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="AuditEvent" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AuditEvent" /> <derivation value="constraint" /> <differential> <element id="AuditEvent.type"> <path value="AuditEvent.type" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs" /> </binding> </element> <element id="AuditEvent.subtype"> <path value="AuditEvent.subtype" /> <max value="0" /> </element> <element id="AuditEvent.action"> <path value="AuditEvent.action" /> <short value="Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E" /> <definition value="Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.period"> <path value="AuditEvent.period" /> <max value="0" /> </element> <element id="AuditEvent.recorded"> <path value="AuditEvent.recorded" /> <mustSupport value="true" /> </element> <element id="AuditEvent.outcome"> <path value="AuditEvent.outcome" /> <short value="success: 0; failure: 4; major failure: 12" /> <definition value="success: 0; failure: 4; major failure: 12" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.outcomeDesc"> <path value="AuditEvent.outcomeDesc" /> <max value="0" /> </element> <element id="AuditEvent.purposeOfEvent"> <path value="AuditEvent.purposeOfEvent" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs" /> </binding> </element> <element id="AuditEvent.agent"> <path value="AuditEvent.agent" /> <slicing> <discriminator> <type value="pattern" /> <path value="type" /> </discriminator> <rules value="open" /> </slicing> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user"> <path value="AuditEvent.agent" /> <sliceName value="user" /> <short value="The agent user refers to the service provider (LE) or the service provider institution (LEI)" /> <definition value="The agent user refers to the service provider (LE) or the service provider institution (LEI)" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.extension:healthcareFacilityType"> <path value="AuditEvent.agent.extension" /> <sliceName value="healthcareFacilityType" /> <min value="0" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension" /> </type> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.type"> <path value="AuditEvent.agent.type" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs" /> </binding> </element> <element id="AuditEvent.agent:user.role"> <path value="AuditEvent.agent.role" /> <short value="Professional role of the service provider" /> <definition value="Professional role of the service provider" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs" /> </binding> </element> <element id="AuditEvent.agent:user.role.coding"> <path value="AuditEvent.agent.role.coding" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.role.coding.system"> <path value="AuditEvent.agent.role.coding.system" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.role.coding.code"> <path value="AuditEvent.agent.role.coding.code" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.role.coding.display"> <path value="AuditEvent.agent.role.coding.display" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.who"> <path value="AuditEvent.agent.who" /> <short value="The subject Id of the IDToken" /> <definition value="The subject Id of the IDToken" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.who.identifier"> <path value="AuditEvent.agent.who.identifier" /> <min value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" /> <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" /> </type> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.altId"> <path value="AuditEvent.agent.altId" /> <short value="Alternative User identity (e.g. Telematik-ID or the KVNR)" /> <definition value="Alternative User identity (e.g. Telematik-ID or the KVNR)" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.name"> <path value="AuditEvent.agent.name" /> <short value="Name of HCP or Insurant" /> <definition value="Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/'" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:user.requestor"> <path value="AuditEvent.agent.requestor" /> <fixedBoolean value="true" /> </element> <element id="AuditEvent.agent:user.location"> <path value="AuditEvent.agent.location" /> <max value="0" /> </element> <element id="AuditEvent.agent:user.policy"> <path value="AuditEvent.agent.policy" /> <max value="0" /> </element> <element id="AuditEvent.agent:user.media"> <path value="AuditEvent.agent.media" /> <max value="0" /> </element> <element id="AuditEvent.agent:user.network"> <path value="AuditEvent.agent.network" /> <max value="0" /> </element> <element id="AuditEvent.agent:client"> <path value="AuditEvent.agent" /> <sliceName value="client" /> <short value="The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst" /> <definition value="The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.type"> <path value="AuditEvent.agent.type" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs" /> </binding> </element> <element id="AuditEvent.agent:client.role"> <path value="AuditEvent.agent.role" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.who"> <path value="AuditEvent.agent.who" /> <short value="The subject Id of the IDToken" /> <definition value="The subject Id of the IDToken" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.who.identifier"> <path value="AuditEvent.agent.who.identifier" /> <min value="1" /> <type> <code value="Identifier" /> <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" /> </type> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.altId"> <path value="AuditEvent.agent.altId" /> <short value="Alternative client identity (e.g. Telematik-ID))" /> <definition value="Alternative client identity (e.g. Telematik-ID)" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.name"> <path value="AuditEvent.agent.name" /> <short value="Name e.g. eRezept, EU access/country name or DiGA" /> <definition value="Name of a service e.g. eRezept, EU access/country name or DiGA" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:client.requestor"> <path value="AuditEvent.agent.requestor" /> <fixedBoolean value="true" /> </element> <element id="AuditEvent.agent:client.location"> <path value="AuditEvent.agent.location" /> <max value="0" /> </element> <element id="AuditEvent.agent:client.policy"> <path value="AuditEvent.agent.policy" /> <max value="0" /> </element> <element id="AuditEvent.agent:client.media"> <path value="AuditEvent.agent.media" /> <max value="0" /> </element> <element id="AuditEvent.agent:client.network"> <path value="AuditEvent.agent.network" /> <max value="0" /> </element> <element id="AuditEvent.agent:internal"> <path value="AuditEvent.agent" /> <sliceName value="internal" /> <short value="The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions" /> <definition value="The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions" /> <min value="0" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:internal.type"> <path value="AuditEvent.agent.type" /> <min value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" /> </binding> </element> <element id="AuditEvent.agent:internal.role"> <path value="AuditEvent.agent.role" /> <max value="0" /> </element> <element id="AuditEvent.agent:internal.altId"> <path value="AuditEvent.agent.altId" /> <short value="altId MUST be epa" /> <definition value="altId MUST be epa" /> <fixedString value="epa" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:internal.name"> <path value="AuditEvent.agent.name" /> <short value="Name MUST be ePA" /> <definition value="Name MUST be ePA" /> <min value="1" /> <fixedString value="ePA" /> <mustSupport value="true" /> </element> <element id="AuditEvent.agent:internal.requestor"> <path value="AuditEvent.agent.requestor" /> <fixedBoolean value="true" /> </element> <element id="AuditEvent.agent:internal.location"> <path value="AuditEvent.agent.location" /> <max value="0" /> </element> <element id="AuditEvent.agent:internal.policy"> <path value="AuditEvent.agent.policy" /> <max value="0" /> </element> <element id="AuditEvent.agent:internal.media"> <path value="AuditEvent.agent.media" /> <max value="0" /> </element> <element id="AuditEvent.agent:internal.network"> <path value="AuditEvent.agent.network" /> <max value="0" /> </element> <element id="AuditEvent.source"> <path value="AuditEvent.source" /> <mustSupport value="true" /> </element> <element id="AuditEvent.source.observer.display"> <path value="AuditEvent.source.observer.display" /> <fixedString value="Elektronische Patientenakte Fachdienst" /> </element> <element id="AuditEvent.source.type"> <path value="AuditEvent.source.type" /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> <binding> <strength value="required" /> <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" /> </binding> </element> <element id="AuditEvent.entity"> <path value="AuditEvent.entity" /> <min value="1" /> <mustSupport value="true" /> </element> <element id="AuditEvent.entity.what"> <path value="AuditEvent.entity.what" /> <max value="0" /> </element> <element id="AuditEvent.entity.type"> <path value="AuditEvent.entity.type" /> <max value="0" /> </element> <element id="AuditEvent.entity.role"> <path value="AuditEvent.entity.role" /> <max value="0" /> </element> <element id="AuditEvent.entity.lifecycle"> <path value="AuditEvent.entity.lifecycle" /> <max value="0" /> </element> <element id="AuditEvent.entity.securityLabel"> <path value="AuditEvent.entity.securityLabel" /> <max value="0" /> </element> <element id="AuditEvent.entity.name"> <path value="AuditEvent.entity.name" /> <short value="The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...)." /> <definition value="The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...)." /> <mustSupport value="true" /> </element> <element id="AuditEvent.entity.description"> <path value="AuditEvent.entity.description" /> <short value="The OperationId" /> <definition value="The OperationId" /> <mustSupport value="true" /> </element> <element id="AuditEvent.entity.query"> <path value="AuditEvent.entity.query" /> <max value="0" /> </element> <element id="AuditEvent.entity.detail"> <path value="AuditEvent.entity.detail" /> <mustSupport value="true" /> </element> <element id="AuditEvent.entity.detail.type"> <path value="AuditEvent.entity.detail.type" /> <short value="The Name of the property (e.g. Document Format, DocumentID, ...)." /> <definition value="The Name of the property (e.g. Document Format, DocumentID, ...)." /> <mustSupport value="true" /> </element> <element id="AuditEvent.entity.detail.value[x]"> <path value="AuditEvent.entity.detail.value[x]" /> <slicing> <discriminator> <type value="type" /> <path value="$this" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> </element> <element id="AuditEvent.entity.detail.value[x]:valueString"> <path value="AuditEvent.entity.detail.value[x]" /> <sliceName value="valueString" /> <short value="Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)" /> <definition value="Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)" /> <min value="1" /> <max value="1" /> <type> <code value="string" /> </type> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "epa-auditevent", "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent", "version": "1.1.0", "name": "EPAAuditEvent", "title": "AuditEvent for the ePA", "status": "active", "experimental": false, "date": "2024-08-14", "publisher": "gematik GmbH", "description": "Defines the data structure for audit events in the ePA system.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "AuditEvent", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent", "derivation": "constraint", "differential": { "element": [ { "id": "AuditEvent.type", "path": "AuditEvent.type", "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs" } }, { "id": "AuditEvent.subtype", "path": "AuditEvent.subtype", "max": "0" }, { "id": "AuditEvent.action", "path": "AuditEvent.action", "short": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E", "definition": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E", "min": 1, "mustSupport": true }, { "id": "AuditEvent.period", "path": "AuditEvent.period", "max": "0" }, { "id": "AuditEvent.recorded", "path": "AuditEvent.recorded", "mustSupport": true }, { "id": "AuditEvent.outcome", "path": "AuditEvent.outcome", "short": "success: 0; failure: 4; major failure: 12", "definition": "success: 0; failure: 4; major failure: 12", "min": 1, "mustSupport": true }, { "id": "AuditEvent.outcomeDesc", "path": "AuditEvent.outcomeDesc", "max": "0" }, { "id": "AuditEvent.purposeOfEvent", "path": "AuditEvent.purposeOfEvent", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs" } }, { "id": "AuditEvent.agent", "path": "AuditEvent.agent", "slicing": { "discriminator": [ { "type": "pattern", "path": "type" } ], "rules": "open" }, "mustSupport": true }, { "id": "AuditEvent.agent:user", "path": "AuditEvent.agent", "sliceName": "user", "short": "The agent user refers to the service provider (LE) or the service provider institution (LEI)", "definition": "The agent user refers to the service provider (LE) or the service provider institution (LEI)", "min": 0, "max": "1", "mustSupport": true }, { "id": "AuditEvent.agent:user.extension:healthcareFacilityType", "path": "AuditEvent.agent.extension", "sliceName": "healthcareFacilityType", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension" ] } ], "mustSupport": true }, { "id": "AuditEvent.agent:user.type", "path": "AuditEvent.agent.type", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs" } }, { "id": "AuditEvent.agent:user.role", "path": "AuditEvent.agent.role", "short": "Professional role of the service provider", "definition": "Professional role of the service provider", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs" } }, { "id": "AuditEvent.agent:user.role.coding", "path": "AuditEvent.agent.role.coding", "mustSupport": true }, { "id": "AuditEvent.agent:user.role.coding.system", "path": "AuditEvent.agent.role.coding.system", "min": 1, "mustSupport": true }, { "id": "AuditEvent.agent:user.role.coding.code", "path": "AuditEvent.agent.role.coding.code", "min": 1, "mustSupport": true }, { "id": "AuditEvent.agent:user.role.coding.display", "path": "AuditEvent.agent.role.coding.display", "mustSupport": true }, { "id": "AuditEvent.agent:user.who", "path": "AuditEvent.agent.who", "short": "The subject Id of the IDToken", "definition": "The subject Id of the IDToken", "mustSupport": true }, { "id": "AuditEvent.agent:user.who.identifier", "path": "AuditEvent.agent.who.identifier", "min": 1, "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id", "http://fhir.de/StructureDefinition/identifier-kvid-10" ] } ], "mustSupport": true }, { "id": "AuditEvent.agent:user.altId", "path": "AuditEvent.agent.altId", "short": "Alternative User identity (e.g. Telematik-ID or the KVNR)", "definition": "Alternative User identity (e.g. Telematik-ID or the KVNR)", "mustSupport": true }, { "id": "AuditEvent.agent:user.name", "path": "AuditEvent.agent.name", "short": "Name of HCP or Insurant", "definition": "Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/' ", "min": 1, "mustSupport": true }, { "id": "AuditEvent.agent:user.requestor", "path": "AuditEvent.agent.requestor", "fixedBoolean": true }, { "id": "AuditEvent.agent:user.location", "path": "AuditEvent.agent.location", "max": "0" }, { "id": "AuditEvent.agent:user.policy", "path": "AuditEvent.agent.policy", "max": "0" }, { "id": "AuditEvent.agent:user.media", "path": "AuditEvent.agent.media", "max": "0" }, { "id": "AuditEvent.agent:user.network", "path": "AuditEvent.agent.network", "max": "0" }, { "id": "AuditEvent.agent:client", "path": "AuditEvent.agent", "sliceName": "client", "short": "The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst", "definition": "The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst", "min": 0, "max": "1", "mustSupport": true }, { "id": "AuditEvent.agent:client.type", "path": "AuditEvent.agent.type", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs" } }, { "id": "AuditEvent.agent:client.role", "path": "AuditEvent.agent.role", "mustSupport": true }, { "id": "AuditEvent.agent:client.who", "path": "AuditEvent.agent.who", "short": "The subject Id of the IDToken", "definition": "The subject Id of the IDToken", "min": 1, "mustSupport": true }, { "id": "AuditEvent.agent:client.who.identifier", "path": "AuditEvent.agent.who.identifier", "min": 1, "type": [ { "code": "Identifier", "profile": [ "http://fhir.de/StructureDefinition/identifier-telematik-id" ] } ], "mustSupport": true }, { "id": "AuditEvent.agent:client.altId", "path": "AuditEvent.agent.altId", "short": "Alternative client identity (e.g. Telematik-ID))", "definition": "Alternative client identity (e.g. Telematik-ID)", "mustSupport": true }, { "id": "AuditEvent.agent:client.name", "path": "AuditEvent.agent.name", "short": "Name e.g. eRezept, EU access/country name or DiGA", "definition": "Name of a service e.g. eRezept, EU access/country name or DiGA", "min": 1, "mustSupport": true }, { "id": "AuditEvent.agent:client.requestor", "path": "AuditEvent.agent.requestor", "fixedBoolean": true }, { "id": "AuditEvent.agent:client.location", "path": "AuditEvent.agent.location", "max": "0" }, { "id": "AuditEvent.agent:client.policy", "path": "AuditEvent.agent.policy", "max": "0" }, { "id": "AuditEvent.agent:client.media", "path": "AuditEvent.agent.media", "max": "0" }, { "id": "AuditEvent.agent:client.network", "path": "AuditEvent.agent.network", "max": "0" }, { "id": "AuditEvent.agent:internal", "path": "AuditEvent.agent", "sliceName": "internal", "short": "The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions", "definition": "The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions", "min": 0, "max": "1", "mustSupport": true }, { "id": "AuditEvent.agent:internal.type", "path": "AuditEvent.agent.type", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" } }, { "id": "AuditEvent.agent:internal.role", "path": "AuditEvent.agent.role", "max": "0" }, { "id": "AuditEvent.agent:internal.altId", "path": "AuditEvent.agent.altId", "short": "altId MUST be epa", "definition": "altId MUST be epa", "fixedString": "epa", "mustSupport": true }, { "id": "AuditEvent.agent:internal.name", "path": "AuditEvent.agent.name", "short": "Name MUST be ePA", "definition": "Name MUST be ePA", "min": 1, "fixedString": "ePA", "mustSupport": true }, { "id": "AuditEvent.agent:internal.requestor", "path": "AuditEvent.agent.requestor", "fixedBoolean": true }, { "id": "AuditEvent.agent:internal.location", "path": "AuditEvent.agent.location", "max": "0" }, { "id": "AuditEvent.agent:internal.policy", "path": "AuditEvent.agent.policy", "max": "0" }, { "id": "AuditEvent.agent:internal.media", "path": "AuditEvent.agent.media", "max": "0" }, { "id": "AuditEvent.agent:internal.network", "path": "AuditEvent.agent.network", "max": "0" }, { "id": "AuditEvent.source", "path": "AuditEvent.source", "mustSupport": true }, { "id": "AuditEvent.source.observer.display", "path": "AuditEvent.source.observer.display", "fixedString": "Elektronische Patientenakte Fachdienst" }, { "id": "AuditEvent.source.type", "path": "AuditEvent.source.type", "min": 1, "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" } }, { "id": "AuditEvent.entity", "path": "AuditEvent.entity", "min": 1, "mustSupport": true }, { "id": "AuditEvent.entity.what", "path": "AuditEvent.entity.what", "max": "0" }, { "id": "AuditEvent.entity.type", "path": "AuditEvent.entity.type", "max": "0" }, { "id": "AuditEvent.entity.role", "path": "AuditEvent.entity.role", "max": "0" }, { "id": "AuditEvent.entity.lifecycle", "path": "AuditEvent.entity.lifecycle", "max": "0" }, { "id": "AuditEvent.entity.securityLabel", "path": "AuditEvent.entity.securityLabel", "max": "0" }, { "id": "AuditEvent.entity.name", "path": "AuditEvent.entity.name", "short": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).", "definition": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).", "mustSupport": true }, { "id": "AuditEvent.entity.description", "path": "AuditEvent.entity.description", "short": "The OperationId", "definition": "The OperationId", "mustSupport": true }, { "id": "AuditEvent.entity.query", "path": "AuditEvent.entity.query", "max": "0" }, { "id": "AuditEvent.entity.detail", "path": "AuditEvent.entity.detail", "mustSupport": true }, { "id": "AuditEvent.entity.detail.type", "path": "AuditEvent.entity.detail.type", "short": "The Name of the property (e.g. Document Format, DocumentID, ...).", "definition": "The Name of the property (e.g. Document Format, DocumentID, ...).", "mustSupport": true }, { "id": "AuditEvent.entity.detail.value[x]", "path": "AuditEvent.entity.detail.value[x]", "slicing": { "discriminator": [ { "type": "type", "path": "$this" } ], "ordered": false, "rules": "open" } }, { "id": "AuditEvent.entity.detail.value[x]:valueString", "path": "AuditEvent.entity.detail.value[x]", "sliceName": "valueString", "short": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)", "definition": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true } ] } }
Terminologie-Bindings
Path | Name | Strength | URL |
---|---|---|---|
AuditEvent.type | epa-auditevent-type-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs |
AuditEvent.purposeOfEvent | epa-auditevent-purpose-of-event-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs |
AuditEvent.agent.type | epa-audit-event-agent-type-user-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs |
AuditEvent.agent.role | epa-ehealth-dsi-healthcare-facility-type-vs | required | https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs |
AuditEvent.agent.type | epa-audit-event-agent-type-client-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs |
AuditEvent.agent.type | epa-auditevent-sourcetype-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs |
AuditEvent.source.type | epa-auditevent-sourcetype-vs | required | https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs |
Beispiele
Beispiel eines AuditEvent vom XDS Document Service:
{ "resourceType": "AuditEvent", "id": "86604fc1-b356-57e3-8738-8ef36c8d608c", "meta": { "versionId": "1", "lastUpdated": "2025-01-15T14:43:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" ] }, "source": { "observer": { "display": "Elektronische Patientenakte Fachdienst" }, "type": [ { "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs", "code": "XDSSVC", "display": "XDS Document Service" } ] }, "agent": [ { "requestor": true, "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass", "code": "PROV", "display": "healthcare provider" } ] }, "who": { "identifier": { "system": "https://gematik.de/fhir/sid/telematik-id", "value": "1-883110000092404" } }, "altId": "1-883110000092404", "name": "Praxis Dr. John Doe" } ], "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "document" }, "action": "U", "recorded": "2025-01-15T14:52:04.928Z", "outcome": "0", "entity": [ { "name": "Arztbrief4711", "description": "operation:provide-and-register-document-set-b", "detail": [ { "type": "DocumentFormatCode", "valueString": "urn:gematik:ig:Arztbrief:r3.1" } ] } ] }
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="86604fc1-b356-57e3-8738-8ef36c8d608c" /> <meta> <versionId value="1" /> <lastUpdated value="2025-01-15T14:43:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" /> </meta> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="document" /> </type> <action value="U" /> <recorded value="2025-01-15T14:52:04.928Z" /> <outcome value="0" /> <agent> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass" /> <code value="PROV" /> <display value="healthcare provider" /> </coding> </type> <who> <identifier> <system value="https://gematik.de/fhir/sid/telematik-id" /> <value value="1-883110000092404" /> </identifier> </who> <altId value="1-883110000092404" /> <name value="Praxis Dr. John Doe" /> <requestor value="true" /> </agent> <source> <observer> <display value="Elektronische Patientenakte Fachdienst" /> </observer> <type> <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" /> <code value="XDSSVC" /> <display value="XDS Document Service" /> </type> </source> <entity> <name value="Arztbrief4711" /> <description value="operation:provide-and-register-document-set-b" /> <detail> <type value="DocumentFormatCode" /> <valueString value="urn:gematik:ig:Arztbrief:r3.1" /> </detail> </entity> </AuditEvent>
Beispiel eines AuditEvent vom Medication Service für die Suche:
{ "resourceType": "AuditEvent", "id": "bbf292eb-665d-4724-a2bc-86fa93e89835", "meta": { "versionId": "1", "lastUpdated": "2025-01-15T14:43:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" ] }, "source": { "observer": { "display": "Elektronische Patientenakte Fachdienst" }, "type": [ { "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs", "code": "MEDICATIONSVC", "display": "Medication Service" } ] }, "agent": [ { "requestor": true, "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass", "code": "PROV", "display": "healthcare provider" } ] }, "who": { "identifier": { "system": "https://gematik.de/fhir/sid/telematik-id", "value": "1-883110000092404" } }, "altId": "1-883110000092404", "name": "Praxis Dr. John Doe" } ], "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest" }, "action": "R", "recorded": "2025-01-15T14:52:04.928Z", "outcome": "0", "entity": [ { "name": "MedicationRequest", "description": "Bundle:searchset", "detail": [ { "type": "date", "valueString": "2025-01-15" }, { "type": "_revinclude", "valueString": "MedicationDispense:prescription" } ] } ] }
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="bbf292eb-665d-4724-a2bc-86fa93e89835" /> <meta> <versionId value="1" /> <lastUpdated value="2025-01-15T14:43:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" /> </meta> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> </type> <action value="R" /> <recorded value="2025-01-15T14:52:04.928Z" /> <outcome value="0" /> <agent> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass" /> <code value="PROV" /> <display value="healthcare provider" /> </coding> </type> <who> <identifier> <system value="https://gematik.de/fhir/sid/telematik-id" /> <value value="1-883110000092404" /> </identifier> </who> <altId value="1-883110000092404" /> <name value="Praxis Dr. John Doe" /> <requestor value="true" /> </agent> <source> <observer> <display value="Elektronische Patientenakte Fachdienst" /> </observer> <type> <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" /> <code value="MEDICATIONSVC" /> <display value="Medication Service" /> </type> </source> <entity> <name value="MedicationRequest" /> <description value="Bundle:searchset" /> <detail> <type value="date" /> <valueString value="2025-01-15" /> </detail> <detail> <type value="_revinclude" /> <valueString value="MedicationDispense:prescription" /> </detail> </entity> </AuditEvent>
Beispiel eines AuditEvent vom Medication Service:
{ "resourceType": "AuditEvent", "id": "669699b2-f131-4097-b13d-71413a58aa92", "meta": { "versionId": "1", "lastUpdated": "2025-01-15T14:43:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" ] }, "source": { "observer": { "display": "Elektronische Patientenakte Fachdienst" }, "type": [ { "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs", "code": "MEDICATIONSVC", "display": "Medication Service" } ] }, "agent": [ { "requestor": true, "who": { "identifier": { "system": "https://gematik.de/fhir/sid/telematik-id", "value": "1-000000000000000" } }, "type": { "coding": [ { "system": "http://dicom.nema.org/resources/ontology/DCM", "code": "110150", "display": "Application" } ] }, "altId": "1-000000000000000", "name": "E-Rezept-Fachdienst" } ], "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest" }, "action": "E", "recorded": "2025-01-15T14:52:04.928Z", "outcome": "0", "entity": [ { "name": "MedicationCancelDispensation", "description": "operation:cancel-dispensation-erp" } ] }
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="669699b2-f131-4097-b13d-71413a58aa92" /> <meta> <versionId value="1" /> <lastUpdated value="2025-01-15T14:43:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" /> </meta> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> </type> <action value="E" /> <recorded value="2025-01-15T14:52:04.928Z" /> <outcome value="0" /> <agent> <type> <coding> <system value="http://dicom.nema.org/resources/ontology/DCM" /> <code value="110150" /> <display value="Application" /> </coding> </type> <who> <identifier> <system value="https://gematik.de/fhir/sid/telematik-id" /> <value value="1-000000000000000" /> </identifier> </who> <altId value="1-000000000000000" /> <name value="E-Rezept-Fachdienst" /> <requestor value="true" /> </agent> <source> <observer> <display value="Elektronische Patientenakte Fachdienst" /> </observer> <type> <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" /> <code value="MEDICATIONSVC" /> <display value="Medication Service" /> </type> </source> <entity> <name value="MedicationCancelDispensation" /> <description value="operation:cancel-dispensation-erp" /> </entity> </AuditEvent>
Beispiel eines AuditEvent für den EU-Zugriff:
{ "resourceType": "AuditEvent", "id": "589b9862-7935-42f5-a06b-11a6f35833ee", "meta": { "versionId": "1", "lastUpdated": "2025-07-15T14:43:33.244Z", "profile": [ "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" ] }, "source": { "observer": { "display": "Elektronische Patientenakte Fachdienst" }, "type": [ { "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs", "code": "XDSSVC", "display": "XDS Document Service" } ] }, "agent": [ { "requestor": true, "who": { "identifier": { "system": "https://gematik.de/fhir/sid/telematik-id", "value": "1-000000000000000" } }, "type": { "coding": [ { "system": "http://dicom.nema.org/resources/ontology/DCM", "code": "110150", "display": "Application" } ] }, "altId": "1-000000000000000", "name": "Portugal" }, { "requestor": true, "extension": [ { "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.2.9.6.2.7", "code": "221", "display": "Medical Doctors" } } ], "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass", "code": "PROV", "display": "healthcare provider" } ] }, "role": [ { "coding": [ { "system": "urn:oid:1.3.6.1.4.1.12559.11.10.1.3.2.2.2", "code": "Resident Physician", "display": "Resident Physician" } ] } ], "name": "Dr. Manuel Dos Santos / Clínica de Dos Santos" } ], "type": { "system": "http://terminology.hl7.org/CodeSystem/audit-event-type", "code": "rest" }, "action": "R", "recorded": "2025-07-15T14:52:04.928Z", "outcome": "0", "entity": [ { "name": "Patient Summary", "description": "operation:retrieve-document-set" } ] }
<AuditEvent xmlns="http://hl7.org/fhir"> <id value="589b9862-7935-42f5-a06b-11a6f35833ee" /> <meta> <versionId value="1" /> <lastUpdated value="2025-07-15T14:43:33.244Z" /> <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" /> </meta> <type> <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" /> <code value="rest" /> </type> <action value="R" /> <recorded value="2025-07-15T14:52:04.928Z" /> <outcome value="0" /> <agent> <type> <coding> <system value="http://dicom.nema.org/resources/ontology/DCM" /> <code value="110150" /> <display value="Application" /> </coding> </type> <who> <identifier> <system value="https://gematik.de/fhir/sid/telematik-id" /> <value value="1-000000000000000" /> </identifier> </who> <altId value="1-000000000000000" /> <name value="Portugal" /> <requestor value="true" /> </agent> <agent> <extension url="https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension"> <valueCoding> <system value="urn:oid:2.16.840.1.113883.2.9.6.2.7" /> <code value="221" /> <display value="Medical Doctors" /> </valueCoding> </extension> <type> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass" /> <code value="PROV" /> <display value="healthcare provider" /> </coding> </type> <role> <coding> <system value="urn:oid:1.3.6.1.4.1.12559.11.10.1.3.2.2.2" /> <code value="Resident Physician" /> <display value="Resident Physician" /> </coding> </role> <name value="Dr. Manuel Dos Santos / Clínica de Dos Santos" /> <requestor value="true" /> </agent> <source> <observer> <display value="Elektronische Patientenakte Fachdienst" /> </observer> <type> <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" /> <code value="XDSSVC" /> <display value="XDS Document Service" /> </type> </source> <entity> <name value="Patient Summary" /> <description value="operation:retrieve-document-set" /> </entity> </AuditEvent>