CH - Policy Audit Event

Validation description

Name
CH - Policy Audit Event
OID
1.3.6.1.4.1.12559.11.25.1.20.5
Profile
ATC
Descriminator
EPR
Status
Available
Execute schema validation ?
true
Execute schematron validation ?
true
URL
http://fhir.ch/ig/ch-atc/StructureDefinition/PolicyAuditEvent
Base definition
http://hl7.org/fhir/StructureDefinition/AuditEvent

Structure Definition (SNAPSHOT computed)

Contextual information
Id
PolicyAuditEvent
Name
PolicyAuditEvent
Title
PolicyAuditEvent
Description
This profile defines the content of the policy audit events which a community has to provide for a patients audit trail.
FHIR version
3.0.1
Type
AuditEvent
Status
active
URL
http://fhir.ch/ig/ch-atc/StructureDefinition/PolicyAuditEvent
Base definition
http://hl7.org/fhir/StructureDefinition/AuditEvent
Derivation
constraint
Experimental ?
false
Abstract ?
false
Kind
resource
Last update date
2018-05-28T00:00:00+00:00
Publisher
Federal Office of Public Health (FOPH)
Copyright
CC-BY-SA-4.0
Contact(s)
Mappings
Identity URI Name
ch-atc https://www.bag.admin.ch/bag/en/home.html Mapping to CH:ATC
dicom http://nema.org/dicom DICOM Tag Mapping
rim http://hl7.org/v3 RIM Mapping
w5 http://hl7.org/fhir/w5 W5 Mapping
w3c.prov http://www.w3.org/ns/prov W3C PROV
fhirprovenance http://hl7.org/fhir/provenance FHIR Provenance
Details
Path
Cardinality
Type
[0..*]
AuditEvent 5
[1..1]
id
[0..1]
Meta
[0..1]
uri
[0..1]
code B
[1..1]
Narrative
[0..*]
Resource
[0..*]
Extension
[0..*]
Extension
[1..1]
Coding B
[1..*]
Coding B
[1..1]
Coding B
[0..1]
string
[0..*]
Extension
[1..1]
uri F
[0..1]
string
[0..1]
code
[0..1]
string
[0..1]
boolean
[0..1]
code B
[1..1]
instant
[0..1]
code B
[0..1]
string
[0..*]
CodeableConcept B
[1..*]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
CodeableConcept B
[0..1]
[0..1]
Identifier
[0..1]
string
[1..1]
string
[1..1]
boolean
[0..1]
[0..*]
uri
[0..1]
Coding B
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
string
[0..1]
code B
[0..*]
CodeableConcept B
[1..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
string
[1..1]
Identifier
[0..*]
Coding B
[0..*]
BackboneElement 3
[1..1]
BackboneElement 2
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
Identifier
[0..1]
string
[0..*]
Extension
[0..1]
code B
[0..1]
CodeableConcept B
[1..1]
uri F
[0..1]
string
[0..1]
Period
[0..1]
[0..1]
[1..1]
Coding B
[0..1]
string
[0..*]
Extension
[0..1]
uri
[0..1]
string
[1..1]
code F
[0..1]
string
[0..1]
boolean
[1..1]
Coding B
[0..1]
string
[0..*]
Extension
[0..1]
uri
[0..1]
string
[1..1]
code F
[0..1]
string
[0..1]
boolean
[0..1]
Coding B
[0..*]
Coding B
[0..1]
string
[0..1]
string
[0..1]
base64Binary
[0..*]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string
[1..1]
base64Binary
[0..1]
BackboneElement 2
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[0..1]
Identifier
[0..1]
[1..1]
Coding B
[0..1]
string
[0..*]
Extension
[0..1]
uri
[0..1]
string
[1..1]
code F
[0..1]
string
[0..1]
boolean
[1..1]
Coding B
[0..1]
Coding B
[0..*]
Coding B
[1..1]
string
[0..1]
string
[0..1]
base64Binary
[0..*]
BackboneElement 1
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string F
[1..1]
base64Binary
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string F
[1..1]
base64Binary
[0..1]
BackboneElement 1
[0..1]
string
[0..*]
Extension
[0..*]
Extension
[1..1]
string F
[1..1]
base64Binary
AuditEvent Constrained
Path
AuditEvent
Cardinality
0..*
Short Description
Policy Audit Trail Content Profile
Definition
Policy Audit Trail Content Profil
Base
AuditEvent [0..*]
Comment
Based on ATNA (RFC 3881).
Mapping
  • rim:Entity. Role, or Act
  • rim:ControlAct[moodCode=EVN]
  • dicom:Message
  • w5:infrastructure.information
Constraints
Severity
errordom-2
Description
If the resource is contained in another resource, it SHALL NOT contain nested Resources
Expression
contained.contained.empty()
XPath
not(parent::f:contained and f:contained)
Source
DomainResource
Severity
errordom-1
Description
If the resource is contained in another resource, it SHALL NOT contain any narrative
Expression
contained.text.empty()
XPath
not(parent::f:contained and f:text)
Source
DomainResource
Severity
errordom-4
Description
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
Expression
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
XPath
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
Source
DomainResource
Severity
errordom-3
Description
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Expression
contained.where(('#'+id in %resource.descendants().reference).not()).empty()
XPath
not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
Source
DomainResource
Severity
errorch-atc-pae-1
Description
subtype needs to be fixed to ValueSet PolicyAuditEventType
Expression
subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
XPath
Source
AuditEvent.id
Path
AuditEvent.id
Cardinality
1..1
Part of a summary ?
true
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.
Base
Resource.id [0..1]
Comment
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Type
id
AuditEvent.meta
Path
AuditEvent.meta
Cardinality
0..1
Part of a summary ?
true
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 may not always be associated with version changes to the resource.
Base
Resource.meta [0..1]
Type
Meta
AuditEvent.implicitRules
Path
AuditEvent.implicitRules
Cardinality
0..1
Part of a summary ?
true
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.
Base
Resource.implicitRules [0..1]
Comment
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Type
uri
AuditEvent.language Binding
Path
AuditEvent.language
Cardinality
0..1
Short Description
Language of the resource content
Definition
The base language in which the resource is written.
Base
Resource.language [0..1]
Comment
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).
Type
code
Binding
Language(extensible) : A human language.
AuditEvent.text
Path
AuditEvent.text
Cardinality
1..1
Short Description
A human-readable narrative that contains the summary of the Audit Event.
Definition
A human-readable narrative that contains the summary of the Audit Event.
Base
DomainResource.text [0..1]
Comment
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 in formation is added later.
Alias
narrative, html, xhtml, display
Type
Narrative
Mapping
  • rim:Act.text?
AuditEvent.contained
Path
AuditEvent.contained
Cardinality
0..*
Short Description
Contained, inline 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.
Base
DomainResource.contained [0..*]
Comment
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.
Alias
inline resources, anonymous resources, contained resources
Type
Resource
Mapping
  • rim:N/A
AuditEvent.extension
Path
AuditEvent.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the resource. In order 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.
Base
DomainResource.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:N/A
AuditEvent.modifierExtension
Path
AuditEvent.modifierExtension
Cardinality
0..*
Short Description
Extensions that cannot be ignored
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. Usually modifier elements provide negation or qualification. In order 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.
Base
DomainResource.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:N/A
AuditEvent.type Binding
Path
AuditEvent.type
Cardinality
1..1
Part of a summary ?
true
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.
Base
AuditEvent.type [1..1]
Type
Coding
Binding
AuditEventType(extensible) : Type of event.
Mapping
  • rim:.code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom:EventId
  • w3c.prov:Activity
  • w5:what
AuditEvent.subtype Binding
Path
AuditEvent.subtype
Cardinality
1..*
Part of a summary ?
true
Slicing
  • Descriminator type:value
  • Descriminator path:system
  • Rules:open
Short Description
More specific type/id for the event
Definition
Identifier for the category of event.
Base
AuditEvent.subtype [0..*]
Type
Coding
Binding
AuditEventSubType(extensible) : Sub-type of event.
Mapping
  • rim:.code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom:EventTypeCode
  • w5:what
AuditEvent.subtype:policyauditeventtype Binding
Path
AuditEvent.subtype
Cardinality
1..1
Part of a summary ?
true
Short Description
PolicyAuditEventType
Slice name
PolicyAuditEventType
Definition
Identifier for the category of event.
Base
AuditEvent.subtype [0..*]
Type
Coding
Binding
ConditionKind(required) : Policy Audit Event Type
Mapping
  • rim:.code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom:EventTypeCode
  • w5:what
  • ch-atc:Event Type
AuditEvent.subtype:policyauditeventtype.id
Path
AuditEvent.subtype.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.subtype:policyauditeventtype.extension
Path
AuditEvent.subtype.extension
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:url
  • Rules:open
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.subtype:policyauditeventtype.system Fixed value
Path
AuditEvent.subtype.system
Cardinality
1..1
Part of a summary ?
true
Short Description
Identity of the terminology system
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Base
Coding.system [0..1]
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Type
uri
Fixed code
urn:oid:2.16.756.5.30.1.127.3.10.7
Mapping
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AuditEvent.subtype:policyauditeventtype.version
Path
AuditEvent.subtype.version
Cardinality
0..1
Part of a summary ?
true
Short Description
Version of the system - if relevant
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Base
Coding.version [0..1]
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Type
string
Mapping
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AuditEvent.subtype:policyauditeventtype.code
Path
AuditEvent.subtype.code
Cardinality
0..1
Part of a summary ?
true
Short Description
Symbol in syntax defined by the system
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Base
Coding.code [0..1]
Type
code
Mapping
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
AuditEvent.subtype:policyauditeventtype.display
Path
AuditEvent.subtype.display
Cardinality
0..1
Part of a summary ?
true
Short Description
Representation defined by the system
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Base
Coding.display [0..1]
Type
string
Mapping
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
AuditEvent.subtype:policyauditeventtype.userSelected
Path
AuditEvent.subtype.userSelected
Cardinality
0..1
Part of a summary ?
true
Short Description
If this coding was chosen directly by the user
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Base
Coding.userSelected [0..1]
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Type
boolean
Mapping
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AuditEvent.action Binding
Path
AuditEvent.action
Cardinality
0..1
Part of a summary ?
true
Short Description
Type of action performed during the event
Definition
Indicator for type of action performed during the event that generated the audit.
Base
AuditEvent.action [0..1]
Type
code
Binding
AuditEventAction(required) : Indicator for type of action performed during the event that generated the event
Mapping
  • rim:.code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom:EventActionCode
  • w5:what
AuditEvent.recorded
Path
AuditEvent.recorded
Cardinality
1..1
Part of a summary ?
true
Short Description
Time when the event was recorded
Definition
The time when the event was recorded.
Base
AuditEvent.recorded [1..1]
Comment
In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
Type
instant
Mapping
  • rim:.effectiveTime
  • dicom:EventDateTime
  • w3c.prov:Activity.when
  • fhirprovenance:Provenance.recorded
  • w5:when.recorded
  • ch-atc:Event Date and Time
AuditEvent.outcome Binding
Path
AuditEvent.outcome
Cardinality
0..1
Part of a summary ?
true
Short Description
Whether the event succeeded or failed
Definition
Indicates whether the event succeeded or failed.
Base
AuditEvent.outcome [0..1]
Comment
In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant.
Type
code
Binding
AuditEventOutcome(required) : Indicates whether the event succeeded or failed
Mapping
  • rim:.actionNegationInd
  • dicom:EventOutcomeIndicator
  • w5:what
AuditEvent.outcomeDesc
Path
AuditEvent.outcomeDesc
Cardinality
0..1
Part of a summary ?
true
Short Description
Description of the event outcome
Definition
A free text description of the outcome of the event.
Base
AuditEvent.outcomeDesc [0..1]
Type
string
Mapping
  • rim:.outboundRelationship[typeCode=OUT].target.text
  • dicom:EventOutcomeDescription
  • w5:what
AuditEvent.purposeOfEvent Binding
Path
AuditEvent.purposeOfEvent
Cardinality
0..*
Part of a summary ?
true
Short Description
The purposeOfUse of the event
Definition
The purposeOfUse (reason) that was used during the event being recorded.
Base
AuditEvent.purposeOfEvent [0..*]
Comment
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.
Type
CodeableConcept
Binding
AuditPurposeOfUse(extensible) : The reason the activity took place.
Mapping
  • rim:* .reasonCode [ControlActReason when Act.class = CACT Control Act] *.outboundRelationship[typeCode=RSON].target
  • dicom:EventPurposeOfUse
  • w3c.prov:Activity.Activity
  • fhirprovenance:Provenance.reason, Provenance.activity
  • w5:why
AuditEvent.agent Constrained
Path
AuditEvent.agent
Cardinality
1..*
Short Description
Participants
Definition
Participants
Base
AuditEvent.agent [1..*]
Comment
Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
Alias
ActiveParticipant
Type
BackboneElement
Mapping
  • rim:.participation
  • dicom:ActiveParticipant
  • w3c.prov:Agent
  • fhirprovenance:Provenance.agent
  • w5:who
  • ch-atc:Participants
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.agent.id
Path
AuditEvent.agent.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.agent.extension
Path
AuditEvent.agent.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.agent.modifierExtension
Path
AuditEvent.agent.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.agent.role Binding
Path
AuditEvent.agent.role
Cardinality
1..1
Part of a summary ?
true
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.
Base
AuditEvent.agent.role [0..*]
Comment
Should be roles relevant to the event. Should not be an exhaustive list of roles.
Type
CodeableConcept
Binding
ConditionKind(required) : EprParticipant
Mapping
  • rim:.role and/or .typeCode and/or .functionCode
  • dicom:RoleIdCode
  • w3c.prov:Agent.Attribution
  • fhirprovenance:Provenance.agent.role
  • w5:who
  • ch-atc:role (PAT, HCP, ASS, REP, GRP, PADM)
AuditEvent.agent.reference
Path
AuditEvent.agent.reference
Cardinality
0..1
Part of a summary ?
true
Short Description
Direct reference to resource
Definition
Direct reference to a resource that identifies the agent.
Base
AuditEvent.agent.reference [0..1]
Type
  • Reference > http://hl7.org/fhir/StructureDefinition/Practitioner
  • Reference > http://hl7.org/fhir/StructureDefinition/Organization
  • Reference > http://hl7.org/fhir/StructureDefinition/Device
  • Reference > http://hl7.org/fhir/StructureDefinition/Patient
  • Reference > http://hl7.org/fhir/StructureDefinition/RelatedPerson
Mapping
  • rim:.id
  • w3c.prov:Agent.Identity
  • fhirprovenance:Provenance.agent.actor
  • w5:who
AuditEvent.agent.userId
Path
AuditEvent.agent.userId
Cardinality
0..1
Part of a summary ?
true
Short Description
Unique identifier for the user
Definition
Unique identifier for the user
Base
AuditEvent.agent.userId [0..1]
Comment
A unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.
Type
Identifier
Mapping
  • rim:.id
  • dicom:UserId
  • w3c.prov:Agent.Identity
  • fhirprovenance:Provenance.agent.userId
  • w5:who
  • ch-atc:applicable identifier
AuditEvent.agent.altId
Path
AuditEvent.agent.altId
Cardinality
0..1
Short Description
Alternative User id e.g. authentication
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.
Base
AuditEvent.agent.altId [0..1]
Type
string
Mapping
  • rim:.id (distinguish id type by root)
  • dicom:AlternativeUserId
  • w3c.prov:Agent.Identity
  • w5:who
AuditEvent.agent.name
Path
AuditEvent.agent.name
Cardinality
1..1
Part of a summary ?
true
Short Description
Human-meaningful name for the agent
Definition
AttributeStatement/Attribute[@Name='urn:oasis:names:tc:xspa:1.0:subject:subject- id']/AttributeValue
Base
AuditEvent.agent.name [0..1]
Type
string
Mapping
  • rim:.name
  • dicom:UserName
  • w3c.prov:Agent.Identity
  • w5:who
  • ch-atc:Name
AuditEvent.agent.requestor
Path
AuditEvent.agent.requestor
Cardinality
1..1
Part of a summary ?
true
Short Description
Whether user is initiator
Definition
Indicator that the participant is the initiator for the event being audited.
Base
AuditEvent.agent.requestor [1..1]
Comment
There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Type
boolean
Mapping
  • rim:If participation.typeCode was author, then true
  • dicom:UserIsRequestor
  • w5:who
  • ch-atc:if participant is Initiator
AuditEvent.agent.location
Path
AuditEvent.agent.location
Cardinality
0..1
Short Description
Where
Definition
Where the event occurred.
Base
AuditEvent.agent.location [0..1]
Type
Reference > http://hl7.org/fhir/StructureDefinition/Location
Mapping
  • 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 may or may not be constant.
  • w3c.prov:Activity.location
  • fhirprovenance:Provenance.location
  • w5:where
AuditEvent.agent.policy
Path
AuditEvent.agent.policy
Cardinality
0..*
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.
Base
AuditEvent.agent.policy [0..*]
Comment
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.
Type
uri
Mapping
  • rim:ActPolicyType
  • dicom:ParticipantRoleIDCode
  • fhirprovenance:Provenance.policy
  • w5:why
AuditEvent.agent.media Binding
Path
AuditEvent.agent.media
Cardinality
0..1
Short Description
Type of media
Definition
Type of media involved. Used when the event is about exporting/importing onto media.
Base
AuditEvent.agent.media [0..1]
Type
Coding
Binding
DICOMMediaType(extensible) : Used when the event is about exporting/importing onto media.
Mapping
  • rim:.player.description.mediaType
  • dicom:MediaType
  • w5:where
AuditEvent.agent.network Constrained
Path
AuditEvent.agent.network
Cardinality
0..1
Short Description
Logical network location for application activity
Definition
Logical network location for application activity, if the activity has a network location.
Base
AuditEvent.agent.network [0..1]
Type
BackboneElement
Mapping
  • rim:.player.description.reference
  • w5:where
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.agent.network.id
Path
AuditEvent.agent.network.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.agent.network.extension
Path
AuditEvent.agent.network.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.agent.network.modifierExtension
Path
AuditEvent.agent.network.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.agent.network.address
Path
AuditEvent.agent.network.address
Cardinality
0..1
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.
Base
AuditEvent.agent.network.address [0..1]
Comment
This could be a device id, IP address or some other identifier associated with a device.
Type
string
Mapping
  • rim:pre-coordinated into URL
  • dicom:NetworkAccessPointID
  • w3c.prov:Agent.Location
  • w5:where
AuditEvent.agent.network.type Binding
Path
AuditEvent.agent.network.type
Cardinality
0..1
Short Description
The type of network access point
Definition
An identifier for the type of network access point that originated the audit event.
Base
AuditEvent.agent.network.type [0..1]
Type
code
Binding
AuditEventAgentNetworkType(required) : The type of network access point of this agent in the audit event
Mapping
  • rim:pre-coordinated into URL
  • dicom:NetworkAccessPointTypeCode
  • w5:where
AuditEvent.agent.purposeOfUse Binding
Path
AuditEvent.agent.purposeOfUse
Cardinality
0..*
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.
Base
AuditEvent.agent.purposeOfUse [0..*]
Comment
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.
Type
CodeableConcept
Binding
AuditPurposeOfUse(extensible) : The reason the activity took place.
Mapping
  • rim:*.reasonCode [ActHealthInformationPurposeOfUseReason codes/v:PurposeOfUse (2.16.840.1.113883.1.11.20448) * .outboundRelationship[typeCode=RSON or SUBJ].target
  • w3c.prov:Agent.Activity
  • w5:why
AuditEvent.source Constrained
Path
AuditEvent.source
Cardinality
1..1
Short Description
Audit Event Reporter
Definition
The system that is reporting the event.
Base
AuditEvent.source [1..1]
Comment
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.
Type
BackboneElement
Mapping
  • rim:.participation[typeCode=INF].role[classCode=ASSIGN].player[classCode=DEV, determinerCode=INSTANCE]
  • dicom:AuditSourceIdentification
  • w5:who.witness
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.source.id
Path
AuditEvent.source.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.source.extension
Path
AuditEvent.source.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.source.modifierExtension
Path
AuditEvent.source.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.source.site
Path
AuditEvent.source.site
Cardinality
0..1
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.
Base
AuditEvent.source.site [0..1]
Type
string
Mapping
  • rim:.scopedRole[classCode=LOCE].player.desc
  • dicom:AuditEnterpriseSiteId
  • w5:who.witness
AuditEvent.source.identifier
Path
AuditEvent.source.identifier
Cardinality
1..1
Part of a summary ?
true
Short Description
The identity of source detecting the event
Definition
Identifier of the source where the event was detected.
Base
AuditEvent.source.identifier [1..1]
Type
Identifier
Mapping
  • rim:.id
  • dicom:AuditSourceId
  • w5:who.witness
AuditEvent.source.type Binding
Path
AuditEvent.source.type
Cardinality
0..*
Short Description
The type of source where event originated
Definition
Code specifying the type of source where event originated.
Base
AuditEvent.source.type [0..*]
Type
Coding
Binding
AuditEventSourceType(extensible) : Code specifying the type of system that detected and recorded the event.
Mapping
  • rim:.code
  • dicom:AuditSourceTypeCode
  • w5:who.witness
AuditEvent.entity Constrained
Path
AuditEvent.entity
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:type.code
  • Rules:open
Short Description
Data or objects used
Definition
Specific instances of data or objects that have been accessed.
Base
AuditEvent.entity [0..*]
Comment
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.
Alias
ParticipantObject
Type
BackboneElement
Mapping
  • rim:.outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
  • dicom:ParticipantObjectIdentification
  • w3c.prov:Entity
  • fhirprovenance:Provenance.target, Provenance.entity
  • w5:what
  • w5:FiveWs.what[x]
  • rim:.outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorsev-1
Description
Either a name or a query (NOT both)
Expression
name.empty() or query.empty()
XPath
not(exists(f:name)) or not(exists(f:query))
Source
AuditEvent.entity
Severity
errorsev-1
Description
Either a name or a query (NOT both)
Expression
name.empty() or query.empty()
XPath
not(exists(f:name)) or not(exists(f:query))
Source
AuditEvent.entity:patient Constrained
Path
AuditEvent.entity
Cardinality
1..1
Part of a summary ?
true
Short Description
Patient
Slice name
Patient
Definition
Specific instances of data or objects that have been accessed.
Base
AuditEvent.entity [0..*]
Comment
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.
Alias
ParticipantObject
Type
BackboneElement
Mapping
  • rim:.outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
  • dicom:ParticipantObjectIdentification
  • w3c.prov:Entity
  • fhirprovenance:Provenance.target, Provenance.entity
  • w5:what
  • ch-atc:Patient
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorsev-1
Description
Either a name or a query (NOT both)
Expression
name.empty() or query.empty()
XPath
not(exists(f:name)) or not(exists(f:query))
Source
AuditEvent.entity
AuditEvent.entity:patient.id
Path
AuditEvent.entity.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:patient.extension
Path
AuditEvent.entity.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:patient.modifierExtension
Path
AuditEvent.entity.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:patient.identifier
Path
AuditEvent.entity.identifier
Cardinality
1..1
Part of a summary ?
true
Short Description
Patient Id (EPR-SPID)
Definition
Patient Id (EPR-SPID)
Base
AuditEvent.entity.identifier [0..1]
Comment
.
Type
Identifier
Mapping
  • rim:.id.extension
  • dicom:ParticipantObjectID and ParticipantObjectIDTypeCode
  • w5:what
  • ch-atc:EPR-SPID
AuditEvent.entity:patient.identifier.id
Path
AuditEvent.entity.identifier.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:patient.identifier.extension
Path
AuditEvent.entity.identifier.extension
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:url
  • Rules:open
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:patient.identifier.use Binding
Path
AuditEvent.entity.identifier.use
Cardinality
0..1
Part of a summary ?
true
Short Description
usual | official | temp | secondary (If known)
Definition
The purpose of this identifier.
Base
Identifier.use [0..1]
Comment
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Type
code
Binding
IdentifierUse(required) : Identifies the purpose for this identifier, if known .
Mapping
  • v2:N/A
  • rim:Role.code or implied by context
AuditEvent.entity:patient.identifier.type Binding
Path
AuditEvent.entity.identifier.type
Cardinality
0..1
Part of a summary ?
true
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.
Base
Identifier.type [0..1]
Comment
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.
Type
CodeableConcept
Binding
IdentifierType(extensible) : A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Mapping
  • v2:CX.5
  • rim:Role.code or implied by context
AuditEvent.entity:patient.identifier.system Fixed value
Path
AuditEvent.entity.identifier.system
Cardinality
1..1
Part of a summary ?
true
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.
Base
Identifier.system [0..1]
Type
uri
Fixed URI
urn:oid:2.16.756.5.30.1.127.3.10.3
Mapping
  • v2:CX.4 / EI-2-4
  • rim:II.root or Role.id.root
  • servd:./IdentifierType
AuditEvent.entity:patient.identifier.value
Path
AuditEvent.entity.identifier.value
Cardinality
0..1
Part of a summary ?
true
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.
Base
Identifier.value [0..1]
Comment
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](extension-rendered-value.html).
Type
string
Mapping
  • 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
AuditEvent.entity:patient.identifier.period
Path
AuditEvent.entity.identifier.period
Cardinality
0..1
Part of a summary ?
true
Short Description
Time period when id is/was valid for use
Definition
Time period during which identifier is/was valid for use.
Base
Identifier.period [0..1]
Type
Period
Mapping
  • v2:CX.7 + CX.8
  • rim:Role.effectiveTime or implied by context
  • servd:./StartDate and ./EndDate
AuditEvent.entity:patient.identifier.assigner
Path
AuditEvent.entity.identifier.assigner
Cardinality
0..1
Part of a summary ?
true
Short Description
Organization that issued id (may be just text)
Definition
Organization that issued/manages the identifier.
Base
Identifier.assigner [0..1]
Comment
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.
Type
Reference > http://hl7.org/fhir/StructureDefinition/Organization
Mapping
  • 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
AuditEvent.entity:patient.reference
Path
AuditEvent.entity.reference
Cardinality
0..1
Part of a summary ?
true
Short Description
Specific instance of resource
Definition
Identifies a specific instance of the entity. The reference should be version specific.
Base
AuditEvent.entity.reference [0..1]
Type
Reference > http://hl7.org/fhir/StructureDefinition/Resource
Mapping
  • rim:[self]
  • dicom:ParticipantObjectID
  • fhirprovenance:Provenance.target, Provenance.entity.reference
  • w5:what
AuditEvent.entity:patient.type Binding
Path
AuditEvent.entity.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Type of entity involved
Definition
The type of the object that was involved in this audit event.
Base
AuditEvent.entity.type [0..1]
Comment
This value is distinct from the user's role or any user relationship to the entity.
Type
Coding
Binding
AuditEventEntityType(extensible) : Code for the entity type involved in the audit event
Mapping
  • rim:[self::Act].code or role.player.code
  • dicom:ParticipantObjectTypeCode
  • w3c.prov:Entity.type
  • fhirprovenance:Provenance.entity.type
  • w5:what
AuditEvent.entity:patient.type.id
Path
AuditEvent.entity.type.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:patient.type.extension
Path
AuditEvent.entity.type.extension
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:url
  • Rules:open
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:patient.type.system
Path
AuditEvent.entity.type.system
Cardinality
0..1
Part of a summary ?
true
Short Description
Identity of the terminology system
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Base
Coding.system [0..1]
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Type
uri
Mapping
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AuditEvent.entity:patient.type.version
Path
AuditEvent.entity.type.version
Cardinality
0..1
Part of a summary ?
true
Short Description
Version of the system - if relevant
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Base
Coding.version [0..1]
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Type
string
Mapping
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AuditEvent.entity:patient.type.code Fixed value
Path
AuditEvent.entity.type.code
Cardinality
1..1
Part of a summary ?
true
Short Description
Symbol in syntax defined by the system
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Base
Coding.code [0..1]
Type
code
Fixed code
1
Mapping
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
AuditEvent.entity:patient.type.display
Path
AuditEvent.entity.type.display
Cardinality
0..1
Part of a summary ?
true
Short Description
Representation defined by the system
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Base
Coding.display [0..1]
Type
string
Mapping
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
AuditEvent.entity:patient.type.userSelected
Path
AuditEvent.entity.type.userSelected
Cardinality
0..1
Part of a summary ?
true
Short Description
If this coding was chosen directly by the user
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Base
Coding.userSelected [0..1]
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Type
boolean
Mapping
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AuditEvent.entity:patient.role Binding
Path
AuditEvent.entity.role
Cardinality
1..1
Part of a summary ?
true
Short Description
What role the entity played
Definition
Code representing the role the entity played in the event being audited.
Base
AuditEvent.entity.role [0..1]
Type
Coding
Binding
AuditEventEntityRole(extensible) : Code representing the role the entity played in the audit event
Mapping
  • rim:role.code (not sure what this would mean for an Act)
  • dicom:ParticipantObjectTypeCodeRole
  • w3c.prov:Entity.role
  • w5:context
AuditEvent.entity:patient.role.id
Path
AuditEvent.entity.role.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:patient.role.extension
Path
AuditEvent.entity.role.extension
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:url
  • Rules:open
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:patient.role.system
Path
AuditEvent.entity.role.system
Cardinality
0..1
Part of a summary ?
true
Short Description
Identity of the terminology system
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Base
Coding.system [0..1]
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Type
uri
Mapping
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AuditEvent.entity:patient.role.version
Path
AuditEvent.entity.role.version
Cardinality
0..1
Part of a summary ?
true
Short Description
Version of the system - if relevant
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Base
Coding.version [0..1]
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Type
string
Mapping
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AuditEvent.entity:patient.role.code Fixed value
Path
AuditEvent.entity.role.code
Cardinality
1..1
Part of a summary ?
true
Short Description
Symbol in syntax defined by the system
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Base
Coding.code [0..1]
Type
code
Fixed code
1
Mapping
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
AuditEvent.entity:patient.role.display
Path
AuditEvent.entity.role.display
Cardinality
0..1
Part of a summary ?
true
Short Description
Representation defined by the system
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Base
Coding.display [0..1]
Type
string
Mapping
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
AuditEvent.entity:patient.role.userSelected
Path
AuditEvent.entity.role.userSelected
Cardinality
0..1
Part of a summary ?
true
Short Description
If this coding was chosen directly by the user
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Base
Coding.userSelected [0..1]
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Type
boolean
Mapping
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AuditEvent.entity:patient.lifecycle Binding
Path
AuditEvent.entity.lifecycle
Cardinality
0..1
Short Description
Life-cycle stage for the entity
Definition
Identifier for the data life-cycle stage for the entity.
Base
AuditEvent.entity.lifecycle [0..1]
Comment
This can be used to provide an audit trail for data, over time, as it passes through the system.
Type
Coding
Binding
AuditEventEntityLifecycle(extensible) : Identifier for the data life-cycle stage for the entity
Mapping
  • rim:target of ObservationEvent[code="lifecycle"].value
  • dicom:ParticipantObjectDataLifeCycle
  • w3c.prov:Entity.role
  • fhirprovenance:Provenance.entity.role
  • w5:context
AuditEvent.entity:patient.securityLabel Binding
Path
AuditEvent.entity.securityLabel
Cardinality
0..*
Short Description
Security labels on the entity
Definition
Security labels for the identified entity.
Base
AuditEvent.entity.securityLabel [0..*]
Comment
Copied from entity meta security tags.
Type
Coding
Binding
SecurityLabels(extensible) : Security Labels from the Healthcare Privacy and Security Classification System.
Mapping
  • rim:.confidentialityCode
  • dicom:ParticipantObjectSensitivity
  • w5:context
AuditEvent.entity:patient.name
Path
AuditEvent.entity.name
Cardinality
0..1
Part of a summary ?
true
Short Description
Descriptor for entity
Definition
A name of the entity in the audit event.
Base
AuditEvent.entity.name [0..1]
Comment
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.
Type
string
Mapping
  • rim:.title
  • dicom:ParticipantObjectName
  • w3c.prov:Entity.Label
  • w5:context
AuditEvent.entity:patient.description
Path
AuditEvent.entity.description
Cardinality
0..1
Short Description
Descriptive text
Definition
Text that describes the entity in more detail.
Base
AuditEvent.entity.description [0..1]
Type
string
Mapping
  • rim:.text
  • dicom:ParticipantObjectDescription
  • w5:context
AuditEvent.entity:patient.query
Path
AuditEvent.entity.query
Cardinality
0..1
Part of a summary ?
true
Short Description
Query parameters
Definition
The query parameters for a query-type entities.
Base
AuditEvent.entity.query [0..1]
Type
base64Binary
Mapping
  • rim:No mapping
  • dicom:ParticipantObjectQuery
  • w5:context
AuditEvent.entity:patient.detail Constrained
Path
AuditEvent.entity.detail
Cardinality
0..*
Short Description
Additional Information about the entity
Definition
Tagged value pairs for conveying additional information about the entity.
Base
AuditEvent.entity.detail [0..*]
Type
BackboneElement
Mapping
  • rim:.inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom:ParticipantObjectDetail
  • w5:context
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.entity:patient.detail.id
Path
AuditEvent.entity.detail.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:patient.detail.extension
Path
AuditEvent.entity.detail.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:patient.detail.modifierExtension
Path
AuditEvent.entity.detail.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:patient.detail.type
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Short Description
Name of the property
Definition
The type of extra detail provided in the value.
Base
AuditEvent.entity.detail.type [1..1]
Type
string
Mapping
  • rim:.code
  • dicom:ParticipantObjectDetail.type
  • w5:context
AuditEvent.entity:patient.detail.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Short Description
Property value
Definition
The details, base64 encoded. Used to carry bulk information.
Base
AuditEvent.entity.detail.value [1..1]
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • rim:.value
  • dicom:ParticipantObjectDetail.value
  • w5:context
AuditEvent.entity:resource Constrained
Path
AuditEvent.entity
Cardinality
0..1
Part of a summary ?
true
Short Description
Resource (HCP, Group, Representative of Patient)
Slice name
Resource
Definition
Specific instances of data or objects that have been accessed.
Base
AuditEvent.entity [0..*]
Comment
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.
Alias
ParticipantObject
Type
BackboneElement
Mapping
  • rim:.outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
  • dicom:ParticipantObjectIdentification
  • w3c.prov:Entity
  • fhirprovenance:Provenance.target, Provenance.entity
  • w5:what
  • ch-atc:Resource
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
Severity
errorsev-1
Description
Either a name or a query (NOT both)
Expression
name.empty() or query.empty()
XPath
not(exists(f:name)) or not(exists(f:query))
Source
AuditEvent.entity
AuditEvent.entity:resource.id
Path
AuditEvent.entity.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:resource.extension
Path
AuditEvent.entity.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:resource.modifierExtension
Path
AuditEvent.entity.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:resource.identifier
Path
AuditEvent.entity.identifier
Cardinality
0..1
Part of a summary ?
true
Short Description
Identifier. HCP (GLN), Group (OID)
Definition
Identifier. HCP (GLN), Group (OID)
Base
AuditEvent.entity.identifier [0..1]
Comment
Identifier detail depends on entity type.
Type
Identifier
Mapping
  • rim:.id.extension
  • dicom:ParticipantObjectID and ParticipantObjectIDTypeCode
  • w5:what
  • ch-atc:identifier: GLN for HCP, OID for Group
AuditEvent.entity:resource.reference
Path
AuditEvent.entity.reference
Cardinality
0..1
Part of a summary ?
true
Short Description
Specific instance of resource
Definition
Identifies a specific instance of the entity. The reference should be version specific.
Base
AuditEvent.entity.reference [0..1]
Type
Reference > http://hl7.org/fhir/StructureDefinition/Resource
Mapping
  • rim:[self]
  • dicom:ParticipantObjectID
  • fhirprovenance:Provenance.target, Provenance.entity.reference
  • w5:what
AuditEvent.entity:resource.type Binding
Path
AuditEvent.entity.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Type of entity involved
Definition
The type of the object that was involved in this audit event.
Base
AuditEvent.entity.type [0..1]
Comment
This value is distinct from the user's role or any user relationship to the entity.
Type
Coding
Binding
AuditEventEntityType(extensible) : Code for the entity type involved in the audit event
Mapping
  • rim:[self::Act].code or role.player.code
  • dicom:ParticipantObjectTypeCode
  • w3c.prov:Entity.type
  • fhirprovenance:Provenance.entity.type
  • w5:what
AuditEvent.entity:resource.type.id
Path
AuditEvent.entity.type.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:resource.type.extension
Path
AuditEvent.entity.type.extension
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:url
  • Rules:open
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:resource.type.system
Path
AuditEvent.entity.type.system
Cardinality
0..1
Part of a summary ?
true
Short Description
Identity of the terminology system
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Base
Coding.system [0..1]
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.
Type
uri
Mapping
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
AuditEvent.entity:resource.type.version
Path
AuditEvent.entity.type.version
Cardinality
0..1
Part of a summary ?
true
Short Description
Version of the system - if relevant
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Base
Coding.version [0..1]
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Type
string
Mapping
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AuditEvent.entity:resource.type.code Fixed value
Path
AuditEvent.entity.type.code
Cardinality
1..1
Part of a summary ?
true
Short Description
Symbol in syntax defined by the system
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Base
Coding.code [0..1]
Type
code
Fixed code
2
Mapping
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
AuditEvent.entity:resource.type.display
Path
AuditEvent.entity.type.display
Cardinality
0..1
Part of a summary ?
true
Short Description
Representation defined by the system
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Base
Coding.display [0..1]
Type
string
Mapping
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
AuditEvent.entity:resource.type.userSelected
Path
AuditEvent.entity.type.userSelected
Cardinality
0..1
Part of a summary ?
true
Short Description
If this coding was chosen directly by the user
Definition
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
Base
Coding.userSelected [0..1]
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Type
boolean
Mapping
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AuditEvent.entity:resource.role Binding
Path
AuditEvent.entity.role
Cardinality
1..1
Part of a summary ?
true
Short Description
What role the entity played
Definition
Code representing the role the entity played in the event being audited.
Base
AuditEvent.entity.role [0..1]
Type
Coding
Binding
ConditionKind(required) : EprParticipant
Mapping
  • rim:role.code (not sure what this would mean for an Act)
  • dicom:ParticipantObjectTypeCodeRole
  • w3c.prov:Entity.role
  • w5:context
  • ch-atc:role (HCP, REP, GRP)
AuditEvent.entity:resource.lifecycle Binding
Path
AuditEvent.entity.lifecycle
Cardinality
0..1
Short Description
Life-cycle stage for the entity
Definition
Identifier for the data life-cycle stage for the entity.
Base
AuditEvent.entity.lifecycle [0..1]
Comment
This can be used to provide an audit trail for data, over time, as it passes through the system.
Type
Coding
Binding
AuditEventEntityLifecycle(extensible) : Identifier for the data life-cycle stage for the entity
Mapping
  • rim:target of ObservationEvent[code="lifecycle"].value
  • dicom:ParticipantObjectDataLifeCycle
  • w3c.prov:Entity.role
  • fhirprovenance:Provenance.entity.role
  • w5:context
AuditEvent.entity:resource.securityLabel Binding
Path
AuditEvent.entity.securityLabel
Cardinality
0..*
Short Description
Security labels on the entity
Definition
Security labels for the identified entity.
Base
AuditEvent.entity.securityLabel [0..*]
Comment
Copied from entity meta security tags.
Type
Coding
Binding
SecurityLabels(extensible) : Security Labels from the Healthcare Privacy and Security Classification System.
Mapping
  • rim:.confidentialityCode
  • dicom:ParticipantObjectSensitivity
  • w5:context
AuditEvent.entity:resource.name
Path
AuditEvent.entity.name
Cardinality
1..1
Part of a summary ?
true
Short Description
Descriptor for entity
Definition
A name of the entity in the audit event.
Base
AuditEvent.entity.name [0..1]
Comment
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.
Type
string
Mapping
  • rim:.title
  • dicom:ParticipantObjectName
  • w3c.prov:Entity.Label
  • w5:context
  • ch-atc:Name of HCP, Group or Representative of Patient
AuditEvent.entity:resource.description
Path
AuditEvent.entity.description
Cardinality
0..1
Short Description
Descriptive text
Definition
Text that describes the entity in more detail.
Base
AuditEvent.entity.description [0..1]
Type
string
Mapping
  • rim:.text
  • dicom:ParticipantObjectDescription
  • w5:context
AuditEvent.entity:resource.query
Path
AuditEvent.entity.query
Cardinality
0..1
Part of a summary ?
true
Short Description
Query parameters
Definition
The query parameters for a query-type entities.
Base
AuditEvent.entity.query [0..1]
Type
base64Binary
Mapping
  • rim:No mapping
  • dicom:ParticipantObjectQuery
  • w5:context
AuditEvent.entity:resource.detail Constrained
Path
AuditEvent.entity.detail
Cardinality
0..*
Part of a summary ?
true
Slicing
  • Descriminator type:value
  • Descriminator path:type
  • Rules:open
Short Description
Additional Information about the entity
Definition
Tagged value pairs for conveying additional information about the entity.
Base
AuditEvent.entity.detail [0..*]
Type
BackboneElement
Mapping
  • rim:.inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom:ParticipantObjectDetail
  • w5:context
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.entity:resource.detail:accesslevel Constrained
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
AccessLevel if subtype is Create or Update
Slice name
AccessLevel
Definition
The type of extra detail provided in the value.
Base
AuditEvent.entity.detail [0..*]
Type
BackboneElement
Mapping
  • rim:.inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom:ParticipantObjectDetail
  • w5:context
  • ch-atc:AccessLevel
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.entity:resource.detail:accesslevel.id
Path
AuditEvent.entity.detail.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:accesslevel.extension
Path
AuditEvent.entity.detail.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:accesslevel.modifierExtension
Path
AuditEvent.entity.detail.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:resource.detail:accesslevel.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
The type of extra detail provided in the value.
Definition
The type of extra detail provided in the value.
Base
AuditEvent.entity.detail.type [1..1]
Type
string
Fixed code
AccessLevel
Mapping
  • rim:.code
  • dicom:ParticipantObjectDetail.type
  • w5:context
AuditEvent.entity:resource.detail:accesslevel.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
one of urn:e-health-suisse:2015:policies:access-level: normal,restricted,delegation-and-restricted,delegation-and-normal or full
Definition
The details, base64 encoded. Used to carry bulk information.
Base
AuditEvent.entity.detail.value [1..1]
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • rim:.value
  • dicom:ParticipantObjectDetail.value
  • w5:context
AuditEvent.entity:resource.detail:accesslimitedtodate Constrained
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
AccessLimitedToDate if subtype is Create or Update
Slice name
AccessLimitedToDate
Definition
Tagged value pairs for conveying additional information about the entity.
Base
AuditEvent.entity.detail [0..*]
Type
BackboneElement
Mapping
  • rim:.inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom:ParticipantObjectDetail
  • w5:context
  • ch-atc:AccessLimitedToDate
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.entity:resource.detail:accesslimitedtodate.id
Path
AuditEvent.entity.detail.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:accesslimitedtodate.extension
Path
AuditEvent.entity.detail.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:accesslimitedtodate.modifierExtension
Path
AuditEvent.entity.detail.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:resource.detail:accesslimitedtodate.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Name of the property
Definition
The type of extra detail provided in the value.
Base
AuditEvent.entity.detail.type [1..1]
Type
string
Fixed code
AccessLimitedToDate
Mapping
  • rim:.code
  • dicom:ParticipantObjectDetail.type
  • w5:context
AuditEvent.entity:resource.detail:accesslimitedtodate.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
date in Property value
Definition
The details, base64 encoded. Used to carry bulk information.
Base
AuditEvent.entity.detail.value [1..1]
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • rim:.value
  • dicom:ParticipantObjectDetail.value
  • w5:context
AuditEvent.entity:resource.detail:providelevel Constrained
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
ProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
Slice name
ProvideLevel
Definition
Tagged value pairs for conveying additional information about the entity.
Base
AuditEvent.entity.detail [0..*]
Type
BackboneElement
Mapping
  • rim:.inboundRelationship[typeCode=SUBJ].target[classCode=OBS, moodCode=EVN]
  • dicom:ParticipantObjectDetail
  • w5:context
  • ch-atc:ProvideLevel
Constraints
Severity
errorele-1
Description
All FHIR elements must have a @value or children
Expression
hasValue() | (children().count() > id.count())
XPath
@value|f:*|h:div
Source
Element
AuditEvent.entity:resource.detail:providelevel.id
Path
AuditEvent.entity.detail.id
Cardinality
0..1
Representation
Short Description
xml:id (or equivalent in JSON)
Definition
unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Base
Element.id [0..1]
Type
string
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:providelevel.extension
Path
AuditEvent.entity.detail.extension
Cardinality
0..*
Short Description
Additional Content defined by implementations
Definition
May be used to represent additional information that is not part of the basic definition of the element. In order 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.
Base
Element.extension [0..*]
Comment
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.
Alias
extensions, user content
Type
Extension
Mapping
  • rim:n/a
AuditEvent.entity:resource.detail:providelevel.modifierExtension
Path
AuditEvent.entity.detail.modifierExtension
Cardinality
0..*
Part of a summary ?
true
Short Description
Extensions that cannot be ignored
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
Base
BackboneElement.modifierExtension [0..*]
Comment
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.
Alias
extensions, user content, modifiers
Type
Extension
Mapping
  • rim:N/A
AuditEvent.entity:resource.detail:providelevel.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Name of the property
Definition
The type of extra detail provided in the value.
Base
AuditEvent.entity.detail.type [1..1]
Type
string
Fixed code
ProvideLevel
Mapping
  • rim:.code
  • dicom:ParticipantObjectDetail.type
  • w5:context
AuditEvent.entity:resource.detail:providelevel.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
one of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret
Definition
The details, base64 encoded. Used to carry bulk information.
Base
AuditEvent.entity.detail.value [1..1]
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • rim:.value
  • dicom:ParticipantObjectDetail.value
  • w5:context
Id
Cardinality
[0..*]
[1..1]
[1..*]
[1..1]
[1..*]
[1..1]
[1..*]
[1..1]
[1..*]
[1..1]
[0..1]
[1..1]
[1..1]
[0..*]
[1..1]
[1..1]
[1..*]
[1..1]
[1..*]
[1..1]
[1..*]
[0..1]
[0..1]
[1..1]
[1..*]
[1..1]
[1..1]
[0..*]
[0..1]
[1..1]
[1..1]
[0..1]
[1..1]
[1..1]
[0..1]
[1..1]
[1..1]
AuditEvent Constrained
Path
AuditEvent
Cardinality
0..*
Short Description
Policy Audit Trail Content Profile
Definition
Policy Audit Trail Content Profil
Comment
Based on ATNA (RFC 3881).
Mapping
  • dicom:Message
Constraints
Severity
errorch-atc-pae-1
Description
subtype needs to be fixed to ValueSet PolicyAuditEventType
Expression
subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
XPath
Source
AuditEvent.id
Path
AuditEvent.id
Cardinality
1..1
Part of a summary ?
true
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.
Base
Resource.id [0..1]
Comment
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Type
id
AuditEvent.text
Path
AuditEvent.text
Cardinality
1..*
Short Description
A human-readable narrative that contains the summary of the Audit Event.
Definition
A human-readable narrative that contains the summary of the Audit Event.
Alias
narrative, html, xhtml, display
AuditEvent.type Binding
Path
AuditEvent.type
Cardinality
1..1
Part of a summary ?
true
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.
Type
Coding
Binding
AuditEventType(extensible) : Type of event.
Mapping
  • rim:.code (type, subtype and action are pre-coordinated or sent as translations)
  • dicom:EventId
  • w3c.prov:Activity
  • w5:what
AuditEvent.subtype
Path
AuditEvent.subtype
Cardinality
1..*
Part of a summary ?
true
Slicing
  • Descriminator type:value
  • Descriminator path:system
  • Rules:open
Type
Coding
Mapping
  • dicom:EventTypeCode
AuditEvent.subtype:policyauditeventtype Binding
Path
AuditEvent.subtype
Cardinality
1..1
Part of a summary ?
true
Short Description
PolicyAuditEventType
Slice name
PolicyAuditEventType
Binding
ConditionKind(required) : Policy Audit Event Type
Mapping
  • ch-atc:Event Type
AuditEvent.subtype:policyauditeventtype.system Fixed value
Path
AuditEvent.subtype.system
Cardinality
1..*
Fixed code
urn:oid:2.16.756.5.30.1.127.3.10.7
AuditEvent.recorded
Path
AuditEvent.recorded
Cardinality
1..1
Part of a summary ?
true
Short Description
Time when the event was recorded
Definition
The time when the event was recorded.
Comment
In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
Type
instant
Mapping
  • ch-atc:Event Date and Time
AuditEvent.agent
Path
AuditEvent.agent
Cardinality
1..*
Short Description
Participants
Definition
Participants
Comment
Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity. For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
Alias
ActiveParticipant
Type
BackboneElement
Mapping
  • dicom:ActiveParticipant
  • ch-atc:Participants
AuditEvent.agent.role Binding
Path
AuditEvent.agent.role
Cardinality
1..1
Part of a summary ?
true
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.
Comment
Should be roles relevant to the event. Should not be an exhaustive list of roles.
Type
CodeableConcept
Binding
ConditionKind(required) : EprParticipant
Mapping
  • dicom:RoleIdCode
  • ch-atc:role (PAT, HCP, ASS, REP, GRP, PADM)
AuditEvent.agent.userId
Path
AuditEvent.agent.userId
Cardinality
0..1
Part of a summary ?
true
Short Description
Unique identifier for the user
Definition
Unique identifier for the user
Comment
A unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.
Type
Identifier
Mapping
  • dicom:UserId
  • ch-atc:applicable identifier
AuditEvent.agent.name
Path
AuditEvent.agent.name
Cardinality
1..1
Part of a summary ?
true
Short Description
Human-meaningful name for the agent
Definition
AttributeStatement/Attribute[@Name='urn:oasis:names:tc:xspa:1.0:subject:subject- id']/AttributeValue
Type
string
Mapping
  • dicom:UserName
  • ch-atc:Name
AuditEvent.agent.requestor
Path
AuditEvent.agent.requestor
Cardinality
1..1
Part of a summary ?
true
Short Description
Whether user is initiator
Definition
Indicator that the participant is the initiator for the event being audited.
Comment
There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
Type
boolean
Mapping
  • rim:If participation.typeCode was author, then true
  • dicom:UserIsRequestor
  • w5:who
  • ch-atc:if participant is Initiator
AuditEvent.entity Constrained
Path
AuditEvent.entity
Cardinality
0..*
Slicing
  • Descriminator type:value
  • Descriminator path:type.code
  • Rules:open
Short Description
Data or objects used
Definition
Specific instances of data or objects that have been accessed.
Comment
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.
Alias
ParticipantObject
Type
BackboneElement
Mapping
  • w5:FiveWs.what[x]
  • rim:.outboundRelationship[typeCode=SUBJ].target or .participation[typeCode=SBJ].role
  • dicom:ParticipantObjectIdentification
  • w3c.prov:Entity
  • fhirprovenance:Provenance.target, Provenance.entity
Constraints
Severity
errorsev-1
Description
Either a name or a query (NOT both)
Expression
name.empty() or query.empty()
XPath
not(exists(f:name)) or not(exists(f:query))
Source
AuditEvent.entity:patient
Path
AuditEvent.entity
Cardinality
1..1
Part of a summary ?
true
Short Description
Patient
Slice name
Patient
Mapping
  • ch-atc:Patient
AuditEvent.entity:patient.identifier
Path
AuditEvent.entity.identifier
Cardinality
1..1
Part of a summary ?
true
Short Description
Patient Id (EPR-SPID)
Definition
Patient Id (EPR-SPID)
Comment
.
Type
Identifier
Mapping
  • dicom:ParticipantObjectID and ParticipantObjectIDTypeCode
  • ch-atc:EPR-SPID
AuditEvent.entity:patient.identifier.system Fixed value
Path
AuditEvent.entity.identifier.system
Cardinality
1..*
Fixed URI
urn:oid:2.16.756.5.30.1.127.3.10.3
AuditEvent.entity:patient.type
Path
AuditEvent.entity.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Type of entity involved
Definition
The type of the object that was involved in this audit event.
Comment
This value is distinct from the user's role or any user relationship to the entity.
Type
Coding
AuditEvent.entity:patient.type.code Fixed value
Path
AuditEvent.entity.type.code
Cardinality
1..*
Part of a summary ?
true
Fixed code
1
AuditEvent.entity:patient.role
Path
AuditEvent.entity.role
Cardinality
1..1
Part of a summary ?
true
Short Description
What role the entity played
Definition
Code representing the role the entity played in the event being audited.
Type
Coding
AuditEvent.entity:patient.role.code Fixed value
Path
AuditEvent.entity.role.code
Cardinality
1..*
Part of a summary ?
true
Fixed code
1
AuditEvent.entity:resource
Path
AuditEvent.entity
Cardinality
0..1
Part of a summary ?
true
Short Description
Resource (HCP, Group, Representative of Patient)
Slice name
Resource
Mapping
  • ch-atc:Resource
AuditEvent.entity:resource.identifier
Path
AuditEvent.entity.identifier
Cardinality
0..1
Part of a summary ?
true
Short Description
Identifier. HCP (GLN), Group (OID)
Definition
Identifier. HCP (GLN), Group (OID)
Type
Identifier
Mapping
  • ch-atc:identifier: GLN for HCP, OID for Group
AuditEvent.entity:resource.type
Path
AuditEvent.entity.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Type of entity involved
Definition
The type of the object that was involved in this audit event.
Comment
This value is distinct from the user's role or any user relationship to the entity.
Type
Coding
AuditEvent.entity:resource.type.code Fixed value
Path
AuditEvent.entity.type.code
Cardinality
1..*
Fixed code
2
AuditEvent.entity:resource.role Binding
Path
AuditEvent.entity.role
Cardinality
1..1
Part of a summary ?
true
Short Description
What role the entity played
Definition
Code representing the role the entity played in the event being audited.
Type
Coding
Binding
ConditionKind(required) : EprParticipant
Mapping
  • ch-atc:role (HCP, REP, GRP)
AuditEvent.entity:resource.name
Path
AuditEvent.entity.name
Cardinality
1..1
Part of a summary ?
true
Short Description
Descriptor for entity
Definition
A name of the entity in the audit event.
Comment
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.
Type
string
Mapping
  • rim:.title
  • dicom:ParticipantObjectName
  • w3c.prov:Entity.Label
  • w5:context
  • ch-atc:Name of HCP, Group or Representative of Patient
AuditEvent.entity:resource.detail
Path
AuditEvent.entity.detail
Cardinality
0..*
Part of a summary ?
true
Slicing
  • Descriminator type:value
  • Descriminator path:type
  • Rules:open
Mapping
  • dicom:ParticipantObjectDetail
AuditEvent.entity:resource.detail:accesslevel
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
AccessLevel if subtype is Create or Update
Slice name
AccessLevel
Definition
The type of extra detail provided in the value.
Mapping
  • ch-atc:AccessLevel
AuditEvent.entity:resource.detail:accesslevel.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
The type of extra detail provided in the value.
Definition
The type of extra detail provided in the value.
Type
string
Fixed code
AccessLevel
AuditEvent.entity:resource.detail:accesslevel.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
one of urn:e-health-suisse:2015:policies:access-level: normal,restricted,delegation-and-restricted,delegation-and-normal or full
Definition
The details, base64 encoded. Used to carry bulk information.
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • dicom:ParticipantObjectDetail.value
AuditEvent.entity:resource.detail:accesslimitedtodate
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
AccessLimitedToDate if subtype is Create or Update
Slice name
AccessLimitedToDate
Mapping
  • ch-atc:AccessLimitedToDate
AuditEvent.entity:resource.detail:accesslimitedtodate.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Name of the property
Definition
The type of extra detail provided in the value.
Type
string
Fixed code
AccessLimitedToDate
AuditEvent.entity:resource.detail:accesslimitedtodate.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
date in Property value
Definition
The details, base64 encoded. Used to carry bulk information.
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • dicom:ParticipantObjectDetail.value
AuditEvent.entity:resource.detail:providelevel
Path
AuditEvent.entity.detail
Cardinality
0..1
Part of a summary ?
true
Short Description
ProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
Slice name
ProvideLevel
Mapping
  • ch-atc:ProvideLevel
AuditEvent.entity:resource.detail:providelevel.type Fixed value
Path
AuditEvent.entity.detail.type
Cardinality
1..1
Part of a summary ?
true
Short Description
Name of the property
Definition
The type of extra detail provided in the value.
Type
string
Fixed code
ProvideLevel
AuditEvent.entity:resource.detail:providelevel.value
Path
AuditEvent.entity.detail.value
Cardinality
1..1
Part of a summary ?
true
Short Description
one of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret
Definition
The details, base64 encoded. Used to carry bulk information.
Comment
The value is base64 encoded to enable various encodings or binary content.
Type
base64Binary
Mapping
  • dicom:ParticipantObjectDetail.value