CH EPR FHIR (R4)
5.0.0-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-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 / Create

Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ChAuditEventIti130Create Version: 5.0.0-ci-build
Active as of 2025-10-09 Computable Name: ChAuditEventIti130Create

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 adding care service resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 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..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:iti130 Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
..... version 0..1 string Version of the system - if relevant
..... 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
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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.
Required Pattern: C
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Required Pattern: 0
... Slices for agent 2..* 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 'Data Source' 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 'Directory' 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... 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 (3.1.0) (extensible): The reason the activity took place.
.... agent:mainUser 0..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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 0..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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 1..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
Constraints: sev-1
.... 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
Constraints: sev-1
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:data C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:traceparent C 0..1 BackboneElement The 'traceparent' header value of the transaction
Constraints: sev-1
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📦4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:anyCreate Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:iti130 Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:mainUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3
AuditEvent.agent:delegatedUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​role Base required RESTful objects role in the event 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.entity:traceparent.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:data, AuditEvent.entity:traceparent Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditMcsdCareServicesCreate

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate Event record kept for security purposes
... Slices for agent Content/Rules for all slices
.... agent:client 1..1 BackboneElement The 'Data Source' actor (EPR application)
.... agent:server 1..1 BackboneElement The 'Directory' actor (EPR API)
.... agent:mainUser 0..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 0..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:data 1..1 BackboneElement Data or objects used
..... what 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate Event record kept for security purposes
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 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..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:iti130 Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
..... version 0..1 string Version of the system - if relevant
..... 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
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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.
Required Pattern: C
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Required Pattern: 0
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:client 1..1 BackboneElement The 'Data Source' actor (EPR application)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 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
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:server 1..1 BackboneElement The 'Directory' actor (EPR API)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 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
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: participant source types for RESTful create (required)
..... 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
..... altId 0..1 string Alternative User identity
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:mainUser 0..1 BackboneElement The main user (patient, representative, healthcare professional, or administrator)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... source S 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string the value of X-Request-Id
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:data C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding may contain the security labels on the resource returned
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:traceparent C 0..1 BackboneElement The 'traceparent' header value of the transaction
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Resource) Specific instance of resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The 'traceparent' header value
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📦4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📦4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:anyCreate Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:iti130 Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent.type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:client.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:user.​type Base required participant source types for RESTful create 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.agent:user.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:mainUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3
AuditEvent.agent:delegatedUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.source.type Base extensible Audit Event Source Type 📦4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.type Base extensible ResourceType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:transaction.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​role Base required RESTful objects role in the event 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.entity:data.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:data.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:traceparent.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:data, AuditEvent.entity:traceparent Either a name or a query (NOT both) name.empty() or query.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 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..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:iti130 Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
..... version 0..1 string Version of the system - if relevant
..... 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
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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.
Required Pattern: C
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Required Pattern: 0
... Slices for agent 2..* 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 'Data Source' 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 'Directory' 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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
..... 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 (3.1.0) (extensible): The reason the activity took place.
.... agent:mainUser 0..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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 0..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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... 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 1..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
Constraints: sev-1
.... 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
Constraints: sev-1
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:data C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
.... entity:traceparent C 0..1 BackboneElement The 'traceparent' header value of the transaction
Constraints: sev-1
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📦4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:anyCreate Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:iti130 Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:mainUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3
AuditEvent.agent:delegatedUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​role Base required RESTful objects role in the event 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.entity:traceparent.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:data, AuditEvent.entity:traceparent Either a name or a query (NOT both) name.empty() or query.empty()

Differential View

This structure is derived from AuditMcsdCareServicesCreate

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate Event record kept for security purposes
... Slices for agent Content/Rules for all slices
.... agent:client 1..1 BackboneElement The 'Data Source' actor (EPR application)
.... agent:server 1..1 BackboneElement The 'Directory' actor (EPR API)
.... agent:mainUser 0..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 0..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:data 1..1 BackboneElement Data or objects used
..... what 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
.... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditMcsdCareServicesCreate Event record kept for security purposes
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... 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
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... version 0..1 string Version of the system - if relevant
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: rest
.... display 0..1 string Representation defined by the system
.... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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:anyCreate Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 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..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: create
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... subtype:iti130 Σ 1..1 Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:ihe:event-type-code
..... version 0..1 string Version of the system - if relevant
..... 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
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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.
Required Pattern: C
... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Required Pattern: 0
... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... Slices for agent 2..* BackboneElement Actor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
..... role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:client 1..1 BackboneElement The 'Data Source' actor (EPR application)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110153
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 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
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:server 1..1 BackboneElement The 'Directory' actor (EPR API)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 110152
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 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
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... network 1..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:user 0..1 BackboneElement Actor involved in the event
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 0..1 CodeableConcept How agent participated
Binding: participant source types for RESTful create (required)
..... 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
..... altId 0..1 string Alternative User identity
..... name S 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
Required Pattern: true
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... purposeOfUse S 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
.... agent:mainUser 0..1 BackboneElement The main user (patient, representative, healthcare professional, or administrator)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..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)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
....... version 0..1 string Version of the system - if relevant
....... 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
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
..... network 0..1 BackboneElement Logical network location for application activity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... address 0..1 string Identifier for the network access point of the user device
...... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
..... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
... source S 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... 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
.... type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
... Slices for entity C 1..* BackboneElement Data or objects used
Slice: Unordered, Open by pattern:type
Constraints: sev-1
.... entity:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
..... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:transaction C 0..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 0..1 Reference(Resource) Specific instance of resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string the value of X-Request-Id
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: XrequestId
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:data C 1..1 BackboneElement Data or objects used
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(mCSD Practitioner | mCSD PractitionerRole | mCSD Organization) Specific instance of resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... role 1..1 Coding What role the entity played
Binding: RESTful objects role in the event (required)
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding may contain the security labels on the resource returned
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary
.... entity:traceparent C 0..1 BackboneElement The 'traceparent' header value of the transaction
Constraints: sev-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... what Σ 1..1 Reference(Resource) Specific instance of resource
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description 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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The 'traceparent' header value
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 0..1 string Text alternative for the resource
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... 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
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/object-role
...... version 0..1 string Version of the system - if relevant
...... 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
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
..... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
..... name ΣC 0..1 string Descriptor for entity
..... description 0..1 string Descriptive text
..... query ΣC 0..1 base64Binary Query parameters
..... detail 0..* BackboneElement Additional Information about the entity
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 string Name of the property
...... value[x] 1..1 Property value
....... valueString string
....... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📦4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📦4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:anyCreate Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.subtype:iti130 Base extensible Audit Event Sub-Type 📦4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent.type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:client.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:client.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:client.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:client.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:server.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:server.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:server.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:user.​type Base required participant source types for RESTful create 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.agent:user.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:user.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:user.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.agent:mainUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:mainUser.​purposeOfUse Base required EprPurposeOfUse 📦3.3.0-ci-build CH Term v3.3
AuditEvent.agent:delegatedUser.​type Base extensible ParticipationRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​role Base example SecurityRoleType 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​media Base extensible Media Type Code 📦4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatedUser.​purposeOfUse Base extensible PurposeOfUse 📍3.1.0 THO v6.5
AuditEvent.source.type Base extensible Audit Event Source Type 📦4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.type Base extensible ResourceType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:transaction.​what.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity:transaction.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:transaction.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:data.​role Base required RESTful objects role in the event 📦1.1.3 Basic Audit Log Patterns v1.1
AuditEvent.entity:data.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:data.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​what.identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​type Base extensible Audit event entity type 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​role Base extensible AuditEventEntityRole 📦4.0.1 FHIR Std.
AuditEvent.entity:traceparent.​lifecycle Base extensible ObjectLifecycleEvents 📍5.3.0-ballot-tc1 FHIR Extensions Pack v5.3
AuditEvent.entity:traceparent.​securityLabel Base extensible SecurityLabels 📦4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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:data, AuditEvent.entity:traceparent Either a name or a query (NOT both) name.empty() or query.empty()

 

Other representations of profile: CSV, Excel, Schematron