CH Audit Event for [PPQ-5] Policy Consumer - CH EPR FHIR (R4) v4.0.1-ballot-2

CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 4.0.1-ballot-2 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 [PPQ-5] Policy Consumer

Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ChAuditEventPpq5Consumer				Version: 4.0.1-ballot-2
Active as of 2024-11-19				Computable Name: ChAuditEventPpq5Consumer
Copyright/Legal: CC0-1.0

This profile is used to define the CH Audit Event for the [PPQ-5] transaction and the actor 'Policy Consumer'.

Usage:

Examples for this Resource Profile: AuditEvent/ChAuditEventPpq5ConsumerExample

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from PatientQuery

Name	Card.	Type	Description & Constraints
AuditEvent	0..*	PatientQuery(1.1.0)	Event record kept for security purposes
subtype	2..*	Coding	More specific type/id for the event
Slices for subtype			Content/Rules for all slices
subtype:ppq5	1..1	Coding	More specific type/id for the event Required Pattern: At least the following
system	1..1	uri	Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code
code	1..1	code	Symbol in syntax defined by the system Fixed Value: PPQ-5
display	1..1	string	Representation defined by the system Fixed Value: Mobile Privacy Policy Retrieve
agent	3..*	BackboneElement	Actor involved in the event
Slices for agent			Content/Rules for all slices
agent:client	1..1	BackboneElement	The 'Policy Consumer' actor (EPR application)
agent:server	1..1	BackboneElement	The 'Policy Repository' actor (EPR API)
agent:mainUser	1..1	BackboneElement	The main user (patient, representative, healthcare professional, or administrator)
type	1..1	CodeableConcept	How agent participated 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
altId	1..1	string	Alternative User identity
name	1..1	string	Human friendly name for the agent
purposeOfUse	1..1	CodeableConcept	Reason given for this user Binding: EprPurposeOfUse (required)
agent:delegatedUser	0..1	BackboneElement	The person who acted on behalf of the main user (an assistant or technical user)
type	1..1	CodeableConcept	How agent participated 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
altId	1..1	string	Alternative User identity
name	1..1	string	Human friendly name for the agent
source
site	1..1	string	The OID of the audit source
Slices for entity			Content/Rules for all slices
entity:query	1..1	BackboneElement	The privacy policy query
entity:patient	1..1	BackboneElement	The patient whose privacy policies are being accessed
what
identifier	1..1	Identifier	Logical reference, when literal reference is not known
system	1..1	uri	The namespace for the identifier value
value	1..1	string	The value that is unique
entity:traceparent	0..1	BackboneElement	The 'traceparent' header value of the transaction
what	1..1	Reference(Resource)	Specific instance of resource
identifier	1..1	Identifier	Logical reference, when literal reference is not known
value	1..1	string	The 'traceparent' header value
type	1..1	Coding	Type of entity involved 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 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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.agent:mainUser.purposeOfUse	required	EprPurposeOfUse `http://fhir.ch/ig/ch-term/ValueSet/EprPurposeOfUse`

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	PatientQuery(1.1.0)	Event record kept for security purposes
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event. 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
display		1..1	string	Representation defined by the system Fixed Value: Restful Operation
Slices for subtype	Σ	2..*	Coding	More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:anySearch	Σ	0..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: search
display		1..1	string	Representation defined by the system Fixed Value: search
userSelected		0..0	boolean	If this coding was chosen directly by the user
subtype:anySearchT	Σ	0..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: search-type
display		1..1	string	Representation defined by the system Fixed Value: search-type
userSelected		0..0	boolean	If this coding was chosen directly by the user
subtype:anySearchS	Σ	0..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://hl7.org/fhir/restful-interaction
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: search-system
display		1..1	string	Representation defined by the system Fixed Value: search-system
userSelected		0..0	boolean	If this coding was chosen directly by the user
subtype:ppq5	Σ	1..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event. Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: urn:e-health-suisse:event-type-code
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PPQ-5
display		1..1	string	Representation defined by the system Fixed Value: Mobile Privacy Policy Retrieve
recorded	Σ	1..1	instant	Time when the event was recorded
Slices for agent		3..*	BackboneElement	Actor involved in the event Slice: Unordered, Open by pattern:type
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
requestor	Σ	1..1	boolean	Whether user is initiator
agent:client		1..1	BackboneElement	The 'Policy Consumer' actor (EPR application)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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: 110153
display		1..1	string	Representation defined by the system Fixed Value: Source Role ID
who	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Identifier of who
requestor	Σ	1..1	boolean	Whether user is initiator
network		1..1	BackboneElement	Logical network location for application activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
agent:server		1..1	BackboneElement	The 'Policy Repository' actor (EPR API)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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: 110152
display		1..1	string	Representation defined by the system Fixed Value: Destination Role ID
who	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Identifier of who
requestor	Σ	1..1	boolean	Whether user is initiator
network		1..1	BackboneElement	Logical network location for application activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
agent:user		0..1	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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: IRCP
display		1..1	string	Representation defined by the system Fixed Value: information recipient
role	S	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Identifier of who
name	S	0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
purposeOfUse	S	0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:mainUser		1..1	BackboneElement	The main user (patient, representative, healthcare professional, or administrator)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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.
altId		1..1	string	Alternative User identity
name		1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
purposeOfUse		1..1	CodeableConcept	Reason given for this user Binding: EprPurposeOfUse (required)
agent:delegatedUser		0..1	BackboneElement	The person who acted on behalf of the main user (an assistant or technical user)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. 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.
altId		1..1	string	Alternative User identity
name		1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
source	S	1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site		1..1	string	The OID of the audit source
observer	Σ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	The identity of source detecting the event
Slices for entity	C	2..*	BackboneElement	Data or objects used Slice: Unordered, Open by pattern:type 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
entity:transaction	C	0..1	BackboneElement	Data or objects used sev-1: Either a name or a query (NOT both)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. 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:query	C	1..1	BackboneElement	The privacy policy query sev-1: Either a name or a query (NOT both)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. 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
display		1..1	string	Representation defined by the system Fixed Value: System Object
query	ΣC	1..1	base64Binary	Query parameters
entity:patient	C	1..1	BackboneElement	The patient whose privacy policies are being accessed sev-1: Either a name or a query (NOT both)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Patient)	Specific instance of resource
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. 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: 1
display		1..1	string	Representation defined by the system Fixed Value: Person
entity:traceparent	C	0..1	BackboneElement	The 'traceparent' header value of the transaction sev-1: Either a name or a query (NOT both)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	1..1	Reference(Resource)	Specific instance of resource
identifier	Σ	1..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
value	Σ	1..1	string	The 'traceparent' header value Example General: 123456
type		1..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event. 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. 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AuditEvent.type	extensible	Pattern: rest("Restful Operation") `http://hl7.org/fhir/ValueSet/audit-event-type` from the FHIR Standard
AuditEvent.subtype	extensible	AuditEventSub-Type `http://hl7.org/fhir/ValueSet/audit-event-sub-type` from the FHIR Standard
AuditEvent.subtype:anySearch	extensible	Fixed Value: search("search") `http://hl7.org/fhir/ValueSet/audit-event-sub-type` from the FHIR Standard
AuditEvent.subtype:anySearchT	extensible	Fixed Value: search-type("search-type") `http://hl7.org/fhir/ValueSet/audit-event-sub-type` from the FHIR Standard
AuditEvent.subtype:anySearchS	extensible	Fixed Value: search-system("search-system") `http://hl7.org/fhir/ValueSet/audit-event-sub-type` from the FHIR Standard
AuditEvent.subtype:ppq5	extensible	Pattern: PPQ-5("Mobile Privacy Policy Retrieve") `http://hl7.org/fhir/ValueSet/audit-event-sub-type` from the FHIR Standard
AuditEvent.agent:client.type	extensible	Pattern: 110153("Source Role ID") `http://hl7.org/fhir/ValueSet/participation-role-type` from the FHIR Standard
AuditEvent.agent:server.type	extensible	Pattern: 110152("Destination Role ID") `http://hl7.org/fhir/ValueSet/participation-role-type` from the FHIR Standard
AuditEvent.agent:user.type	extensible	Pattern: IRCP("information recipient") `http://hl7.org/fhir/ValueSet/participation-role-type` from the FHIR Standard
AuditEvent.agent:user.role	example	SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` from the FHIR Standard
AuditEvent.agent:user.purposeOfUse	extensible	PurposeOfUse `http://terminology.hl7.org/ValueSet/v3-PurposeOfUse`
AuditEvent.agent:mainUser.type	extensible	Pattern: RESP("responsible party") `http://hl7.org/fhir/ValueSet/participation-role-type` from the FHIR Standard
AuditEvent.agent:mainUser.role	example	SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` from the FHIR Standard
AuditEvent.agent:mainUser.purposeOfUse	required	EprPurposeOfUse `http://fhir.ch/ig/ch-term/ValueSet/EprPurposeOfUse`
AuditEvent.agent:delegatedUser.type	extensible	Pattern: PPRF("primary performer") `http://hl7.org/fhir/ValueSet/participation-role-type` from the FHIR Standard
AuditEvent.agent:delegatedUser.role	example	SecurityRoleType `http://hl7.org/fhir/ValueSet/security-role-type` from the FHIR Standard
AuditEvent.entity:transaction.type	extensible	Pattern: XrequestId `http://hl7.org/fhir/ValueSet/audit-entity-type` from the FHIR Standard
AuditEvent.entity:query.type	extensible	Pattern: 2("System Object") `http://hl7.org/fhir/ValueSet/audit-entity-type` from the FHIR Standard
AuditEvent.entity:patient.what.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
AuditEvent.entity:patient.type	extensible	Pattern: 1("Person") `http://hl7.org/fhir/ValueSet/audit-entity-type` from the FHIR Standard
AuditEvent.entity:traceparent.what.identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
AuditEvent.entity:traceparent.type	extensible	Pattern: 4("Other") `http://hl7.org/fhir/ValueSet/audit-entity-type` from the FHIR Standard
AuditEvent.entity:traceparent.role	extensible	Pattern: 26("Processing Element") `http://hl7.org/fhir/ValueSet/object-role` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity, AuditEvent.entity:transaction, AuditEvent.entity:query, AuditEvent.entity:patient, AuditEvent.entity:traceparent	Either a name or a query (NOT both) : name.empty() or query.empty()