EPAAuditEvent

Das Profil EPAAuditEvent wird von dem ePA Audit Event Service verwendet, um Protokolleinträge an den ePA-Client bereitzustellen. Dieses Profil stellt sicher, dass alle relevanten Ereignisse im Zusammenhang mit der Nutzung der ePA korrekt und umfassend dokumentiert werden, um den Anforderungen an Datenschutz und Nachvollziehbarkeit gerecht zu werden.

Profile

AuditEvent for the ePA

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
typeΣ1..1CodingBinding
subtypeΣ0..0CodingBinding
actionS Σ1..1codeBinding
periodI0..0Period
recordedS Σ1..1instant
outcomeS Σ1..1codeBinding
outcomeDescΣ0..0string
purposeOfEventS Σ0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type0..1CodeableConceptBinding
role0..*CodeableConcept
whoΣ I0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
altId0..1string
name0..1string
requestorΣ1..1boolean
locationI0..1Reference(Location)
policy0..*uri
media0..1CodingBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
address0..1string
type0..1codeBinding
purposeOfUse0..*CodeableConceptBinding
id0..1string
healthcareFacilityTypeS I0..1Extension(Coding)
modifierExtensionΣ ?! I0..*Extension
typeS1..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierS Σ1..1IdentifierTelematikId, IdentifierKvid10
displayΣ0..1string
altIdS0..1string
nameS1..1string
requestorΣ1..1booleanFixed Value
locationI0..0Reference(Location)
policy0..0uri
media0..0CodingBinding
purposeOfUse0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeS1..1CodeableConceptBinding
roleS0..*CodeableConcept
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierS Σ1..1IdentifierTelematikId
displayΣ0..1string
altIdS0..1string
nameS1..1string
requestorΣ1..1booleanFixed Value
locationI0..0Reference(Location)
policy0..0uri
media0..0CodingBinding
purposeOfUse0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeS1..1CodeableConceptBinding
role0..0CodeableConcept
whoΣ I0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
altIdS0..1stringFixed Value
nameS1..1stringFixed Value
requestorΣ1..1booleanFixed Value
locationI0..0Reference(Location)
policy0..0uri
media0..0CodingBinding
purposeOfUse0..*CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
site0..1string
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1stringFixed Value
typeS1..1CodingBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
whatΣ I0..0Reference(Resource)
type0..0CodingBinding
role0..0CodingBinding
lifecycle0..0CodingBinding
securityLabel0..0CodingBinding
nameS Σ I0..1string
descriptionS0..1string
queryΣ I0..0base64Binary
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeS1..1string
valueBase64Binarybase64Binary
valueStringS1..1string
AuditEvent
DefinitionA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
Cardinality0...*
Comments

Based on IHE-ATNA.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-3: 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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • rim: ControlAct[moodCode=EVN]
  • dicom: Message
AuditEvent.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

AuditEvent.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AuditEvent.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
AuditEvent.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
AuditEvent.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
AuditEvent.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.type
DefinitionIdentifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
Cardinality1...1
TypeCoding
Binding

Type of event.

EPAAuditEventTypeVS (required)
SummaryTrue
Requirements

This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • workflow: Event.code
  • w5: FiveWs.what[x]
  • rim: .code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom: EventId
  • w3c.prov: Activity
AuditEvent.subtype
DefinitionIdentifier for the category of event.
Cardinality0...0
TypeCoding
Binding

Sub-type of event.

AuditEventSub-Type (extensible)
SummaryTrue
Requirements

This field enables queries of messages by implementation-defined event categories.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.what[x]
  • rim: .code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom: EventTypeCode
AuditEvent.action
DefinitionType of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E
Cardinality1...1
Typecode
Binding

Indicator for type of action performed during the event that generated the event.

AuditEventAction (required)
Must SupportTrue
SummaryTrue
Requirements

This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • rim: .code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom: EventActionCode
AuditEvent.period
DefinitionThe period during which the activity occurred.
Cardinality0...0
TypePeriod
Comments

The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • workflow: Event.occurred[x]
  • w5: FiveWs.done[x]
  • rim: ./effectiveTime[type=IVL_TS]
  • dicom: EventDateTime
  • w3c.prov: Activity.startTime & Activity.endTime
  • fhirprovenance: Provenance.occurred[x]
AuditEvent.recorded
DefinitionThe time when the event was recorded.
Cardinality1...1
Typeinstant
Must SupportTrue
SummaryTrue
Requirements

This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution.

Comments

In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.recorded
  • rim: .effectiveTime
  • w3c.prov: Activity.when
  • fhirprovenance: Provenance.recorded
AuditEvent.outcome
Definitionsuccess: 0; failure: 4; major failure: 12
Cardinality1...1
Typecode
Binding

Indicates whether the event succeeded or failed.

AuditEventOutcome (required)
Must SupportTrue
SummaryTrue
Comments

In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • rim: .actionNegationInd
  • dicom: EventOutcomeIndicator
AuditEvent.outcomeDesc
DefinitionA free text description of the outcome of the event.
Cardinality0...0
Typestring
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • rim: .outboundRelationship[typeCode=OUT].target.text
  • dicom: EventOutcomeDescription
AuditEvent.purposeOfEvent
DefinitionThe purposeOfUse (reason) that was used during the event being recorded.
Cardinality0...*
TypeCodeableConcept
Binding

The reason the activity took place.

EPAAuditEventPurposeOfEventVS (required)
Must SupportTrue
SummaryTrue
Comments

Use AuditEvent.agent.purposeOfUse when you know that it is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.reasonCode
  • w5: FiveWs.why[x]
  • rim: * .reasonCode [ControlActReason when Act.class = CACT Control Act] *.outboundRelationship[typeCode=RSON].target
  • dicom: EventPurposeOfUse
  • w3c.prov: Activity.Activity
  • fhirprovenance: Provenance.reason, Provenance.activity
AuditEvent.agent
DefinitionAn actor taking an active role in the event or activity that is logged.
Cardinality1...*
TypeBackboneElement
Must SupportTrue
AliasActiveParticipant
Requirements

An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.

Comments

Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.

For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.

SlicingUnordered, Open, by type(Pattern)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer
  • w5: FiveWs.who
  • rim: .participation
  • dicom: ActiveParticipant
  • w3c.prov: Agent
  • fhirprovenance: Provenance.agent
AuditEvent.agent.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent.type
DefinitionSpecification of the participation type the user plays when performing the event.
Cardinality0...1
TypeCodeableConcept
Binding

The Participation type of the agent to the event.

ParticipationRoleType (extensible)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.performer.function
  • w5: FiveWs.who
  • rim: .typeCode and/or .functionCode
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.type
AuditEvent.agent.role
DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
Cardinality0...*
TypeCodeableConcept
Binding

What security role enabled the agent to participate in the event.

SecurityRoleType (example)
Requirements

This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.

Comments

Should be roles relevant to the event. Should not be an exhaustive list of roles.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.who
  • rim: .role
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.role
AuditEvent.agent.who
DefinitionReference to who this agent is that was involved in the event.
Cardinality0...1
TypeReference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
SummaryTrue
AliasuserId
Requirements

This field ties an audit event to a specific resource or identifier.

Comments

Where a User ID is available it will go into who.identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.who
  • rim: .id
  • dicom: UserId
  • w3c.prov: Agent.Identity
  • fhirprovenance: Provenance.agent.who
AuditEvent.agent.altId
DefinitionAlternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
Cardinality0...1
Typestring
Requirements

In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .id (distinguish id type by root)
  • dicom: AlternativeUserId
  • w3c.prov: Agent.Identity
AuditEvent.agent.name
DefinitionHuman-meaningful name for the agent.
Cardinality0...1
Typestring
Requirements

The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .name
  • dicom: UserName
  • w3c.prov: Agent.Identity
AuditEvent.agent.requestor
DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited.
Cardinality1...1
Typeboolean
SummaryTrue
Requirements

This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.

Comments

There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: If participation.typeCode was author, then true
  • dicom: UserIsRequestor
AuditEvent.agent.location
DefinitionWhere the event occurred.
Cardinality0...1
TypeReference(Location)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.location
  • w5: FiveWs.where[x]
  • rim: * Role.Class =SDLOC *Role.Code = ServiceDeliveryLocationRoleType *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC *EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant.
  • w3c.prov: Activity.location
  • fhirprovenance: Provenance.location
AuditEvent.agent.policy
DefinitionThe policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Cardinality0...*
Typeuri
Requirements

This value is used retrospectively to determine the authorization policies.

Comments

For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.why[x]
  • rim: ActPolicyType
  • dicom: ParticipantRoleIDCode
  • fhirprovenance: Provenance.policy
AuditEvent.agent.media
DefinitionType of media involved. Used when the event is about exporting/importing onto media.
Cardinality0...1
TypeCoding
Binding

Used when the event is about exporting/importing onto media.

MediaTypeCode (extensible)
Requirements

Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.where[x]
  • rim: .player.description.mediaType
  • dicom: MediaType
AuditEvent.agent.network
DefinitionLogical network location for application activity, if the activity has a network location.
Cardinality0...1
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: .player.description.reference
AuditEvent.agent.network.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent.network.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent.network.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent.network.address
DefinitionAn identifier for the network access point of the user device for the audit event.
Cardinality0...1
Typestring
Requirements

This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.

Comments

This could be a device id, IP address or some other identifier associated with a device.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointID
  • w3c.prov: Agent.Location
AuditEvent.agent.network.type
DefinitionAn identifier for the type of network access point that originated the audit event.
Cardinality0...1
Typecode
Binding

The type of network access point of this agent in the audit event.

AuditEventAgentNetworkType (required)
Requirements

This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointTypeCode
AuditEvent.agent.purposeOfUse
DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded.
Cardinality0...*
TypeCodeableConcept
Binding

The reason the activity took place.

v3.PurposeOfUse (extensible)
Comments

Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • rim: *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target
  • w3c.prov: Agent.Activity
AuditEvent.agent:user
DefinitionThe agent user refers to the service provider (LE) or the service provider institution (LEI)
Cardinality0...1
TypeBackboneElement
Must SupportTrue
AliasActiveParticipant
Requirements

An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.

Comments

Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.

For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer
  • w5: FiveWs.who
  • rim: .participation
  • dicom: ActiveParticipant
  • w3c.prov: Agent
  • fhirprovenance: Provenance.agent
AuditEvent.agent:user.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:user.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.extension:healthcareFacilityType
DefinitionEPAHealthcareFacilityType Extension
Cardinality0...1
TypeExtension(Coding)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.type
DefinitionSpecification of the participation type the user plays when performing the event.
Cardinality1...1
TypeCodeableConcept
Binding

The Participation type of the agent to the event.

EPAAuditEventAgentTypeUserVS (required)
Must SupportTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.performer.function
  • w5: FiveWs.who
  • rim: .typeCode and/or .functionCode
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.type
AuditEvent.agent:user.role
DefinitionProfessional role of the service provider
Cardinality0...*
TypeCodeableConcept
Binding

What security role enabled the agent to participate in the event.

EPAEHealthDSIHealthcareFacilityTypeVS (required)
Must SupportTrue
Requirements

This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.

Comments

Should be roles relevant to the event. Should not be an exhaustive list of roles.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.who
  • rim: .role
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.role
AuditEvent.agent:user.role.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:user.role.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.role.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...*
TypeCoding
Must SupportTrue
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
AuditEvent.agent:user.role.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:user.role.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.role.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AuditEvent.agent:user.role.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AuditEvent.agent:user.role.coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
AuditEvent.agent:user.role.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
AuditEvent.agent:user.role.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AuditEvent.agent:user.role.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
AuditEvent.agent:user.who
DefinitionThe subject Id of the IDToken
Cardinality0...1
TypeReference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
Must SupportTrue
SummaryTrue
AliasuserId
Requirements

This field ties an audit event to a specific resource or identifier.

Comments

Where a User ID is available it will go into who.identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.who
  • rim: .id
  • dicom: UserId
  • w3c.prov: Agent.Identity
  • fhirprovenance: Provenance.agent.who
AuditEvent.agent:user.who.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:user.who.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.who.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.who.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.who.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality1...1
TypeIdentifierTelematikId, IdentifierKvid10
Must SupportTrue
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
AuditEvent.agent:user.who.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.altId
DefinitionAlternative User identity (e.g. Telematik-ID or the KVNR)
Cardinality0...1
Typestring
Must SupportTrue
Requirements

In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .id (distinguish id type by root)
  • dicom: AlternativeUserId
  • w3c.prov: Agent.Identity
AuditEvent.agent:user.name
DefinitionName of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/'
Cardinality1...1
Typestring
Must SupportTrue
Requirements

The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .name
  • dicom: UserName
  • w3c.prov: Agent.Identity
AuditEvent.agent:user.requestor
DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited.
Cardinality1...1
Typeboolean
SummaryTrue
Requirements

This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.

Comments

There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

true

Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: If participation.typeCode was author, then true
  • dicom: UserIsRequestor
AuditEvent.agent:user.location
DefinitionWhere the event occurred.
Cardinality0...0
TypeReference(Location)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.location
  • w5: FiveWs.where[x]
  • rim: * Role.Class =SDLOC *Role.Code = ServiceDeliveryLocationRoleType *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC *EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant.
  • w3c.prov: Activity.location
  • fhirprovenance: Provenance.location
AuditEvent.agent:user.policy
DefinitionThe policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Cardinality0...0
Typeuri
Requirements

This value is used retrospectively to determine the authorization policies.

Comments

For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.why[x]
  • rim: ActPolicyType
  • dicom: ParticipantRoleIDCode
  • fhirprovenance: Provenance.policy
AuditEvent.agent:user.media
DefinitionType of media involved. Used when the event is about exporting/importing onto media.
Cardinality0...0
TypeCoding
Binding

Used when the event is about exporting/importing onto media.

MediaTypeCode (extensible)
Requirements

Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.where[x]
  • rim: .player.description.mediaType
  • dicom: MediaType
AuditEvent.agent:user.network
DefinitionLogical network location for application activity, if the activity has a network location.
Cardinality0...0
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: .player.description.reference
AuditEvent.agent:user.network.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:user.network.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.network.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:user.network.address
DefinitionAn identifier for the network access point of the user device for the audit event.
Cardinality0...1
Typestring
Requirements

This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.

Comments

This could be a device id, IP address or some other identifier associated with a device.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointID
  • w3c.prov: Agent.Location
AuditEvent.agent:user.network.type
DefinitionAn identifier for the type of network access point that originated the audit event.
Cardinality0...1
Typecode
Binding

The type of network access point of this agent in the audit event.

AuditEventAgentNetworkType (required)
Requirements

This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointTypeCode
AuditEvent.agent:user.purposeOfUse
DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded.
Cardinality0...*
TypeCodeableConcept
Binding

The reason the activity took place.

v3.PurposeOfUse (extensible)
Comments

Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • rim: *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target
  • w3c.prov: Agent.Activity
AuditEvent.agent:client
DefinitionThe agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
Cardinality0...1
TypeBackboneElement
Must SupportTrue
AliasActiveParticipant
Requirements

An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.

Comments

Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.

For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer
  • w5: FiveWs.who
  • rim: .participation
  • dicom: ActiveParticipant
  • w3c.prov: Agent
  • fhirprovenance: Provenance.agent
AuditEvent.agent:client.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:client.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.type
DefinitionSpecification of the participation type the user plays when performing the event.
Cardinality1...1
TypeCodeableConcept
Binding

The Participation type of the agent to the event.

EPAAuditEventAgentTypeClientVS (required)
Must SupportTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.performer.function
  • w5: FiveWs.who
  • rim: .typeCode and/or .functionCode
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.type
AuditEvent.agent:client.role
DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
Cardinality0...*
TypeCodeableConcept
Binding

What security role enabled the agent to participate in the event.

SecurityRoleType (example)
Must SupportTrue
Requirements

This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.

Comments

Should be roles relevant to the event. Should not be an exhaustive list of roles.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.who
  • rim: .role
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.role
AuditEvent.agent:client.who
DefinitionThe subject Id of the IDToken
Cardinality1...1
TypeReference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
Must SupportTrue
SummaryTrue
AliasuserId
Requirements

This field ties an audit event to a specific resource or identifier.

Comments

Where a User ID is available it will go into who.identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.who
  • rim: .id
  • dicom: UserId
  • w3c.prov: Agent.Identity
  • fhirprovenance: Provenance.agent.who
AuditEvent.agent:client.who.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:client.who.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.who.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.who.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.who.identifier
DefinitionAn identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.
Cardinality1...1
TypeIdentifierTelematikId
Must SupportTrue
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
AuditEvent.agent:client.who.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.altId
DefinitionAlternative client identity (e.g. Telematik-ID)
Cardinality0...1
Typestring
Must SupportTrue
Requirements

In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .id (distinguish id type by root)
  • dicom: AlternativeUserId
  • w3c.prov: Agent.Identity
AuditEvent.agent:client.name
DefinitionName of a service e.g. eRezept, EU access/country name or DiGA
Cardinality1...1
Typestring
Must SupportTrue
Requirements

The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .name
  • dicom: UserName
  • w3c.prov: Agent.Identity
AuditEvent.agent:client.requestor
DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited.
Cardinality1...1
Typeboolean
SummaryTrue
Requirements

This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.

Comments

There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

true

Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: If participation.typeCode was author, then true
  • dicom: UserIsRequestor
AuditEvent.agent:client.location
DefinitionWhere the event occurred.
Cardinality0...0
TypeReference(Location)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.location
  • w5: FiveWs.where[x]
  • rim: * Role.Class =SDLOC *Role.Code = ServiceDeliveryLocationRoleType *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC *EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant.
  • w3c.prov: Activity.location
  • fhirprovenance: Provenance.location
AuditEvent.agent:client.policy
DefinitionThe policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Cardinality0...0
Typeuri
Requirements

This value is used retrospectively to determine the authorization policies.

Comments

For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.why[x]
  • rim: ActPolicyType
  • dicom: ParticipantRoleIDCode
  • fhirprovenance: Provenance.policy
AuditEvent.agent:client.media
DefinitionType of media involved. Used when the event is about exporting/importing onto media.
Cardinality0...0
TypeCoding
Binding

Used when the event is about exporting/importing onto media.

MediaTypeCode (extensible)
Requirements

Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.where[x]
  • rim: .player.description.mediaType
  • dicom: MediaType
AuditEvent.agent:client.network
DefinitionLogical network location for application activity, if the activity has a network location.
Cardinality0...0
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: .player.description.reference
AuditEvent.agent:client.network.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:client.network.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.network.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:client.network.address
DefinitionAn identifier for the network access point of the user device for the audit event.
Cardinality0...1
Typestring
Requirements

This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.

Comments

This could be a device id, IP address or some other identifier associated with a device.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointID
  • w3c.prov: Agent.Location
AuditEvent.agent:client.network.type
DefinitionAn identifier for the type of network access point that originated the audit event.
Cardinality0...1
Typecode
Binding

The type of network access point of this agent in the audit event.

AuditEventAgentNetworkType (required)
Requirements

This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointTypeCode
AuditEvent.agent:client.purposeOfUse
DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded.
Cardinality0...*
TypeCodeableConcept
Binding

The reason the activity took place.

v3.PurposeOfUse (extensible)
Comments

Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • rim: *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target
  • w3c.prov: Agent.Activity
AuditEvent.agent:internal
DefinitionThe agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
Cardinality0...1
TypeBackboneElement
Must SupportTrue
AliasActiveParticipant
Requirements

An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.

Comments

Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.

For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer
  • w5: FiveWs.who
  • rim: .participation
  • dicom: ActiveParticipant
  • w3c.prov: Agent
  • fhirprovenance: Provenance.agent
AuditEvent.agent:internal.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:internal.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:internal.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:internal.type
DefinitionSpecification of the participation type the user plays when performing the event.
Cardinality1...1
TypeCodeableConcept
Binding

The Participation type of the agent to the event.

EPAAuditEventSourceTypeVS (required)
Must SupportTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Event.performer.function
  • w5: FiveWs.who
  • rim: .typeCode and/or .functionCode
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.type
AuditEvent.agent:internal.role
DefinitionThe security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
Cardinality0...0
TypeCodeableConcept
Binding

What security role enabled the agent to participate in the event.

SecurityRoleType (example)
Requirements

This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories.

Comments

Should be roles relevant to the event. Should not be an exhaustive list of roles.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.who
  • rim: .role
  • dicom: RoleIdCode
  • w3c.prov: Agent.Attribution
  • fhirprovenance: Provenance.agent.role
AuditEvent.agent:internal.who
DefinitionReference to who this agent is that was involved in the event.
Cardinality0...1
TypeReference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
SummaryTrue
AliasuserId
Requirements

This field ties an audit event to a specific resource or identifier.

Comments

Where a User ID is available it will go into who.identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.performer.actor
  • w5: FiveWs.who
  • rim: .id
  • dicom: UserId
  • w3c.prov: Agent.Identity
  • fhirprovenance: Provenance.agent.who
AuditEvent.agent:internal.altId
DefinitionaltId MUST be epa
Cardinality0...1
Typestring
Must SupportTrue
Requirements

In some situations, a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

epa

Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .id (distinguish id type by root)
  • dicom: AlternativeUserId
  • w3c.prov: Agent.Identity
AuditEvent.agent:internal.name
DefinitionName MUST be ePA
Cardinality1...1
Typestring
Must SupportTrue
Requirements

The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

ePA

Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: .name
  • dicom: UserName
  • w3c.prov: Agent.Identity
AuditEvent.agent:internal.requestor
DefinitionIndicator that the user is or is not the requestor, or initiator, for the event being audited.
Cardinality1...1
Typeboolean
SummaryTrue
Requirements

This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user.

Comments

There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

true

Mappings
  • rim: n/a
  • w5: FiveWs.who
  • rim: If participation.typeCode was author, then true
  • dicom: UserIsRequestor
AuditEvent.agent:internal.location
DefinitionWhere the event occurred.
Cardinality0...0
TypeReference(Location)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • workflow: Event.location
  • w5: FiveWs.where[x]
  • rim: * Role.Class =SDLOC *Role.Code = ServiceDeliveryLocationRoleType *Entity.Code = PlaceEntityType = df.Types of places for Entity.Class = PLC *EntityClass = PLC = df.A physical place or site with its containing structure. May be natural or man-made. The geographic position of a place might or might not be constant.
  • w3c.prov: Activity.location
  • fhirprovenance: Provenance.location
AuditEvent.agent:internal.policy
DefinitionThe policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
Cardinality0...0
Typeuri
Requirements

This value is used retrospectively to determine the authorization policies.

Comments

For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.why[x]
  • rim: ActPolicyType
  • dicom: ParticipantRoleIDCode
  • fhirprovenance: Provenance.policy
AuditEvent.agent:internal.media
DefinitionType of media involved. Used when the event is about exporting/importing onto media.
Cardinality0...0
TypeCoding
Binding

Used when the event is about exporting/importing onto media.

MediaTypeCode (extensible)
Requirements

Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD).

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.where[x]
  • rim: .player.description.mediaType
  • dicom: MediaType
AuditEvent.agent:internal.network
DefinitionLogical network location for application activity, if the activity has a network location.
Cardinality0...0
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: .player.description.reference
AuditEvent.agent:internal.network.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.agent:internal.network.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:internal.network.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.agent:internal.network.address
DefinitionAn identifier for the network access point of the user device for the audit event.
Cardinality0...1
Typestring
Requirements

This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers.

Comments

This could be a device id, IP address or some other identifier associated with a device.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointID
  • w3c.prov: Agent.Location
AuditEvent.agent:internal.network.type
DefinitionAn identifier for the type of network access point that originated the audit event.
Cardinality0...1
Typecode
Binding

The type of network access point of this agent in the audit event.

AuditEventAgentNetworkType (required)
Requirements

This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.where[x]
  • rim: pre-coordinated into URL
  • dicom: NetworkAccessPointTypeCode
AuditEvent.agent:internal.purposeOfUse
DefinitionThe reason (purpose of use), specific to this agent, that was used during the event being recorded.
Cardinality0...*
TypeCodeableConcept
Binding

The reason the activity took place.

v3.PurposeOfUse (extensible)
Comments

Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • w5: FiveWs.why[x]
  • rim: *.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target
  • w3c.prov: Agent.Activity
AuditEvent.source
DefinitionThe system that is reporting the event.
Cardinality1...1
TypeBackboneElement
Must SupportTrue
Requirements

The event is reported by one source.

Comments

Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.witness
  • rim: .participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]
  • dicom: AuditSourceIdentification
AuditEvent.source.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.source.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.site
DefinitionLogical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
Cardinality0...1
Typestring
Requirements

This value differentiates among the sites in a multi-site enterprise health information system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.witness
  • rim: .scopedRole[classCode=LOCE].player.desc
  • dicom: AuditEnterpriseSiteId
AuditEvent.source.observer
DefinitionIdentifier of the source where the event was detected.
Cardinality1...1
TypeReference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)
SummaryTrue
AliasSourceId
Requirements

This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.witness
  • rim: .id
  • dicom: AuditSourceId
AuditEvent.source.observer.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.source.observer.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.observer.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality0...1
Typestring
SummaryTrue
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.observer.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.observer.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • rim: .identifier
AuditEvent.source.observer.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

Elektronische Patientenakte Fachdienst

Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.source.type
DefinitionCode specifying the type of source where event originated.
Cardinality1...1
TypeCoding
Binding

Code specifying the type of system that detected and recorded the event.

EPAAuditEventSourceTypeVS (required)
Must SupportTrue
Requirements

This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.witness
  • rim: .code
  • dicom: AuditSourceTypeCode
AuditEvent.entity
DefinitionSpecific instances of data or objects that have been accessed.
Cardinality1...*
TypeBackboneElement
Must SupportTrue
AliasParticipantObject
Requirements

The event may have other entities involved.

Comments

Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • sev-1: Either a name or a query (NOT both)
    name.empty() or query.empty()
Mappings
  • rim: n/a
  • w5: FiveWs.what[x]
  • rim: .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
  • dicom: ParticipantObjectIdentification
  • w3c.prov: Entity
  • fhirprovenance: Provenance.target, Provenance.entity
AuditEvent.entity.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.entity.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.entity.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.entity.what
DefinitionIdentifies a specific instance of the entity. The reference should be version specific.
Cardinality0...0
TypeReference(Resource)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: 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'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • w5: FiveWs.what[x]
  • rim: .id
  • dicom: ParticipantObjectID and ParticipantObjectIDTypeCode
  • fhirprovenance: Provenance.target, Provenance.entity.what
AuditEvent.entity.type
DefinitionThe type of the object that was involved in this audit event.
Cardinality0...0
TypeCoding
Binding

Code for the entity type involved in the audit event.

AuditEventEntityType (extensible)
Requirements

To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action.

Comments

This value is distinct from the user's role or any user relationship to the entity.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.what[x]
  • rim: [self::Act].code or role.player.code
  • dicom: ParticipantObjectTypeCode
  • w3c.prov: Entity.type
  • fhirprovenance: Provenance.entity.type
AuditEvent.entity.role
DefinitionCode representing the role the entity played in the event being audited.
Cardinality0...0
TypeCoding
Binding

Code representing the role the entity played in the audit event.

AuditEventEntityRole (extensible)
Requirements

For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.

Comments

Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.context
  • rim: role.code (not sure what this would mean for an Act)
  • dicom: ParticipantObjectTypeCodeRole
  • w3c.prov: Entity.role
AuditEvent.entity.lifecycle
DefinitionIdentifier for the data life-cycle stage for the entity.
Cardinality0...0
TypeCoding
Binding

Identifier for the data life-cycle stage for the entity.

ObjectLifecycleEvents (extensible)
Requirements

Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases.

Comments

This can be used to provide an audit trail for data, over time, as it passes through the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.context
  • rim: target of ObservationEvent[code="lifecycle"].value
  • dicom: ParticipantObjectDataLifeCycle
  • w3c.prov: Entity.role
  • fhirprovenance: Provenance.entity.role
AuditEvent.entity.securityLabel
DefinitionSecurity labels for the identified entity.
Cardinality0...0
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
Requirements

This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.

Comments

Copied from entity meta security tags.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
  • rim: CV
  • orim: fhir:Coding rdfs:subClassOf dt:CDCoding
  • w5: FiveWs.context
  • rim: .confidentialityCode
  • dicom: ParticipantObjectSensitivity
AuditEvent.entity.name
DefinitionThe title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Requirements

Use only where entity can't be identified with an identifier.

Comments

This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .title
  • dicom: ParticipantObjectName
  • w3c.prov: Entity.Label
AuditEvent.entity.description
DefinitionThe OperationId
Cardinality0...1
Typestring
Must SupportTrue
Requirements

Use only where entity can't be identified with an identifier.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .text
  • dicom: ParticipantObjectDescription
AuditEvent.entity.query
DefinitionThe query parameters for a query-type entities.
Cardinality0...0
Typebase64Binary
SummaryTrue
Requirements

For query events, it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.

Comments

The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: No mapping
  • dicom: ParticipantObjectQuery
AuditEvent.entity.detail
DefinitionTagged value pairs for conveying additional information about the entity.
Cardinality0...*
TypeBackboneElement
Must SupportTrue
Requirements

Implementation-defined data about specific details of the object accessed or used.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom: ParticipantObjectDetail
AuditEvent.entity.detail.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AuditEvent.entity.detail.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.entity.detail.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AuditEvent.entity.detail.type
DefinitionThe Name of the property (e.g. Document Format, DocumentID, ...).
Cardinality1...1
Typestring
Must SupportTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .code
  • dicom: ParticipantObjectDetail.type
AuditEvent.entity.detail.value[x]
DefinitionThe value of the extra detail.
Cardinality1...1
Typestring
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.

SlicingUnordered, Open, by $this(Type)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .value
  • dicom: ParticipantObjectDetail.value
AuditEvent.entity.detail.value[x]:valueString
DefinitionProperty value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Cardinality1...1
Typestring
Must SupportTrue
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • w5: FiveWs.context
  • rim: .value
  • dicom: ParticipantObjectDetail.value
<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="epa-auditevent" />
    <url value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" />
    <version value="1.1.0" />
    <name value="EPAAuditEvent" />
    <title value="AuditEvent for the ePA" />
    <status value="active" />
    <experimental value="false" />
    <date value="2024-08-14" />
    <publisher value="gematik GmbH" />
    <description value="Defines the data structure for audit events in the ePA system." />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="AuditEvent" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AuditEvent" />
    <derivation value="constraint" />
    <differential>
        <element id="AuditEvent.type">
            <path value="AuditEvent.type" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs" />
            </binding>
        </element>
        <element id="AuditEvent.subtype">
            <path value="AuditEvent.subtype" />
            <max value="0" />
        </element>
        <element id="AuditEvent.action">
            <path value="AuditEvent.action" />
            <short value="Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E" />
            <definition value="Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.period">
            <path value="AuditEvent.period" />
            <max value="0" />
        </element>
        <element id="AuditEvent.recorded">
            <path value="AuditEvent.recorded" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.outcome">
            <path value="AuditEvent.outcome" />
            <short value="success: 0; failure: 4; major failure: 12" />
            <definition value="success: 0; failure: 4; major failure: 12" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.outcomeDesc">
            <path value="AuditEvent.outcomeDesc" />
            <max value="0" />
        </element>
        <element id="AuditEvent.purposeOfEvent">
            <path value="AuditEvent.purposeOfEvent" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent">
            <path value="AuditEvent.agent" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="type" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user">
            <path value="AuditEvent.agent" />
            <sliceName value="user" />
            <short value="The agent user refers to the service provider (LE) or the service provider institution (LEI)" />
            <definition value="The agent user refers to the service provider (LE) or the service provider institution (LEI)" />
            <min value="0" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.extension:healthcareFacilityType">
            <path value="AuditEvent.agent.extension" />
            <sliceName value="healthcareFacilityType" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.type">
            <path value="AuditEvent.agent.type" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent:user.role">
            <path value="AuditEvent.agent.role" />
            <short value="Professional role of the service provider" />
            <definition value="Professional role of the service provider" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent:user.role.coding">
            <path value="AuditEvent.agent.role.coding" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.role.coding.system">
            <path value="AuditEvent.agent.role.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.role.coding.code">
            <path value="AuditEvent.agent.role.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.role.coding.display">
            <path value="AuditEvent.agent.role.coding.display" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.who">
            <path value="AuditEvent.agent.who" />
            <short value="The subject Id of the IDToken" />
            <definition value="The subject Id of the IDToken" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.who.identifier">
            <path value="AuditEvent.agent.who.identifier" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.altId">
            <path value="AuditEvent.agent.altId" />
            <short value="Alternative User identity (e.g. Telematik-ID or the KVNR)" />
            <definition value="Alternative User identity (e.g. Telematik-ID or the KVNR)" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.name">
            <path value="AuditEvent.agent.name" />
            <short value="Name of HCP or Insurant" />
            <definition value="Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a &#39;/&#39;" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:user.requestor">
            <path value="AuditEvent.agent.requestor" />
            <fixedBoolean value="true" />
        </element>
        <element id="AuditEvent.agent:user.location">
            <path value="AuditEvent.agent.location" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:user.policy">
            <path value="AuditEvent.agent.policy" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:user.media">
            <path value="AuditEvent.agent.media" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:user.network">
            <path value="AuditEvent.agent.network" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:client">
            <path value="AuditEvent.agent" />
            <sliceName value="client" />
            <short value="The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst" />
            <definition value="The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst" />
            <min value="0" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.type">
            <path value="AuditEvent.agent.type" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent:client.role">
            <path value="AuditEvent.agent.role" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.who">
            <path value="AuditEvent.agent.who" />
            <short value="The subject Id of the IDToken" />
            <definition value="The subject Id of the IDToken" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.who.identifier">
            <path value="AuditEvent.agent.who.identifier" />
            <min value="1" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-telematik-id" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.altId">
            <path value="AuditEvent.agent.altId" />
            <short value="Alternative client identity (e.g. Telematik-ID))" />
            <definition value="Alternative client identity (e.g. Telematik-ID)" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.name">
            <path value="AuditEvent.agent.name" />
            <short value="Name e.g. eRezept, EU access/country name or DiGA" />
            <definition value="Name of a service e.g. eRezept, EU access/country name or DiGA" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:client.requestor">
            <path value="AuditEvent.agent.requestor" />
            <fixedBoolean value="true" />
        </element>
        <element id="AuditEvent.agent:client.location">
            <path value="AuditEvent.agent.location" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:client.policy">
            <path value="AuditEvent.agent.policy" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:client.media">
            <path value="AuditEvent.agent.media" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:client.network">
            <path value="AuditEvent.agent.network" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:internal">
            <path value="AuditEvent.agent" />
            <sliceName value="internal" />
            <short value="The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions" />
            <definition value="The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions" />
            <min value="0" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:internal.type">
            <path value="AuditEvent.agent.type" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent:internal.role">
            <path value="AuditEvent.agent.role" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:internal.altId">
            <path value="AuditEvent.agent.altId" />
            <short value="altId MUST be epa" />
            <definition value="altId MUST be epa" />
            <fixedString value="epa" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:internal.name">
            <path value="AuditEvent.agent.name" />
            <short value="Name MUST be ePA" />
            <definition value="Name MUST be ePA" />
            <min value="1" />
            <fixedString value="ePA" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent:internal.requestor">
            <path value="AuditEvent.agent.requestor" />
            <fixedBoolean value="true" />
        </element>
        <element id="AuditEvent.agent:internal.location">
            <path value="AuditEvent.agent.location" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:internal.policy">
            <path value="AuditEvent.agent.policy" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:internal.media">
            <path value="AuditEvent.agent.media" />
            <max value="0" />
        </element>
        <element id="AuditEvent.agent:internal.network">
            <path value="AuditEvent.agent.network" />
            <max value="0" />
        </element>
        <element id="AuditEvent.source">
            <path value="AuditEvent.source" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.source.observer.display">
            <path value="AuditEvent.source.observer.display" />
            <fixedString value="Elektronische Patientenakte Fachdienst" />
        </element>
        <element id="AuditEvent.source.type">
            <path value="AuditEvent.source.type" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs" />
            </binding>
        </element>
        <element id="AuditEvent.entity">
            <path value="AuditEvent.entity" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.what">
            <path value="AuditEvent.entity.what" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.type">
            <path value="AuditEvent.entity.type" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.role">
            <path value="AuditEvent.entity.role" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.lifecycle">
            <path value="AuditEvent.entity.lifecycle" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.securityLabel">
            <path value="AuditEvent.entity.securityLabel" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.name">
            <path value="AuditEvent.entity.name" />
            <short value="The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...)." />
            <definition value="The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...)." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.description">
            <path value="AuditEvent.entity.description" />
            <short value="The OperationId" />
            <definition value="The OperationId" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.query">
            <path value="AuditEvent.entity.query" />
            <max value="0" />
        </element>
        <element id="AuditEvent.entity.detail">
            <path value="AuditEvent.entity.detail" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.detail.type">
            <path value="AuditEvent.entity.detail.type" />
            <short value="The Name of the property (e.g. Document Format, DocumentID, ...)." />
            <definition value="The Name of the property (e.g. Document Format, DocumentID, ...)." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.detail.value[x]">
            <path value="AuditEvent.entity.detail.value[x]" />
            <slicing>
                <discriminator>
                    <type value="type" />
                    <path value="$this" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
        </element>
        <element id="AuditEvent.entity.detail.value[x]:valueString">
            <path value="AuditEvent.entity.detail.value[x]" />
            <sliceName value="valueString" />
            <short value="Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)" />
            <definition value="Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="string" />
            </type>
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "id": "epa-auditevent",
    "url": "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent",
    "version": "1.1.0",
    "name": "EPAAuditEvent",
    "title": "AuditEvent for the ePA",
    "status": "active",
    "experimental": false,
    "date": "2024-08-14",
    "publisher": "gematik GmbH",
    "description": "Defines the data structure for audit events in the ePA system.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AuditEvent",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AuditEvent",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AuditEvent.type",
                "path": "AuditEvent.type",
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs"
                }
            },
            {
                "id": "AuditEvent.subtype",
                "path": "AuditEvent.subtype",
                "max": "0"
            },
            {
                "id": "AuditEvent.action",
                "path": "AuditEvent.action",
                "short": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E",
                "definition": "Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.period",
                "path": "AuditEvent.period",
                "max": "0"
            },
            {
                "id": "AuditEvent.recorded",
                "path": "AuditEvent.recorded",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.outcome",
                "path": "AuditEvent.outcome",
                "short": "success: 0; failure: 4; major failure: 12",
                "definition": "success: 0; failure: 4; major failure: 12",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.outcomeDesc",
                "path": "AuditEvent.outcomeDesc",
                "max": "0"
            },
            {
                "id": "AuditEvent.purposeOfEvent",
                "path": "AuditEvent.purposeOfEvent",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs"
                }
            },
            {
                "id": "AuditEvent.agent",
                "path": "AuditEvent.agent",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "type"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user",
                "path": "AuditEvent.agent",
                "sliceName": "user",
                "short": "The agent user refers to the service provider (LE) or the service provider institution (LEI)",
                "definition": "The agent user refers to the service provider (LE) or the service provider institution (LEI)",
                "min": 0,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.extension:healthcareFacilityType",
                "path": "AuditEvent.agent.extension",
                "sliceName": "healthcareFacilityType",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.type",
                "path": "AuditEvent.agent.type",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs"
                }
            },
            {
                "id": "AuditEvent.agent:user.role",
                "path": "AuditEvent.agent.role",
                "short": "Professional role of the service provider",
                "definition": "Professional role of the service provider",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs"
                }
            },
            {
                "id": "AuditEvent.agent:user.role.coding",
                "path": "AuditEvent.agent.role.coding",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.role.coding.system",
                "path": "AuditEvent.agent.role.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.role.coding.code",
                "path": "AuditEvent.agent.role.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.role.coding.display",
                "path": "AuditEvent.agent.role.coding.display",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.who",
                "path": "AuditEvent.agent.who",
                "short": "The subject Id of the IDToken",
                "definition": "The subject Id of the IDToken",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.who.identifier",
                "path": "AuditEvent.agent.who.identifier",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-telematik-id",
                            "http://fhir.de/StructureDefinition/identifier-kvid-10"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.altId",
                "path": "AuditEvent.agent.altId",
                "short": "Alternative User identity (e.g. Telematik-ID or the KVNR)",
                "definition": "Alternative User identity (e.g. Telematik-ID or the KVNR)",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.name",
                "path": "AuditEvent.agent.name",
                "short": "Name of HCP or Insurant",
                "definition": "Name of HCP or Insurant, in case of EU-access provide the name of the practitioner and the organization separated by a '/' ",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:user.requestor",
                "path": "AuditEvent.agent.requestor",
                "fixedBoolean": true
            },
            {
                "id": "AuditEvent.agent:user.location",
                "path": "AuditEvent.agent.location",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:user.policy",
                "path": "AuditEvent.agent.policy",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:user.media",
                "path": "AuditEvent.agent.media",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:user.network",
                "path": "AuditEvent.agent.network",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:client",
                "path": "AuditEvent.agent",
                "sliceName": "client",
                "short": "The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst",
                "definition": "The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst",
                "min": 0,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.type",
                "path": "AuditEvent.agent.type",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs"
                }
            },
            {
                "id": "AuditEvent.agent:client.role",
                "path": "AuditEvent.agent.role",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.who",
                "path": "AuditEvent.agent.who",
                "short": "The subject Id of the IDToken",
                "definition": "The subject Id of the IDToken",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.who.identifier",
                "path": "AuditEvent.agent.who.identifier",
                "min": 1,
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-telematik-id"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.altId",
                "path": "AuditEvent.agent.altId",
                "short": "Alternative client identity (e.g. Telematik-ID))",
                "definition": "Alternative client identity (e.g. Telematik-ID)",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.name",
                "path": "AuditEvent.agent.name",
                "short": "Name e.g. eRezept, EU access/country name or DiGA",
                "definition": "Name of a service e.g. eRezept, EU access/country name or DiGA",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:client.requestor",
                "path": "AuditEvent.agent.requestor",
                "fixedBoolean": true
            },
            {
                "id": "AuditEvent.agent:client.location",
                "path": "AuditEvent.agent.location",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:client.policy",
                "path": "AuditEvent.agent.policy",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:client.media",
                "path": "AuditEvent.agent.media",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:client.network",
                "path": "AuditEvent.agent.network",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:internal",
                "path": "AuditEvent.agent",
                "sliceName": "internal",
                "short": "The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions",
                "definition": "The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions",
                "min": 0,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:internal.type",
                "path": "AuditEvent.agent.type",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs"
                }
            },
            {
                "id": "AuditEvent.agent:internal.role",
                "path": "AuditEvent.agent.role",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:internal.altId",
                "path": "AuditEvent.agent.altId",
                "short": "altId MUST be epa",
                "definition": "altId MUST be epa",
                "fixedString": "epa",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:internal.name",
                "path": "AuditEvent.agent.name",
                "short": "Name MUST be ePA",
                "definition": "Name MUST be ePA",
                "min": 1,
                "fixedString": "ePA",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent:internal.requestor",
                "path": "AuditEvent.agent.requestor",
                "fixedBoolean": true
            },
            {
                "id": "AuditEvent.agent:internal.location",
                "path": "AuditEvent.agent.location",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:internal.policy",
                "path": "AuditEvent.agent.policy",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:internal.media",
                "path": "AuditEvent.agent.media",
                "max": "0"
            },
            {
                "id": "AuditEvent.agent:internal.network",
                "path": "AuditEvent.agent.network",
                "max": "0"
            },
            {
                "id": "AuditEvent.source",
                "path": "AuditEvent.source",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.source.observer.display",
                "path": "AuditEvent.source.observer.display",
                "fixedString": "Elektronische Patientenakte Fachdienst"
            },
            {
                "id": "AuditEvent.source.type",
                "path": "AuditEvent.source.type",
                "min": 1,
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs"
                }
            },
            {
                "id": "AuditEvent.entity",
                "path": "AuditEvent.entity",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.what",
                "path": "AuditEvent.entity.what",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.type",
                "path": "AuditEvent.entity.type",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.role",
                "path": "AuditEvent.entity.role",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.lifecycle",
                "path": "AuditEvent.entity.lifecycle",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.securityLabel",
                "path": "AuditEvent.entity.securityLabel",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.name",
                "path": "AuditEvent.entity.name",
                "short": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).",
                "definition": "The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.description",
                "path": "AuditEvent.entity.description",
                "short": "The OperationId",
                "definition": "The OperationId",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.query",
                "path": "AuditEvent.entity.query",
                "max": "0"
            },
            {
                "id": "AuditEvent.entity.detail",
                "path": "AuditEvent.entity.detail",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.detail.type",
                "path": "AuditEvent.entity.detail.type",
                "short": "The Name of the property (e.g. Document Format, DocumentID, ...).",
                "definition": "The Name of the property (e.g. Document Format, DocumentID, ...).",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.detail.value[x]",
                "path": "AuditEvent.entity.detail.value[x]",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "type",
                            "path": "$this"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "AuditEvent.entity.detail.value[x]:valueString",
                "path": "AuditEvent.entity.detail.value[x]",
                "sliceName": "valueString",
                "short": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)",
                "definition": "Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mustSupport": true
            }
        ]
    }
}

Terminologie-Bindings

PathNameStrengthURL
AuditEvent.typeepa-auditevent-type-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
AuditEvent.purposeOfEventepa-auditevent-purpose-of-event-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
AuditEvent.agent.typeepa-audit-event-agent-type-user-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
AuditEvent.agent.roleepa-ehealth-dsi-healthcare-facility-type-vsrequiredhttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent.typeepa-audit-event-agent-type-client-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
AuditEvent.agent.typeepa-auditevent-sourcetype-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs
AuditEvent.source.typeepa-auditevent-sourcetype-vsrequiredhttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs

Beispiele

Beispiel eines AuditEvent vom XDS Document Service:

{
    "resourceType": "AuditEvent",
    "id": "86604fc1-b356-57e3-8738-8ef36c8d608c",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2025-01-15T14:43:33.244Z",
        "profile":  [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent"
        ]
    },
    "source": {
        "observer": {
            "display": "Elektronische Patientenakte Fachdienst"
        },
        "type":  [
            {
                "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs",
                "code": "XDSSVC",
                "display": "XDS Document Service"
            }
        ]
    },
    "agent":  [
        {
            "requestor": true,
            "type": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
                        "code": "PROV",
                        "display": "healthcare provider"
                    }
                ]
            },
            "who": {
                "identifier": {
                    "system": "https://gematik.de/fhir/sid/telematik-id",
                    "value": "1-883110000092404"
                }
            },
            "altId": "1-883110000092404",
            "name": "Praxis Dr. John Doe"
        }
    ],
    "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
        "code": "document"
    },
    "action": "U",
    "recorded": "2025-01-15T14:52:04.928Z",
    "outcome": "0",
    "entity":  [
        {
            "name": "Arztbrief4711",
            "description": "operation:provide-and-register-document-set-b",
            "detail":  [
                {
                    "type": "DocumentFormatCode",
                    "valueString": "urn:gematik:ig:Arztbrief:r3.1"
                }
            ]
        }
    ]
}
<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="86604fc1-b356-57e3-8738-8ef36c8d608c" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2025-01-15T14:43:33.244Z" />
        <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" />
    </meta>
    <type>
        <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" />
        <code value="document" />
    </type>
    <action value="U" />
    <recorded value="2025-01-15T14:52:04.928Z" />
    <outcome value="0" />
    <agent>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass" />
                <code value="PROV" />
                <display value="healthcare provider" />
            </coding>
        </type>
        <who>
            <identifier>
                <system value="https://gematik.de/fhir/sid/telematik-id" />
                <value value="1-883110000092404" />
            </identifier>
        </who>
        <altId value="1-883110000092404" />
        <name value="Praxis Dr. John Doe" />
        <requestor value="true" />
    </agent>
    <source>
        <observer>
            <display value="Elektronische Patientenakte Fachdienst" />
        </observer>
        <type>
            <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" />
            <code value="XDSSVC" />
            <display value="XDS Document Service" />
        </type>
    </source>
    <entity>
        <name value="Arztbrief4711" />
        <description value="operation:provide-and-register-document-set-b" />
        <detail>
            <type value="DocumentFormatCode" />
            <valueString value="urn:gematik:ig:Arztbrief:r3.1" />
        </detail>
    </entity>
</AuditEvent>

Beispiel eines AuditEvent vom Medication Service für die Suche:

{
    "resourceType": "AuditEvent",
    "id": "bbf292eb-665d-4724-a2bc-86fa93e89835",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2025-01-15T14:43:33.244Z",
        "profile":  [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent"
        ]
    },
    "source": {
        "observer": {
            "display": "Elektronische Patientenakte Fachdienst"
        },
        "type":  [
            {
                "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs",
                "code": "MEDICATIONSVC",
                "display": "Medication Service"
            }
        ]
    },
    "agent":  [
        {
            "requestor": true,
            "type": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
                        "code": "PROV",
                        "display": "healthcare provider"
                    }
                ]
            },
            "who": {
                "identifier": {
                    "system": "https://gematik.de/fhir/sid/telematik-id",
                    "value": "1-883110000092404"
                }
            },
            "altId": "1-883110000092404",
            "name": "Praxis Dr. John Doe"
        }
    ],
    "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
        "code": "rest"
    },
    "action": "R",
    "recorded": "2025-01-15T14:52:04.928Z",
    "outcome": "0",
    "entity":  [
        {
            "name": "MedicationRequest",
            "description": "Bundle:searchset",
            "detail":  [
                {
                    "type": "date",
                    "valueString": "2025-01-15"
                },
                {
                    "type": "_revinclude",
                    "valueString": "MedicationDispense:prescription"
                }
            ]
        }
    ]
}
<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="bbf292eb-665d-4724-a2bc-86fa93e89835" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2025-01-15T14:43:33.244Z" />
        <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" />
    </meta>
    <type>
        <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" />
        <code value="rest" />
    </type>
    <action value="R" />
    <recorded value="2025-01-15T14:52:04.928Z" />
    <outcome value="0" />
    <agent>
        <type>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/v3-RoleClass" />
                <code value="PROV" />
                <display value="healthcare provider" />
            </coding>
        </type>
        <who>
            <identifier>
                <system value="https://gematik.de/fhir/sid/telematik-id" />
                <value value="1-883110000092404" />
            </identifier>
        </who>
        <altId value="1-883110000092404" />
        <name value="Praxis Dr. John Doe" />
        <requestor value="true" />
    </agent>
    <source>
        <observer>
            <display value="Elektronische Patientenakte Fachdienst" />
        </observer>
        <type>
            <system value="https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs" />
            <code value="MEDICATIONSVC" />
            <display value="Medication Service" />
        </type>
    </source>
    <entity>
        <name value="MedicationRequest" />
        <description value="Bundle:searchset" />
        <detail>
            <type value="date" />
            <valueString value="2025-01-15" />
        </detail>
        <detail>
            <type value="_revinclude" />
            <valueString value="MedicationDispense:prescription" />
        </detail>
    </entity>
</AuditEvent>

Beispiel eines AuditEvent vom Medication Service:

{
    "resourceType": "AuditEvent",
    "id": "669699b2-f131-4097-b13d-71413a58aa92",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2025-01-15T14:43:33.244Z",
        "profile":  [
            "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent"
        ]
    },
    "source": {
        "observer": {
            "display": "Elektronische Patientenakte Fachdienst"
        },
        "type":  [
            {
                "system": "https://gematik.de/fhir/epa/CodeSystem/epa-auditevent-sourcetype-cs",
                "code": "MEDICATIONSVC",
                "display": "Medication Service"
            }
        ]
    },
    "agent":  [
        {
            "requestor": true,
            "who": {
                "identifier": {
                    "system": "https://gematik.de/fhir/sid/telematik-id",
                    "value": "1-000000000000000"
                }
            },
            "type": {
                "coding":  [
                    {
                        "system": "http://dicom.nema.org/resources/ontology/DCM",
                        "code": "110150",
                        "display": "Application"
                    }
                ]
            },
            "altId": "1-000000000000000",
            "name": "E-Rezept-Fachdienst"
        }
    ],
    "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
        "code": "rest"
    },
    "action": "E",
    "recorded": "2025-01-15T14:52:04.928Z",
    "outcome": "0",
    "entity":  [
        {
            "name": "MedicationCancelDispensation",
            "description": "operation:cancel-dispensation-erp"
        }
    ]
}
<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="669699b2-f131-4097-b13d-71413a58aa92" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2025-01-15T14:43:33.244Z" />
        <profile value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent" />
    </meta>
    <type>
        <system value="http://terminology.hl7.org/CodeSystem/audit-event-type" />
        <code value="rest" />
    </type>
    <action value="E" />
    <recorded value="2025-01-15T14:52:04.928Z" />
    <outcome value="0" />
    <agent>
        <type>
            <coding>
                <system value="http://dicom.nema.org/resources/ontology/DCM" />
                <code value="110150" />
                <display value="Application" />
            </coding>
        </type>
        <who>
            <identifier>
                <system value="https://gematik.de/fhir/sid/telematik-id" />
                <value value="1-000000000000000" />
            </identifier>
        </who>
        <altId value="1-000000000000000" />
        <