Implementation Guide
TIFlow - Kernfunktionalitäten
Version 2.0.0-ballot.2 - ballot

Resource Profile: TI Audit Event Rest

Official URL: https://gematik.de/fhir/tiflow/StructureDefinition/audit-event-rest Version: 2.0.0-ballot.2
Active as of 2026-06-01 Computable Name: TIFlowAuditEventRest

Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

Das AuditEvent-Profil für die Protokollierung des Zugriffs auf einen FHIR Data Service der Telematikinfrastruktur (TI)

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Fixed Value: As shown (RESTful Operation)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..0 string Representation defined by the system
.... userSelected 0..0 boolean If this coding was chosen directly by the user
.... system Σ 1..1 uri Identity of the terminology system
.... code Σ 1..1 code Symbol in syntax defined by the system
... action SΣ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... recorded Σ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value SΣ 1..1 string The value that is unique
Example General: 123456
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:client 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/sid/telematik-id
....... value SΣ 1..1 string The value that is unique
Example General: 123456
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
..... requestor Σ 1..1 boolean Whether user is initiator
... source S 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 1..1 string Logical source location within the enterprise
.... observer ΣC 1..1 Reference(Device) The identity of source detecting the event
Constraints: ref-1
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for entity SC 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... entity:patient C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
.... entity:task C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... identifier SΣ 1..1 EPrescriptionId Logical reference, when literal reference is not known
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
.... entity:service C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
..... name SΣC 1..1 string Name des FHIR Data Service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG
AuditEvent.agent:client.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
AuditEvent.agent:internal.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error AuditEvent.agent:user.who, AuditEvent.agent:client.who, AuditEvent.source.observer, AuditEvent.entity:patient.what, AuditEvent.entity:task.what SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sev-1 error AuditEvent.entity, AuditEvent.entity:patient, AuditEvent.entity:task, AuditEvent.entity:service Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type S 1..1 Coding Type/identifier of event
Fixed Value: As shown (RESTful Operation)
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... system 1..1 uri Identity of the terminology system
.... code 1..1 code Symbol in syntax defined by the system
... subtype S 0..* Coding More specific type/id for the event
... action S 0..1 code Type of action performed during the event
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... type S 1..1 CodeableConcept How agent participated
...... coding
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system
.... agent:user 0..1 BackboneElement Actor involved in the event
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
..... who
...... identifier S 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... value S 1..1 string The value that is unique
.... agent:client 0..1 BackboneElement Actor involved in the event
..... type 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
..... who
...... identifier S 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... value S 1..1 string The value that is unique
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
... source S 1..1 BackboneElement Audit Event Reporter
.... site S 1..1 string Logical source location within the enterprise
.... observer 1..1 Reference(Device) The identity of source detecting the event
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for entity S 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
.... entity:All Slices Content/Rules for all slices
..... type S 1..1 Coding Type of entity involved
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
.... entity:patient 1..1 BackboneElement Data or objects used
..... what
...... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
.... entity:task 0..1 BackboneElement Data or objects used
..... what
...... identifier S 1..1 EPrescriptionId Logical reference, when literal reference is not known
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
.... entity:service 0..1 BackboneElement Data or objects used
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
..... name S 1..1 string Name des FHIR Data Service

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Fixed Value: As shown (RESTful Operation)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..0 string Representation defined by the system
.... userSelected 0..0 boolean If this coding was chosen directly by the user
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subtype SΣ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
... action SΣ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period C 0..1 Period When the activity occurred
Constraints: per-1
... recorded Σ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:client 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/sid/telematik-id
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
..... altId 0..1 string Alternative User identity
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
... source S 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 1..1 string Logical source location within the enterprise
.... observer ΣC 1..1 Reference(Device) The identity of source detecting the event
Constraints: ref-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity SC 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:task C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 EPrescriptionId Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:service C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name SΣC 1..1 string Name des FHIR Data Service
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG
AuditEvent.agent:client.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
AuditEvent.agent:client.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:internal.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.source.observer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error AuditEvent.period, AuditEvent.agent:user.who.identifier.period, AuditEvent.agent:client.who.identifier.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.agent:user.who, AuditEvent.agent:user.who.identifier.assigner, AuditEvent.agent:user.location, AuditEvent.agent:client.who, AuditEvent.agent:client.who.identifier.assigner, AuditEvent.agent:client.location, AuditEvent.agent:internal.who, AuditEvent.agent:internal.location, AuditEvent.source.observer, AuditEvent.entity.what, AuditEvent.entity:patient.what, AuditEvent.entity:task.what, AuditEvent.entity:service.what SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sev-1 error AuditEvent.entity, AuditEvent.entity:patient, AuditEvent.entity:task, AuditEvent.entity:service Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.agent
  • The element 1 is sliced based on the value of AuditEvent.entity

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Fixed Value: As shown (RESTful Operation)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..0 string Representation defined by the system
.... userSelected 0..0 boolean If this coding was chosen directly by the user
.... system Σ 1..1 uri Identity of the terminology system
.... code Σ 1..1 code Symbol in syntax defined by the system
... action SΣ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... recorded Σ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:user 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value SΣ 1..1 string The value that is unique
Example General: 123456
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:client 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/sid/telematik-id
....... value SΣ 1..1 string The value that is unique
Example General: 123456
..... requestor Σ 1..1 boolean Whether user is initiator
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
..... requestor Σ 1..1 boolean Whether user is initiator
... source S 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 1..1 string Logical source location within the enterprise
.... observer ΣC 1..1 Reference(Device) The identity of source detecting the event
Constraints: ref-1
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for entity SC 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... entity:patient C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
.... entity:task C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... identifier SΣ 1..1 EPrescriptionId Logical reference, when literal reference is not known
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
.... entity:service C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
..... name SΣC 1..1 string Name des FHIR Data Service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG
AuditEvent.agent:client.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
AuditEvent.agent:internal.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
ref-1 error AuditEvent.agent:user.who, AuditEvent.agent:client.who, AuditEvent.source.observer, AuditEvent.entity:patient.what, AuditEvent.entity:task.what SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sev-1 error AuditEvent.entity, AuditEvent.entity:patient, AuditEvent.entity:task, AuditEvent.entity:service Either a name or a query (NOT both) name.empty() or query.empty()

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type S 1..1 Coding Type/identifier of event
Fixed Value: As shown (RESTful Operation)
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... system 1..1 uri Identity of the terminology system
.... code 1..1 code Symbol in syntax defined by the system
... subtype S 0..* Coding More specific type/id for the event
... action S 0..1 code Type of action performed during the event
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... type S 1..1 CodeableConcept How agent participated
...... coding
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system
.... agent:user 0..1 BackboneElement Actor involved in the event
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
..... who
...... identifier S 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... value S 1..1 string The value that is unique
.... agent:client 0..1 BackboneElement Actor involved in the event
..... type 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
..... who
...... identifier S 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... value S 1..1 string The value that is unique
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... type
...... coding
....... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
... source S 1..1 BackboneElement Audit Event Reporter
.... site S 1..1 string Logical source location within the enterprise
.... observer 1..1 Reference(Device) The identity of source detecting the event
..... reference 1..1 string Literal reference, Relative, internal or absolute URL
... Slices for entity S 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
.... entity:All Slices Content/Rules for all slices
..... type S 1..1 Coding Type of entity involved
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
.... entity:patient 1..1 BackboneElement Data or objects used
..... what
...... identifier S 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
.... entity:task 0..1 BackboneElement Data or objects used
..... what
...... identifier S 1..1 EPrescriptionId Logical reference, when literal reference is not known
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
.... entity:service 0..1 BackboneElement Data or objects used
..... type
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
..... name S 1..1 string Name des FHIR Data Service

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... type SΣ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Fixed Value: As shown (RESTful Operation)
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..0 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..0 string Representation defined by the system
.... userSelected 0..0 boolean If this coding was chosen directly by the user
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system Σ 1..1 uri Identity of the terminology system
.... version Σ 0..1 string Version of the system - if relevant
.... code Σ 1..1 code Symbol in syntax defined by the system
.... display Σ 0..1 string Representation defined by the system
.... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... subtype SΣ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
... action SΣ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
... period C 0..1 Period When the activity occurred
Constraints: per-1
... recorded Σ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: humanuser
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:client 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: TIFlow AuditEvent Agent Type ValueSet (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM|01
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 110150
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
........ coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
......... id 0..1 string Unique id for inter-element referencing
......... extension 0..* Extension Additional content defined by implementations
......... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
......... version 0..1 string Version of the system - if relevant
......... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRN
......... display 0..1 string Representation defined by the system
......... userSelected 0..1 boolean If this coding was chosen directly by the user
........ text 0..1 string Plain text representation of the concept
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://gematik.de/fhir/sid/telematik-id
....... value SΣ 1..1 string The value that is unique
Example General: 123456
....... period ΣC 0..1 Period Time period when id is/was valid for use
Constraints: per-1
....... assigner ΣC 0..1 Reference(Organization) Organization that issued id (may be just text)
Constraints: ref-1
...... display Σ 0..1 string Text alternative for the resource
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
.... agent:internal 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/extra-security-role-type
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: dataprocessor
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who ΣC 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
Constraints: ref-1
..... altId 0..1 string Alternative User identity
..... name S 1..1 string Name des FHIR Data Service
Required Pattern: TI-Flow-Fachdienst
..... requestor Σ 1..1 boolean Whether user is initiator
..... location C 0..1 Reference(Location) Where
Constraints: ref-1
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
... source S 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 1..1 string Logical source location within the enterprise
.... observer ΣC 1..1 Reference(Device) The identity of source detecting the event
Constraints: ref-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity SC 1..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:patient C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 IdentifierKvid10 Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Patient
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:task C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier SΣ 1..1 EPrescriptionId Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: Task
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:service C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what ΣC 0..1 Reference(Resource) Specific instance of resource
Constraints: ref-1
..... type S 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Required Pattern: 4
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name SΣC 1..1 string Name des FHIR Data Service
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:user.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​who.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:client.​type Base required TIFlow AuditEvent Agent Type ValueSet 📦2.0.0-ballot.2 This IG
AuditEvent.agent:client.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​who.identifier.type Base extensible Identifier Type DeBasis ValueSet 📦1.5.4 de.basisprofil.r4 v1.5
AuditEvent.agent:client.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.agent:internal.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:internal.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.2
AuditEvent.source.observer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:patient.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:task.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:service.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
per-1 error AuditEvent.period, AuditEvent.agent:user.who.identifier.period, AuditEvent.agent:client.who.identifier.period If present, start SHALL have a lower value than end start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1 error AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.agent:user.who, AuditEvent.agent:user.who.identifier.assigner, AuditEvent.agent:user.location, AuditEvent.agent:client.who, AuditEvent.agent:client.who.identifier.assigner, AuditEvent.agent:client.location, AuditEvent.agent:internal.who, AuditEvent.agent:internal.location, AuditEvent.source.observer, AuditEvent.entity.what, AuditEvent.entity:patient.what, AuditEvent.entity:task.what, AuditEvent.entity:service.what SHALL have a contained resource if a local reference is provided reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
sev-1 error AuditEvent.entity, AuditEvent.entity:patient, AuditEvent.entity:task, AuditEvent.entity:service Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 8 elements(12 nested mandatory elements)
Must-Support: 22 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.agent
  • The element 1 is sliced based on the value of AuditEvent.entity

 

Other representations of profile: CSV, Excel, Schematron