CH ATC (R4)
3.4.0-ballot-ci-build - 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.4.0-ballot-ci-build 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 DocumentAuditEvent for CH ATC

Official URL: http://fhir.ch/ig/ch-atc/StructureDefinition/DocumentAuditEvent Version: 3.4.0-ballot-ci-build
Active as of 2018-05-28 Computable Name: DocumentAuditEvent

Copyright/Legal: CC0-1.0

This profile defines the content of the document 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent C 0..* ChEprFhirAuditEvent Document Audit Trail Content Profile
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
ch-atc-dae-1: subtype needs to be fixed to ValueSet DocumentAuditEventType
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.


ele-1: All FHIR elements must have a @value or children
.... subtype:DocumentAuditEventType Σ 1..1 Coding DocumentAuditEventType
Binding: DocumentAuditEventType (required): Document Audit Event Type


ele-1: All FHIR elements must have a @value or children
..... system Σ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.7
... recorded Σ 1..1 instant Time when the event was recorded
ele-1: All FHIR elements must have a @value or children
... purposeOfEvent Σ 1..1 CodeableConcept The purposeOfUse of the event
Binding: EprPurposeOfUse (required): EPR Purpose of Use


ele-1: All FHIR elements must have a @value or children
... agent 1..* BackboneElement Participants
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... role 1..1 CodeableConcept Agent role in the event
Binding: EprParticipant (required): EPR Participant


ele-1: All FHIR elements must have a @value or children
.... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
ele-1: All FHIR elements must have a @value or children
..... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
.... name 1..1 string Human friendly name for the agent
ele-1: All FHIR elements must have a @value or children
.... requestor Σ 1..1 boolean Whether user is initiator
ele-1: All FHIR elements must have a @value or children
... source 1..1 BackboneElement Audit Event Reporter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
ele-1: All FHIR elements must have a @value or children
... Slices for entity C 0..* BackboneElement Data or objects used
Slice: Unordered, Open by value:type.code, value:role.code
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
.... entity:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... entity:Patient C 1..1 BackboneElement Patient
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... what Σ 1..1 Reference(Resource) Specific instance of resource
ele-1: All FHIR elements must have a @value or children
...... identifier Σ 1..1 Identifier Patient Id (EPR-SPID)
ele-1: All FHIR elements must have a @value or children
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
....... system Σ 1..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Fixed Value: urn:oid:2.16.756.5.30.1.127.3.10.3
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 1
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 1
.... entity:TraceContext C 0..1 BackboneElement Trace Context
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... what Σ 1..1 Reference(Resource) Specific instance of resource
ele-1: All FHIR elements must have a @value or children
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
....... value Σ 1..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 4
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 26
.... entity:Document C 0..1 BackboneElement Document
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 2
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 3
..... Slices for detail 4..* BackboneElement Additional Information about the entity
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
...... detail:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 string Name of the property
ele-1: All FHIR elements must have a @value or children
....... value[x] 1..1 Property value
ele-1: All FHIR elements must have a @value or children
........ valueString string
........ valueBase64Binary base64Binary
...... detail:repositoryUniqueId 1..1 BackboneElement repositoryUniqueId
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 string Name of the property
ele-1: All FHIR elements must have a @value or children
Fixed Value: Repository Unique Id
....... value[x] 1..1 base64Binary Property value
ele-1: All FHIR elements must have a @value or children
...... detail:homeCommunityID 1..1 BackboneElement homeCommunityID
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 string Name of the property
ele-1: All FHIR elements must have a @value or children
Fixed Value: homeCommunityID
....... value[x] 1..1 base64Binary Property value
ele-1: All FHIR elements must have a @value or children
...... detail:EprDocumentTypeCode 1..1 BackboneElement EprDocumentTypeCode
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 string Name of the property
ele-1: All FHIR elements must have a @value or children
Fixed Value: EprDocumentTypeCode
....... value[x] 1..1 base64Binary Property value
ele-1: All FHIR elements must have a @value or children
...... detail:title 1..1 BackboneElement title
ele-1: All FHIR elements must have a @value or children
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
....... type 1..1 string Name of the property
ele-1: All FHIR elements must have a @value or children
Fixed Value: title
....... value[x] 1..1 base64Binary Property value
ele-1: All FHIR elements must have a @value or children
.... entity:Query C 0..1 BackboneElement Query
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 2
..... role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.


ele-1: All FHIR elements must have a @value or children
...... code Σ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
Fixed Value: 24

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:DocumentAuditEventTyperequiredDocumentAuditEventType
http://fhir.ch/ig/ch-atc/ValueSet/DocumentAuditEventType
from this IG
AuditEvent.purposeOfEventrequiredEprPurposeOfUse
http://fhir.ch/ig/ch-term/ValueSet/EprPurposeOfUse
AuditEvent.agent.rolerequiredEprParticipant
http://fhir.ch/ig/ch-atc/ValueSet/EprParticipant
from this IG
AuditEvent.entity:Patient.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
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:TraceContext.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:TraceContext.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:TraceContext.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Document.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Document.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity:Query.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:Query.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ch-atc-dae-1errorAuditEventsubtype needs to be fixed to ValueSet DocumentAuditEventType
: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_DOC')
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:TraceContext, AuditEvent.entity:Document, AuditEvent.entity:QueryEither a name or a query (NOT both)
: name.empty() or query.empty()

 

Other representations of profile: CSV, Excel, Schematron