Implementierungsleitfaden Digitale Patientenrechnung

DiPagNutzungsprotokoll (AuditEvent)

DiPagNutzungsprotokoll (AuditEvent)

Digitale Patientenrechnung Nutzungsprotokoll

Metadaten

Canonical	https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll
Status	active
Version	1.1.0-rc2
Basis	http://hl7.org/fhir/StructureDefinition/AuditEvent

Inhalt

DiPagNutzungsprotokoll (AuditEvent)	I		AuditEvent	There are no (further) constraints on this element Element id AuditEvent Short description Event record kept for security purposes Definition A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. Comments Based on IHE-ATNA. Data type AuditEvent Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` dom-6: A resource should have narrative for robust management text.`div`.exists() Mappings rim: Entity. Role, or Act workflow: Event rim: ControlAct[moodCode=EVN] dicom: Message
id	Σ	0..1	string	There are no (further) constraints on this element Element id AuditEvent.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id AuditEvent.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id AuditEvent.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id AuditEvent.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id AuditEvent.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id AuditEvent.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. 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. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
type	S Σ	1..1	CodingBinding	Element id AuditEvent.type Short description Type/identifier of event Definition Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. Requirements This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. Comments Angabe ob es sich um eine zu protokollierende Nutzerinteraktion nach Abschnittt '5.5.9 Nutzerprotokolle' des Feature-Dokuments 'Digitale Patientenrechnung' handelt oder um eine durchgeführte REST-API-Interaktion durch den FD. Data type Coding Binding Type of event. DiPagAuditEventTypeVS (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
subtype	S Σ	0..*	CodingBinding	Element id AuditEvent.subtype Short description More specific type/id for the event Definition Identifier for the category of event. Requirements This field enables queries of messages by implementation-defined event categories. Comments Erlaubt die Kodierung aller REST-API Operationen der Spec-Digitale Patientenrechnung Data type Coding Binding Sub-type of event. DiPagAuditEventSubTypeVS (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .code (type, subtype and action are pre-coordinated or sent as translations) dicom: EventTypeCode
action	S Σ	0..1	codeBinding	Element id AuditEvent.action Short description Type of action performed during the event Definition Indicator for type of action performed during the event that generated the audit. Requirements This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent. Comments Angabe ob es sich um eine lesende/schreibende/ausführende Interaktion handelt. Data type code Binding Indicator for type of action performed during the event that generated the event. AuditEventAction (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .code (type, subtype and action are pre-coordinated or sent as translations) dicom: EventActionCode
period		0..1	Period	There are no (further) constraints on this element Element id AuditEvent.period Short description When the activity occurred Definition The period during which the activity occurred. Comments The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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]
recorded	S Σ	1..1	instant	Element id AuditEvent.recorded Short description Time when the event was recorded Definition The time when the event was recorded. 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 Der Zeitpunkt des Zugriffs ist zu protokollieren. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: .effectiveTime w3c.prov: Activity.when fhirprovenance: Provenance.recorded
outcome	S Σ	0..1	codeBinding	Element id AuditEvent.outcome Short description Whether the event succeeded or failed Definition Indicates whether the event succeeded or failed. Comments Angabe ob die zu protokollierende Interaktion erfolgreich ausgeführt werden konnte. Data type code Binding Indicates whether the event succeeded or failed. AuditEventOutcome (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .actionNegationInd dicom: EventOutcomeIndicator
outcomeDesc	Σ	0..1	string	There are no (further) constraints on this element Element id AuditEvent.outcomeDesc Short description Description of the event outcome Definition A free text description of the outcome of the event. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=OUT].target.text dicom: EventOutcomeDescription
purposeOfEvent	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id AuditEvent.purposeOfEvent Short description The purposeOfUse of the event Definition The purposeOfUse (reason) that was used during the event being recorded. 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. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
agent	S	1..*	BackboneElement	Element id AuditEvent.agent Short description Actor involved in the event Alternate names ActiveParticipant Definition An actor taking an active role in the event or activity that is logged. Requirements An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility. Comments Angaben zum Akteur (Nutzer oder DiPag FD), der den Zugriff durchgeführt hat. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer w5: FiveWs.who rim: .participation dicom: ActiveParticipant w3c.prov: Agent fhirprovenance: Provenance.agent
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
type	S	1..1	CodeableConceptBinding	Element id AuditEvent.agent.type Short description How agent participated Definition Specification of the participation type the user plays when performing the event. Data type CodeableConcept Binding The Participation type of the agent to the event. DiPagAuditEventAgentTypeVS (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function w5: FiveWs.who rim: .typeCode and/or .functionCode dicom: RoleIdCode w3c.prov: Agent.Attribution fhirprovenance: Provenance.agent.type
role		0..*	CodeableConcept	There are no (further) constraints on this element Element id AuditEvent.agent.role Short description Agent role in the event Definition The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context. 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. Data type CodeableConcept Binding What security role enabled the agent to participate in the event. SecurityRoleType (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.who rim: .role dicom: RoleIdCode w3c.prov: Agent.Attribution fhirprovenance: Provenance.agent.role
who	S Σ	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	There are no (further) constraints on this element Element id AuditEvent.agent.who Short description Identifier of who Alternate names userId Definition Reference to who this agent is that was involved in the event. 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. Data type Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.who rim: .id dicom: UserId w3c.prov: Agent.Identity fhirprovenance: Provenance.agent.who
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.who.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.who.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.who.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id AuditEvent.agent.who.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). 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. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	S Σ	0..1	Identifier	Element id AuditEvent.agent.who.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments Der Identifier wird vom Server gesetzt und kann entweder eine KVNR oder Telematik-ID sein Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	S Σ	1..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.who.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
altId		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.altId Short description Alternative User identity Definition Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.who rim: .id (distinguish id type by root) dicom: AlternativeUserId w3c.prov: Agent.Identity
name		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.name Short description Human friendly name for the agent Definition Human-meaningful name for the agent. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.who rim: .name dicom: UserName w3c.prov: Agent.Identity
requestor	S Σ	1..1	boolean	There are no (further) constraints on this element Element id AuditEvent.agent.requestor Short description Whether user is initiator Definition Indicator that the user is or is not the requestor, or initiator, for the event being audited. 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. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.who rim: If participation.typeCode was author, then true dicom: UserIsRequestor
location		0..1	Reference(Location)	There are no (further) constraints on this element Element id AuditEvent.agent.location Short description Where Definition Where the event occurred. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
policy		0..*	uri	There are no (further) constraints on this element Element id AuditEvent.agent.policy Short description Policy that authorized event Definition The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.why[x] rim: ActPolicyType dicom: ParticipantRoleIDCode fhirprovenance: Provenance.policy
media		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.agent.media Short description Type of media Definition Type of media involved. Used when the event is about exporting/importing onto media. Requirements Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD). Data type Coding Binding Used when the event is about exporting/importing onto media. MediaTypeCode (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .player.description.mediaType dicom: MediaType
network		0..1	BackboneElement	There are no (further) constraints on this element Element id AuditEvent.agent.network Short description Logical network location for application activity Definition Logical network location for application activity, if the activity has a network location. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: .player.description.reference
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.network.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.network.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.agent.network.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
address		0..1	string	There are no (further) constraints on this element Element id AuditEvent.agent.network.address Short description Identifier for the network access point of the user device Definition An identifier for the network access point of the user device for the audit event. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: pre-coordinated into URL dicom: NetworkAccessPointID w3c.prov: Agent.Location
type		0..1	codeBinding	There are no (further) constraints on this element Element id AuditEvent.agent.network.type Short description The type of network access point Definition An identifier for the type of network access point that originated the audit event. Requirements This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type. Data type code Binding The type of network access point of this agent in the audit event. AuditEventAgentNetworkType (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.where[x] rim: pre-coordinated into URL dicom: NetworkAccessPointTypeCode
purposeOfUse		0..*	CodeableConceptBinding	There are no (further) constraints on this element Element id AuditEvent.agent.purposeOfUse Short description Reason given for this user Definition The reason (purpose of use), specific to this agent, that was used during the event being recorded. 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. Data type CodeableConcept Binding The reason the activity took place. v3.PurposeOfUse (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings 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
source		1..1	BackboneElement	There are no (further) constraints on this element Element id AuditEvent.source Short description Audit Event Reporter Definition The system that is reporting the event. 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.witness rim: .participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE] dicom: AuditSourceIdentification
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.source.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.source.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.source.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
site		0..1	string	There are no (further) constraints on this element Element id AuditEvent.source.site Short description Logical source location within the enterprise Definition Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. Requirements This value differentiates among the sites in a multi-site enterprise health information system. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.witness rim: .scopedRole[classCode=LOCE].player.desc dicom: AuditEnterpriseSiteId
observer	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	There are no (further) constraints on this element Element id AuditEvent.source.observer Short description The identity of source detecting the event Alternate names SourceId Definition Identifier of the source where the event was detected. 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. Data type Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.witness rim: .id dicom: AuditSourceId
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.source.observer.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.source.observer.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.source.observer.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id AuditEvent.source.observer.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). 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. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id AuditEvent.source.observer.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	S Σ	0..1	string	Element id AuditEvent.source.observer.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments Freitext-Rolle des Servers, auf das Event ausgelöst wurde Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type		0..*	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.source.type Short description The type of source where event originated Definition Code specifying the type of source where event originated. 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. Data type Coding Binding Code specifying the type of system that detected and recorded the event. AuditEventSourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.witness rim: .code dicom: AuditSourceTypeCode
entity	S I	0..*	BackboneElement	Element id AuditEvent.entity Short description Data or objects used Alternate names ParticipantObject Definition Specific instances of data or objects that have been accessed. 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. Data type BackboneElement Sliced: Unordered, Open, by what.type(Pattern) Constraints 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 w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role dicom: ParticipantObjectIdentification w3c.prov: Entity fhirprovenance: Provenance.target, Provenance.entity
(All Slices)				There are no (further) constraints on this element
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
what	S Σ	0..1	Reference(Resource)	Element id AuditEvent.entity.what Short description Specific instance of resource Definition Identifies a specific instance of the entity. The reference should be version specific. Comments Referenzierung aller durch die zu protokollierende Interaktion betroffenen Ressourcen Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .id dicom: ParticipantObjectID and ParticipantObjectIDTypeCode fhirprovenance: Provenance.target, Provenance.entity.what
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.what.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.what.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.what.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id AuditEvent.entity.what.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). 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. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id AuditEvent.entity.what.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. 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). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	S Σ	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.what.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity.type Short description Type of entity involved Definition The type of the object that was involved in this audit event. Requirements To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. Comments This value is distinct from the user's role or any user relationship to the entity. Data type Coding Binding Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: [self::Act].code or role.player.code dicom: ParticipantObjectTypeCode w3c.prov: Entity.type fhirprovenance: Provenance.entity.type
role		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity.role Short description What role the entity played Definition Code representing the role the entity played in the event being audited. 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. Data type Coding Binding Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: role.code (not sure what this would mean for an Act) dicom: ParticipantObjectTypeCodeRole w3c.prov: Entity.role
lifecycle		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity.lifecycle Short description Life-cycle stage for the entity Definition Identifier for the data life-cycle stage for the entity. Requirements Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. Comments This can be used to provide an audit trail for data, over time, as it passes through the system. Data type Coding Binding Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: target of ObservationEvent[code="lifecycle"].value dicom: ParticipantObjectDataLifeCycle w3c.prov: Entity.role fhirprovenance: Provenance.entity.role
securityLabel		0..*	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity.securityLabel Short description Security labels on the entity Definition Security labels for the identified entity. 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. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .confidentialityCode dicom: ParticipantObjectSensitivity
name	S Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.name Short description Descriptor for entity Definition A name of the entity in the audit event. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .title dicom: ParticipantObjectName w3c.prov: Entity.Label
description	S	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.description Short description Descriptive text Definition Text that describes the entity in more detail. Requirements Use only where entity can't be identified with an identifier. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .text dicom: ParticipantObjectDescription
query	Σ I	0..1	base64Binary	There are no (further) constraints on this element Element id AuditEvent.entity.query Short description Query parameters Definition The query parameters for a query-type entities. 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. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: No mapping dicom: ParticipantObjectQuery
detail		0..*	BackboneElement	There are no (further) constraints on this element Element id AuditEvent.entity.detail Short description Additional Information about the entity Definition Tagged value pairs for conveying additional information about the entity. Requirements Implementation-defined data about specific details of the object accessed or used. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] dicom: ParticipantObjectDetail
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.detail.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.detail.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity.detail.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
type		1..1	string	There are no (further) constraints on this element Element id AuditEvent.entity.detail.type Short description Name of the property Definition The type of extra detail provided in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .code dicom: ParticipantObjectDetail.type
value[x]		1..1		There are no (further) constraints on this element Element id AuditEvent.entity.detail.value[x] Short description Property value Definition The value of the extra detail. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .value dicom: ParticipantObjectDetail.value
valueString			string	There are no (further) constraints on this element Data type string
valueBase64Binary			base64Binary	There are no (further) constraints on this element Data type base64Binary
Versicherter	S I	0..1	BackboneElement	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter Short description Data or objects used Alternate names ParticipantObject Definition Specific instances of data or objects that have been accessed. 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. Data type BackboneElement Constraints 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 w5: FiveWs.what[x] rim: .outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role dicom: ParticipantObjectIdentification w3c.prov: Entity fhirprovenance: Provenance.target, Provenance.entity
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
what	Σ	0..1	Reference(Resource)	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what Short description Specific instance of resource Definition Identifies a specific instance of the entity. The reference should be version specific. Data type Reference(Resource) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: .id dicom: ParticipantObjectID and ParticipantObjectIDTypeCode fhirprovenance: Provenance.target, Provenance.entity.what
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
reference	Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	1..1	uriBindingPattern	Element id AuditEvent.entity:Versicherter.what.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). 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. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern Patient Mappings rim: N/A
identifier	Σ	0..1	IdentifierKvid10Pattern	Element id AuditEvent.entity:Versicherter.what.identifier Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. 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). Data type IdentifierKvid10 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Pattern { "type": { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "KVZ10" } ] } } Mappings rim: .identifier 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
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: N/A rim: Role.code or implied by context
type	S Σ I	1..1	CodeableConceptBindingPattern	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. IdentifierTypeDeBasis (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` kvid-2: Die type Codes 'GKV' und 'PKV' haben den Status 'retired', daher sollen diese nicht mehr verwendet werden `($this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='GKV') or $this.coding.exists(system='http://fhir.de/CodeSystem/identifier-type-de-basis' and code='PKV')).not()` Pattern { "coding": [ { "system": "http://fhir.de/CodeSystem/identifier-type-de-basis", "code": "KVZ10" } ] } Mappings v2: CX.5 rim: Role.code or implied by context
system	S Σ	1..1	uriFixed Value	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed value http://fhir.de/sid/gkv/kvid-10 Mappings v2: CX.4 / EI-2-4 rim: II.root or Role.id.root servd: ./IdentifierType
value	S Σ I	1..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` kvid-1: Der unveränderliche Teil der KVID muss 10-stellig sein und mit einem Großbuchstaben anfangen `matches('^[A-Z][0-9]{9}$')` Examples General 123456 Mappings v2: CX.1 / EI.1 rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd: ./Value
period	Σ	0..1	Period	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Data type Period Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.7 + CX.8 rim: Role.effectiveTime or implied by context servd: ./StartDate and ./EndDate
assigner	Σ	0..1	Reference(Organization)	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: CX.4 / (CX.4,CX.9,CX.10) rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd: ./IdentifierIssuingAuthority
display	Σ	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.what.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.type Short description Type of entity involved Definition The type of the object that was involved in this audit event. Requirements To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. Comments This value is distinct from the user's role or any user relationship to the entity. Data type Coding Binding Code for the entity type involved in the audit event. AuditEventEntityType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.what[x] rim: [self::Act].code or role.player.code dicom: ParticipantObjectTypeCode w3c.prov: Entity.type fhirprovenance: Provenance.entity.type
role		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.role Short description What role the entity played Definition Code representing the role the entity played in the event being audited. 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. Data type Coding Binding Code representing the role the entity played in the audit event. AuditEventEntityRole (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: role.code (not sure what this would mean for an Act) dicom: ParticipantObjectTypeCodeRole w3c.prov: Entity.role
lifecycle		0..1	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.lifecycle Short description Life-cycle stage for the entity Definition Identifier for the data life-cycle stage for the entity. Requirements Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. Comments This can be used to provide an audit trail for data, over time, as it passes through the system. Data type Coding Binding Identifier for the data life-cycle stage for the entity. ObjectLifecycleEvents (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: target of ObservationEvent[code="lifecycle"].value dicom: ParticipantObjectDataLifeCycle w3c.prov: Entity.role fhirprovenance: Provenance.entity.role
securityLabel		0..*	CodingBinding	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.securityLabel Short description Security labels on the entity Definition Security labels for the identified entity. 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. Data type Coding Binding Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .confidentialityCode dicom: ParticipantObjectSensitivity
name	Σ I	0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.name Short description Descriptor for entity Definition A name of the entity in the audit event. 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. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .title dicom: ParticipantObjectName w3c.prov: Entity.Label
description		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.description Short description Descriptive text Definition Text that describes the entity in more detail. Requirements Use only where entity can't be identified with an identifier. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .text dicom: ParticipantObjectDescription
query	Σ I	0..1	base64Binary	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.query Short description Query parameters Definition The query parameters for a query-type entities. 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. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: No mapping dicom: ParticipantObjectQuery
detail		0..*	BackboneElement	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail Short description Additional Information about the entity Definition Tagged value pairs for conveying additional information about the entity. Requirements Implementation-defined data about specific details of the object accessed or used. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN] dicom: ParticipantObjectDetail
id		0..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Data type Extension Constraints 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
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). 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. Data type Extension Constraints 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
type		1..1	string	There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail.type Short description Name of the property Definition The type of extra detail provided in the value. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .code dicom: ParticipantObjectDetail.type
value[x]		1..1		There are no (further) constraints on this element Element id AuditEvent.entity:Versicherter.detail.value[x] Short description Property value Definition The value of the extra detail. 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.context rim: .value dicom: ParticipantObjectDetail.value
valueString			string	There are no (further) constraints on this element Data type string
valueBase64Binary			base64Binary	There are no (further) constraints on this element Data type base64Binary

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="dipag-nutzungsprotokoll" />
    <url value="https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll" />
    <version value="1.1.0-rc2" />
    <name value="DiPagNutzungsprotokoll" />
    <title value="Digitale Patientenrechnung Nutzungsprotokoll" />
    <status value="active" />
    <experimental value="false" />
    <date value="2025-04-07" />
    <publisher value="gematik GmbH" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://gematik.de/" />
        </telecom>
    </contact>
    <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" />
            <comment value="Angabe ob es sich um eine zu protokollierende Nutzerinteraktion nach Abschnittt &#39;5.5.9 Nutzerprotokolle&#39; des Feature-Dokuments &#39;Digitale Patientenrechnung&#39; handelt oder um eine durchgef&#252;hrte REST-API-Interaktion durch den FD." />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-type-vs" />
            </binding>
        </element>
        <element id="AuditEvent.subtype">
            <path value="AuditEvent.subtype" />
            <comment value="Erlaubt die Kodierung aller REST-API Operationen der Spec-Digitale Patientenrechnung" />
            <mustSupport value="true" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-sub-type-vs" />
            </binding>
        </element>
        <element id="AuditEvent.action">
            <path value="AuditEvent.action" />
            <comment value="Angabe ob es sich um eine lesende/schreibende/ausf&#252;hrende Interaktion handelt." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.recorded">
            <path value="AuditEvent.recorded" />
            <comment value="Der Zeitpunkt des Zugriffs ist zu protokollieren. Siehe Abschnittt &#39;4.8.6 Protokolleintrag&#39;des Feature-Dokuments &#39;Digitale Patientenrechnung&#39;." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.outcome">
            <path value="AuditEvent.outcome" />
            <comment value="Angabe ob die zu protokollierende Interaktion erfolgreich ausgef&#252;hrt werden konnte." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent">
            <path value="AuditEvent.agent" />
            <comment value="Angaben zum Akteur (Nutzer oder DiPag FD), der den Zugriff durchgef&#252;hrt hat. Siehe Abschnittt &#39;4.8.6 Protokolleintrag&#39;des Feature-Dokuments &#39;Digitale Patientenrechnung&#39;." />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent.type">
            <path value="AuditEvent.agent.type" />
            <min value="1" />
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-agent-type-vs" />
            </binding>
        </element>
        <element id="AuditEvent.agent.who">
            <path value="AuditEvent.agent.who" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent.who.identifier">
            <path value="AuditEvent.agent.who.identifier" />
            <comment value="Der Identifier wird vom Server gesetzt und kann entweder eine KVNR oder Telematik-ID sein" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent.who.display">
            <path value="AuditEvent.agent.who.display" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.agent.requestor">
            <path value="AuditEvent.agent.requestor" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.source.observer.display">
            <path value="AuditEvent.source.observer.display" />
            <comment value="Freitext-Rolle des Servers, auf das Event ausgel&#246;st wurde" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity">
            <path value="AuditEvent.entity" />
            <slicing>
                <discriminator>
                    <type value="pattern" />
                    <path value="what.type" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.what">
            <path value="AuditEvent.entity.what" />
            <comment value="Referenzierung aller durch die zu protokollierende Interaktion betroffenen Ressourcen" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.what.display">
            <path value="AuditEvent.entity.what.display" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.name">
            <path value="AuditEvent.entity.name" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity.description">
            <path value="AuditEvent.entity.description" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity:Versicherter">
            <path value="AuditEvent.entity" />
            <sliceName value="Versicherter" />
            <min value="0" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity:Versicherter.what.type">
            <path value="AuditEvent.entity.what.type" />
            <min value="1" />
            <patternUri value="Patient" />
        </element>
        <element id="AuditEvent.entity:Versicherter.what.identifier">
            <path value="AuditEvent.entity.what.identifier" />
            <type>
                <code value="Identifier" />
                <profile value="http://fhir.de/StructureDefinition/identifier-kvid-10" />
            </type>
            <patternIdentifier>
                <type>
                    <coding>
                        <system value="http://fhir.de/CodeSystem/identifier-type-de-basis" />
                        <code value="KVZ10" />
                    </coding>
                </type>
            </patternIdentifier>
        </element>
        <element id="AuditEvent.entity:Versicherter.what.identifier.type">
            <path value="AuditEvent.entity.what.identifier.type" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity:Versicherter.what.identifier.system">
            <path value="AuditEvent.entity.what.identifier.system" />
            <mustSupport value="true" />
        </element>
        <element id="AuditEvent.entity:Versicherter.what.identifier.value">
            <path value="AuditEvent.entity.what.identifier.value" />
            <mustSupport value="true" />
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "dipag-nutzungsprotokoll",
    "url": "https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll",
    "version": "1.1.0-rc2",
    "name": "DiPagNutzungsprotokoll",
    "title": "Digitale Patientenrechnung Nutzungsprotokoll",
    "status": "active",
    "experimental": false,
    "date": "2025-04-07",
    "publisher": "gematik GmbH",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://gematik.de/"
                }
            ]
        }
    ],
    "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",
                "comment": "Angabe ob es sich um eine zu protokollierende Nutzerinteraktion nach Abschnittt '5.5.9 Nutzerprotokolle' des Feature-Dokuments 'Digitale Patientenrechnung' handelt oder um eine durchgeführte REST-API-Interaktion durch den FD.",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-type-vs"
                }
            },
            {
                "id": "AuditEvent.subtype",
                "path": "AuditEvent.subtype",
                "comment": "Erlaubt die Kodierung aller REST-API Operationen der Spec-Digitale Patientenrechnung",
                "mustSupport": true,
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-sub-type-vs"
                }
            },
            {
                "id": "AuditEvent.action",
                "path": "AuditEvent.action",
                "comment": "Angabe ob es sich um eine lesende/schreibende/ausführende Interaktion handelt.",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.recorded",
                "path": "AuditEvent.recorded",
                "comment": "Der Zeitpunkt des Zugriffs ist zu protokollieren. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'.",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.outcome",
                "path": "AuditEvent.outcome",
                "comment": "Angabe ob die zu protokollierende Interaktion erfolgreich ausgeführt werden konnte.",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent",
                "path": "AuditEvent.agent",
                "comment": "Angaben zum Akteur (Nutzer oder DiPag FD), der den Zugriff durchgeführt hat. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'.",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent.type",
                "path": "AuditEvent.agent.type",
                "min": 1,
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-agent-type-vs"
                }
            },
            {
                "id": "AuditEvent.agent.who",
                "path": "AuditEvent.agent.who",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent.who.identifier",
                "path": "AuditEvent.agent.who.identifier",
                "comment": "Der Identifier wird vom Server gesetzt und kann entweder eine KVNR oder Telematik-ID sein",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent.who.display",
                "path": "AuditEvent.agent.who.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.agent.requestor",
                "path": "AuditEvent.agent.requestor",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.source.observer.display",
                "path": "AuditEvent.source.observer.display",
                "comment": "Freitext-Rolle des Servers, auf das Event ausgelöst wurde",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity",
                "path": "AuditEvent.entity",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "what.type"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.what",
                "path": "AuditEvent.entity.what",
                "comment": "Referenzierung aller durch die zu protokollierende Interaktion betroffenen Ressourcen",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.what.display",
                "path": "AuditEvent.entity.what.display",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.name",
                "path": "AuditEvent.entity.name",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity.description",
                "path": "AuditEvent.entity.description",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity:Versicherter",
                "path": "AuditEvent.entity",
                "sliceName": "Versicherter",
                "min": 0,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity:Versicherter.what.type",
                "path": "AuditEvent.entity.what.type",
                "min": 1,
                "patternUri": "Patient"
            },
            {
                "id": "AuditEvent.entity:Versicherter.what.identifier",
                "path": "AuditEvent.entity.what.identifier",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "http://fhir.de/StructureDefinition/identifier-kvid-10"
                        ]
                    }
                ],
                "patternIdentifier": {
                    "type": {
                        "coding":  [
                            {
                                "code": "KVZ10",
                                "system": "http://fhir.de/CodeSystem/identifier-type-de-basis"
                            }
                        ]
                    }
                }
            },
            {
                "id": "AuditEvent.entity:Versicherter.what.identifier.type",
                "path": "AuditEvent.entity.what.identifier.type",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity:Versicherter.what.identifier.system",
                "path": "AuditEvent.entity.what.identifier.system",
                "mustSupport": true
            },
            {
                "id": "AuditEvent.entity:Versicherter.what.identifier.value",
                "path": "AuditEvent.entity.what.identifier.value",
                "mustSupport": true
            }
        ]
    }
}

Digitale Patientenrechnung Nutzungsprotokoll

Constraints/Invarianten

Terminology-Bindings

Element	Staerke	ValueSet
AuditEvent.type	required	https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-type-vs
AuditEvent.subtype	extensible	https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-sub-type-vs
AuditEvent.agent.type	required	https://gematik.de/fhir/dipag/ValueSet/dipag-audit-event-agent-type-vs

Anmerkungen zu Must-Support-Feldern

Feldname	Hinweise
AuditEvent.type	Angabe ob es sich um eine zu protokollierende Nutzerinteraktion nach Abschnittt '5.5.9 Nutzerprotokolle' des Feature-Dokuments 'Digitale Patientenrechnung' handelt oder um eine durchgeführte REST-API-Interaktion durch den FD.
AuditEvent.subtype	Erlaubt die Kodierung aller REST-API Operationen der Spec-Digitale Patientenrechnung
AuditEvent.action	Angabe ob es sich um eine lesende/schreibende/ausführende Interaktion handelt.
AuditEvent.recorded	Der Zeitpunkt des Zugriffs ist zu protokollieren. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'.
AuditEvent.outcome	Angabe ob die zu protokollierende Interaktion erfolgreich ausgeführt werden konnte.
AuditEvent.agent	Angaben zum Akteur (Nutzer oder DiPag FD), der den Zugriff durchgeführt hat. Siehe Abschnittt '4.8.6 Protokolleintrag'des Feature-Dokuments 'Digitale Patientenrechnung'.
AuditEvent.agent.type
AuditEvent.agent.who
AuditEvent.agent.who.identifier	Der Identifier wird vom Server gesetzt und kann entweder eine KVNR oder Telematik-ID sein
AuditEvent.agent.who.display
AuditEvent.agent.requestor
AuditEvent.source.observer.display	Freitext-Rolle des Servers, auf das Event ausgelöst wurde
AuditEvent.entity
AuditEvent.entity.what	Referenzierung aller durch die zu protokollierende Interaktion betroffenen Ressourcen
AuditEvent.entity.what.display
AuditEvent.entity.name
AuditEvent.entity.description
AuditEvent.entity:Versicherter
AuditEvent.entity:Versicherter.what.identifier.type
AuditEvent.entity:Versicherter.what.identifier.system
AuditEvent.entity:Versicherter.what.identifier.value

Beispiele

AuditEvent

id : BeispielNutzungsprotokoll

meta

profile : https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll

type

code : rest

subtype

code : dipag-submit

action : C

recorded : 2024-05-29T11:25:54.123456+00:02

outcome : 0

agent

type

coding

code : humanuser

who

identifier

type

coding

system : http://terminology.hl7.org/CodeSystem/v2-0203

code : PRN

system : https://gematik.de/fhir/sid/telematik-id

value : 11223344

display : Beispiel Leistungsempfänmger

requestor : True

source

observer

display : FdV

entity

what

reference : DocumentReference/BeispielDocumentReferenceRechnungRetrieve

<AuditEvent xmlns="http://hl7.org/fhir">
    <id value="BeispielNutzungsprotokoll" />
    <meta>
        <profile value="https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll" />
    </meta>
    <type>
        <code value="rest" />
    </type>
    <subtype>
        <code value="dipag-submit" />
    </subtype>
    <action value="C" />
    <recorded value="2024-05-29T11:25:54.123456+00:02" />
    <outcome value="0" />
    <agent>
        <type>
            <coding>
                <code value="humanuser" />
            </coding>
        </type>
        <who>
            <identifier>
                <type>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/v2-0203" />
                        <code value="PRN" />
                    </coding>
                </type>
                <system value="https://gematik.de/fhir/sid/telematik-id" />
                <value value="11223344" />
            </identifier>
            <display value="Beispiel Leistungsempf&#228;nmger" />
        </who>
        <requestor value="true" />
    </agent>
    <source>
        <observer>
            <display value="FdV" />
        </observer>
    </source>
    <entity>
        <what>
            <reference value="DocumentReference/BeispielDocumentReferenceRechnungRetrieve" />
        </what>
    </entity>
</AuditEvent>

{
    "resourceType": "AuditEvent",
    "id": "BeispielNutzungsprotokoll",
    "meta": {
        "profile":  [
            "https://gematik.de/fhir/dipag/StructureDefinition/dipag-nutzungsprotokoll"
        ]
    },
    "type": {
        "code": "rest"
    },
    "subtype":  [
        {
            "code": "dipag-submit"
        }
    ],
    "action": "C",
    "recorded": "05/29/2024 11:23:54",
    "outcome": "0",
    "agent":  [
        {
            "type": {
                "coding":  [
                    {
                        "code": "humanuser"
                    }
                ]
            },
            "who": {
                "identifier": {
                    "type": {
                        "coding":  [
                            {
                                "code": "PRN",
                                "system": "http://terminology.hl7.org/CodeSystem/v2-0203"
                            }
                        ]
                    },
                    "system": "https://gematik.de/fhir/sid/telematik-id",
                    "value": "11223344"
                },
                "display": "Beispiel Leistungsempfänmger"
            },
            "requestor": true
        }
    ],
    "source": {
        "observer": {
            "display": "FdV"
        }
    },
    "entity":  [
        {
            "what": {
                "reference": "DocumentReference/BeispielDocumentReferenceRechnungRetrieve"
            }
        }
    ]
}

BeispielNutzungsprotokoll