CH ATC (R4)
3.3.0-cibuild - ci-build Switzerland flag

CH ATC (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 3.3.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-atc/ and changes regularly. See the Directory of published versions

Resource Profile: Profile on PolicyAuditEvent for CH ATC

Official URL: http://fhir.ch/ig/ch-atc/StructureDefinition/PolicyAuditEvent Version: 3.3.0-cibuild
Active as of 2018-05-28 Computable Name: PolicyAuditEvent

Copyright/Legal: CC0-1.0

This profile defines the content of the policy audit events which a community has to provide for a patients audit trail.

Usage:

Formal Views of Profile Content

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

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... type 1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... Slices for subtype 1..*CodingMore specific type/id for the event
Slice: Unordered, Open by value:system
.... subtype:PolicyAuditEventType 1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type

..... system 1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
... recorded 1..1instantTime when the event was recorded
.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant

.... who
..... identifier 1..1IdentifierLogical reference, when literal reference is not known
.... name 1..1stringHuman friendly name for the agent
.... requestor 1..1booleanWhether user is initiator
... Slices for entity 0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:Patient 1..1BackboneElementPatient
..... what
...... identifier 1..1IdentifierPatient Id (EPR-SPID)
....... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
..... type 1..1CodingType of entity involved
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 1
..... role 1..1CodingWhat role the entity played
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 1
.... entity:Resource 0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... what
...... identifier 0..1IdentifierIdentifier: HCP (GLN), Group (OID)
..... type 1..1CodingType of entity involved
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 2
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... name 1..1stringDescriptor for entity
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

.... subtype:PolicyAuditEventType Σ1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type


..... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
... recorded Σ1..1instantTime when the event was recorded
... agent 1..*BackboneElementParticipants
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant


.... name 1..1stringHuman friendly name for the agent
.... requestor Σ1..1booleanWhether user is initiator
... source 1..1BackboneElementAudit Event Reporter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity:Patient C1..1BackboneElementPatient
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
..... role 1..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
.... entity:Resource C0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 2
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... name ΣC1..1stringDescriptor for entity
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value[x] 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Patient.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Patient.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Resource.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:ResourceEither a name or a query (NOT both)
: name.empty() or query.empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... Slices for subtype Σ1..*CodingMore specific type/id for the event
Slice: Unordered, Open by value:system
Binding: AuditEventSub-Type (extensible): Sub-type of event.


.... subtype:PolicyAuditEventType Σ1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... action Σ0..1codeType of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1PeriodWhen the activity occurred
... recorded Σ1..1instantTime when the event was recorded
... outcome Σ0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ0..1stringDescription of the event outcome
... purposeOfEvent Σ0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... agent 1..*BackboneElementParticipants
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.

.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant


.... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
.... altId 0..1stringAlternative User identity
.... name 1..1stringHuman friendly name for the agent
.... requestor Σ1..1booleanWhether user is initiator
.... location 0..1Reference(Location)Where
.... policy 0..*uriPolicy that authorized event
.... media 0..1CodingType of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

.... network 0..1BackboneElementLogical network location for application activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address 0..1stringIdentifier for the network access point of the user device
..... type 0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

.... purposeOfUse 0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source 1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1stringLogical source location within the enterprise
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type 0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
..... type 0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

..... role 0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:Patient C1..1BackboneElementPatient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ1..1IdentifierPatient Id (EPR-SPID)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

....... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... role 1..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:Resource C0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierIdentifier: HCP (GLN), Group (OID)
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 2
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC1..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:All Slices Content/Rules for all slices
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value[x] 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.agent.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:Patient.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:Patient.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:Patient.what.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.entity:Patient.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Patient.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Patient.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:Patient.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:Resource.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:Resource.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Resource.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:Resource.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:ResourceEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 10 elements (7 nested mandatory elements)
Fixed Value: 8 elements

Slices

This structure defines the following Slices:

  • The element AuditEvent.subtype is sliced based on the value of value:system
  • The element AuditEvent.entity is sliced based on the value of value:type.code
  • The element AuditEvent.entity.detail is sliced based on the value of value:type

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... type 1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... Slices for subtype 1..*CodingMore specific type/id for the event
Slice: Unordered, Open by value:system
.... subtype:PolicyAuditEventType 1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type

..... system 1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
... recorded 1..1instantTime when the event was recorded
.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant

.... who
..... identifier 1..1IdentifierLogical reference, when literal reference is not known
.... name 1..1stringHuman friendly name for the agent
.... requestor 1..1booleanWhether user is initiator
... Slices for entity 0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:Patient 1..1BackboneElementPatient
..... what
...... identifier 1..1IdentifierPatient Id (EPR-SPID)
....... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
..... type 1..1CodingType of entity involved
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 1
..... role 1..1CodingWhat role the entity played
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 1
.... entity:Resource 0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... what
...... identifier 0..1IdentifierIdentifier: HCP (GLN), Group (OID)
..... type 1..1CodingType of entity involved
...... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 2
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... name 1..1stringDescriptor for entity
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

.... subtype:PolicyAuditEventType Σ1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type


..... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
... recorded Σ1..1instantTime when the event was recorded
... agent 1..*BackboneElementParticipants
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant


.... name 1..1stringHuman friendly name for the agent
.... requestor Σ1..1booleanWhether user is initiator
... source 1..1BackboneElementAudit Event Reporter
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity:Patient C1..1BackboneElementPatient
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
..... role 1..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
.... entity:Resource C0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 2
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... name ΣC1..1stringDescriptor for entity
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value[x] 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Patient.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Patient.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Resource.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:ResourceEither a name or a query (NOT both)
: name.empty() or query.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C0..*AuditEventPolicy Audit Trail Content Profile
ch-atc-pae-2: subtype needs to be fixed to ValueSet PolicyAuditEventType
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... type Σ1..1CodingType/identifier of event
Binding: AuditEventID (extensible): Type of event.

... Slices for subtype Σ1..*CodingMore specific type/id for the event
Slice: Unordered, Open by value:system
Binding: AuditEventSub-Type (extensible): Sub-type of event.


.... subtype:PolicyAuditEventType Σ1..1CodingPolicyAuditEventType
Binding: PolicyAuditEventType (required): Policy Audit Event Type


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... action Σ0..1codeType of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1PeriodWhen the activity occurred
... recorded Σ1..1instantTime when the event was recorded
... outcome Σ0..1codeWhether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ0..1stringDescription of the event outcome
... purposeOfEvent Σ0..*CodeableConceptThe purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... agent 1..*BackboneElementParticipants
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 0..1CodeableConceptHow agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.

.... role 1..1CodeableConceptAgent role in the event
Binding: EprParticipant (required): EPR Participant


.... who Σ0..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
..... display Σ0..1stringText alternative for the resource
.... altId 0..1stringAlternative User identity
.... name 1..1stringHuman friendly name for the agent
.... requestor Σ1..1booleanWhether user is initiator
.... location 0..1Reference(Location)Where
.... policy 0..*uriPolicy that authorized event
.... media 0..1CodingType of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

.... network 0..1BackboneElementLogical network location for application activity
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... address 0..1stringIdentifier for the network access point of the user device
..... type 0..1codeThe type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

.... purposeOfUse 0..*CodeableConceptReason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source 1..1BackboneElementAudit Event Reporter
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... site 0..1stringLogical source location within the enterprise
.... observer Σ1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)The identity of source detecting the event
.... type 0..*CodingThe type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.


... Slices for entity C0..*BackboneElementData or objects used
Slice: Unordered, Open by value:type.code
.... entity:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
..... type 0..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

..... role 0..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:Patient C1..1BackboneElementPatient
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ1..1IdentifierPatient Id (EPR-SPID)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

....... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

....... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
....... value Σ0..1stringThe value that is unique
Example General: 123456
....... period Σ0..1PeriodTime period when id is/was valid for use
....... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... role 1..1CodingWhat role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 1
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC0..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... detail 0..*BackboneElementAdditional Information about the entity
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1stringName of the property
...... value[x] 1..1Property value
....... valueStringstring
....... valueBase64Binarybase64Binary
.... entity:Resource C0..1BackboneElementResource (HCP, Group, Representative of Patient)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... what Σ0..1Reference(Resource)Specific instance of resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierIdentifier: HCP (GLN), Group (OID)
...... display Σ0..1stringText alternative for the resource
..... type 1..1CodingType of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 2
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... role 1..1CodingWhat role the entity played
Binding: EprParticipant (required): EPR Participant

..... lifecycle 0..1CodingLife-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

..... securityLabel 0..*CodingSecurity labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


..... name ΣC1..1stringDescriptor for entity
..... description 0..1stringDescriptive text
..... query ΣC0..1base64BinaryQuery parameters
..... Slices for detail 0..*BackboneElementAdditional Information about the entity
Slice: Unordered, Open by value:type
...... detail:All Slices Content/Rules for all slices
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
....... value[x] 1..1Property value
........ valueStringstring
........ valueBase64Binarybase64Binary
...... detail:AccessLevel 0..1BackboneElementAccessLevel if subtype is Create or Update
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringThe type of extra detail provided in the value
Fixed Value: AccessLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:access-level: normal, restricted, delegation-and-restricted, delegation-and-normal or full
...... detail:AccessLimitedToDate 0..1BackboneElementAccessLimitedToDate if subtype is Create or Update
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: AccessLimitedToDate
....... value[x] 1..1base64BinaryDate in property value
...... detail:ProvideLevel 0..1BackboneElementProvideLevel if subtype is ATC_POL_DEF_CONFLEVEL
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1stringName of the property
Fixed Value: ProvideLevel
....... value[x] 1..1base64Binaryone of urn:e-health-suisse:2015:policies:provide-level: normal, restricted or secret

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:PolicyAuditEventTyperequiredPolicyAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/PolicyAuditEventType
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.agent.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:Patient.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:Patient.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:Patient.what.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
AuditEvent.entity:Patient.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Patient.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Patient.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:Patient.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
AuditEvent.entity:Resource.what.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
AuditEvent.entity:Resource.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Resource.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Resource.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity:Resource.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-pae-2errorAuditEventsubtype needs to be fixed to ValueSet PolicyAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL')
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entity, AuditEvent.entity:Patient, AuditEvent.entity:ResourceEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 10 elements (7 nested mandatory elements)
Fixed Value: 8 elements

Slices

This structure defines the following Slices:

  • The element AuditEvent.subtype is sliced based on the value of value:system
  • The element AuditEvent.entity is sliced based on the value of value:type.code
  • The element AuditEvent.entity.detail is sliced based on the value of value:type

 

Other representations of profile: CSV, Excel, Schematron