CH EPR FHIR (R4)
5.0.0-ballot-ci-build - ci-build Switzerland flag

CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 5.0.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-epr-fhir/ and changes regularly. See the Directory of published versions

Resource Profile: CH Audit Event for [ITI-130] Data Source & Directory / Delete

Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ChAuditEventIti130Delete Version: 5.0.0-ballot-ci-build
Active as of 2025-03-20 Computable Name: ChAuditEventIti130Delete

Copyright/Legal: CC0-1.0

This profile is used to define the CH Audit Event for the [ITI-130] transaction and the actors 'Data Source' & Directory, when deleting care service resources.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditMcsdCareServicesDelete Event record kept for security purposes
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
... 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
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... subtype:anyDelete Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/restful-interaction
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: delete
.... subtype:iti130 Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


ele-1: All FHIR elements must have a @value or children

Required Pattern: At least the following
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: ITI-130
..... display 1..1 string Representation defined by the system
Fixed Value: Care Services Feed
... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: D
... recorded Σ 1..1 instant Time when the event was recorded
ele-1: All FHIR elements must have a @value or children
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


ele-1: All FHIR elements must have a @value or children
Required Pattern: 0
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern:type
ele-1: All FHIR elements must have a @value or children
.... agent: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
..... requestor Σ 1..1 boolean Whether user is initiator
ele-1: All FHIR elements must have a @value or children
.... agent:client 1..1 BackboneElement The 'Data Source' actor (EPR application)
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 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110150
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
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
..... network 1..1 BackboneElement Logical network location for application activity
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
.... agent:server 1..1 BackboneElement The 'Directory' actor (EPR API)
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 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: custodian
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
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
..... network 1..1 BackboneElement Logical network location for application activity
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
.... agent:user 0..1 BackboneElement Actor involved in the event
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 S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


ele-1: All FHIR elements must have a @value or children
..... who Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
ele-1: All FHIR elements must have a @value or children
..... name S 0..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
Required Pattern: true
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


ele-1: All FHIR elements must have a @value or children
.... agent:mainUser 0..1 BackboneElement The main user (patient, representative, healthcare professional, or administrator)
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 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RESP
....... display 1..1 string Representation defined by the system
Fixed Value: responsible party
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


ele-1: All FHIR elements must have a @value or children
..... altId 1..1 string Alternative User identity
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
..... purposeOfUse 0..1 CodeableConcept Reason given for this user
Binding: EprPurposeOfUse (required)
ele-1: All FHIR elements must have a @value or children
.... agent:delegatedUser 0..1 BackboneElement The person who acted on behalf of the main user (an assistant or technical user)
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 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.


ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PPRF
....... display 1..1 string Representation defined by the system
Fixed Value: primary performer
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


ele-1: All FHIR elements must have a @value or children
..... altId 1..1 string Alternative User identity
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 S 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
.... site 1..1 string The OID of the audit source
ele-1: All FHIR elements must have a @value or children
.... 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 1..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
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:transaction C 0..1 BackboneElement Data or objects used
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
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:data C 1..1 BackboneElement Data or objects used
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(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
ele-1: All FHIR elements must have a @value or children
..... 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
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 4
...... display 1..1 string Representation defined by the system
Fixed Value: Domain Resource
.... entity:traceparent C 0..1 BackboneElement The 'traceparent' header value of the transaction
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 'traceparent' header value
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
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 4
...... display 1..1 string Representation defined by the system
Fixed Value: Other
..... role 0..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
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 26
...... display 1..1 string Representation defined by the system
Fixed Value: Processing Element

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
AuditEvent.typeextensiblePattern: rest
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:anyDeleteextensiblePattern: delete
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.subtype:iti130extensiblePattern: ITI-130("Care Services Feed")
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredPattern: D
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredPattern: 0
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.agent:client.typeextensiblePattern: 110150
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:server.typeextensiblePattern: custodian
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:user.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:mainUser.typeextensiblePattern: RESP("responsible party")
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:mainUser.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:mainUser.purposeOfUserequiredEprPurposeOfUse
http://fhir.ch/ig/ch-term/ValueSet/EprPurposeOfUse
AuditEvent.agent:delegatedUser.typeextensiblePattern: PPRF("primary performer")
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent:delegatedUser.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.entity:transaction.typeextensiblePattern: XrequestId
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.typeextensiblePattern: 2
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:data.rolerequiredPattern: 4("Domain Resource")
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
AuditEvent.entity:traceparent.what.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
AuditEvent.entity:traceparent.typeextensiblePattern: 4("Other")
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity:traceparent.roleextensiblePattern: 26("Processing Element")
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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:transaction, AuditEvent.entity:data, AuditEvent.entity:traceparentEither a name or a query (NOT both)
: name.empty() or query.empty()

 

Other representations of profile: CSV, Excel, Schematron