De-Identification Profile
0.0.1-current - ci-build

De-Identification Profile, published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.DeIdHandbook/ and changes regularly. See the Directory of published versions

## Resource Profile: Audit Event for De-Identification at Source

Official URL: https://profiles.ihe.net/ITI/DeId/StructureDefinition/IHE.BasicAudit.DeIdentification.Source | Version: 0.0.1-current
Draft as of 2026-04-23 | Computable Name: AuditPrivacyDeIdentificationSource

Defines constraints on the AuditEvent Resource to record when a De-Identification happens at the Source. Note that a De-Identification event often impacts many different patients, so many AuditEvent resources need to be created so that each Patient is individually represented. This prevents leakage of other patients' that were also De-Identified at the same time.

- Export event
- subtype of deidentify or pseudonymize
- shall have source of itself
- shall have a source agent
- should have a recipient agent(s) if known
- may have user, app, organization agent(s)
  - combine with the Security Token pattern
- should have the custodian that released the data
- should have the authorizer that represented the patient (may be the patient)
- shall have a patient entity
- may have the consent that authorized the de-identification
- may have the authorizing client token (saml, jwt, etc)
- may have the set of data entity(ies)

Usages:

- Examples for this Profile: AuditEvent/ex-auditDeIdentification-source and AuditEvent/ex-auditReIdentification-source
- CapabilityStatements using this Profile: IHE DeId Audit Creator

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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://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: 110106
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 | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:deidentify | Σ | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
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: R
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.
outcomeDesc | S Σ | 0..1 | string | Description of the event outcome
purposeOfEvent | S Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value: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:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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:recipient |  | 0..* | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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:custodian |  | 0..1 | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
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
agent:authorizer |  | 0..1 | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
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
source |  | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event
Slices for entity | C | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type Constraints: sev-1
entity:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
entity:patient | 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(Patient) | 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: 1
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: 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: 1
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
entity:deid | C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | S Σ | 1..1 | Reference(Resource) | 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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
entity:consent | C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | S Σ | 1..1 | Reference(Resource) | 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://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
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:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG
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 v7.1
AuditEvent.agent:source.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​type | Base | extensible | Audit event entity type | 📍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:patient, AuditEvent.entity:deid, AuditEvent.entity:consent | Either a name or a query (NOT both) | `name.empty() or query.empty()`
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

This structure is derived from AuditEvent

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
modifierExtension |  | 0..0 |  | Extension
type |  | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110106
Slices for subtype |  | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this
subtype:deidentify |  | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
action |  | 0..1 | code | Type of action performed during the event Required Pattern: R
outcome |  | 1..1 | code | Whether the event succeeded or failed
outcomeDesc | S | 0..1 | string | Description of the event outcome
purposeOfEvent | S | 0..* | CodeableConcept | The purposeOfUse of the event
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
network |  | 1..1 | BackboneElement | Logical network location for application activity
agent:recipient |  | 0..* | BackboneElement | Actor involved in the event
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://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
network |  | 1..1 | BackboneElement | Logical network location for application activity
agent:custodian |  | 0..1 | BackboneElement | Actor involved in the event
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://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
agent:authorizer |  | 0..1 | BackboneElement | Actor involved in the event
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://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
Slices for entity |  | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type
entity:patient |  | 1..1 | BackboneElement | Data or objects used
what |  | 1..1 | Reference(Patient) | Specific instance of resource
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: 1
role |  | 1..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: 1
entity:deid |  | 0..1 | BackboneElement | Data or objects used
what | S | 1..1 | Reference(Resource) | Specific instance of resource
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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
entity:consent |  | 0..1 | BackboneElement | Data or objects used
what | S | 1..1 | Reference(Resource) | Specific instance of resource
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://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.subtype:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
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://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: 110106
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 | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:deidentify | Σ | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
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: R
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.
outcomeDesc | S Σ | 0..1 | string | Description of the event outcome
purposeOfEvent | S Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value: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 (extensible): The reason the activity took place.
agent:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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
media |  | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
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 (extensible): The reason the activity took place.
agent:recipient |  | 0..* | 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 |  | 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
media |  | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
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 (extensible): The reason the activity took place.
agent:custodian |  | 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 |  | 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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
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
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 (extensible): The reason the activity took place.
agent:authorizer |  | 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 |  | 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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
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
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 (extensible): The reason the activity took place.
source |  | 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 |  | 0..1 | string | Logical source location within the enterprise
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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value: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:patient | 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(Patient) | 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: 1
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: 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: 1
display |  | 0..1 | string | Representation defined by the system
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 |
entity:deid | 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 | S Σ | 1..1 | Reference(Resource) | 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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
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:consent | 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 | S Σ | 1..1 | Reference(Resource) | 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://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
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 |
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:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG
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 v7.1
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 v7.1
AuditEvent.agent:source.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:recipient.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:custodian.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:authorizer.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
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 | 📍4.0.1 | FHIR Std.
AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​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:patient, AuditEvent.entity:deid, AuditEvent.entity:consent | Either a name or a query (NOT both) | `name.empty() or query.empty()`
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

This structure is derived from AuditEvent

Summary

Mandatory: 11 elements(11 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.subtype
- The element 1 is sliced based on the value of AuditEvent.agent
- The element 1 is sliced based on the value of AuditEvent.entity

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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://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: 110106
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 | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:deidentify | Σ | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
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: R
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.
outcomeDesc | S Σ | 0..1 | string | Description of the event outcome
purposeOfEvent | S Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value: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:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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:recipient |  | 0..* | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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:custodian |  | 0..1 | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
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
agent:authorizer |  | 0..1 | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type |  | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. Required Pattern: At least the following
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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
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
source |  | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
observer | Σ | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event
Slices for entity | C | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type Constraints: sev-1
entity:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
entity:patient | 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(Patient) | 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: 1
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: 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: 1
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
entity:deid | C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | S Σ | 1..1 | Reference(Resource) | 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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
entity:consent | C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | S Σ | 1..1 | Reference(Resource) | 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://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
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:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG
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 v7.1
AuditEvent.agent:source.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​type | Base | extensible | Audit event entity type | 📍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:patient, AuditEvent.entity:deid, AuditEvent.entity:consent | Either a name or a query (NOT both) | `name.empty() or query.empty()`
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

Differential View

This structure is derived from AuditEvent

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
modifierExtension |  | 0..0 |  | Extension
type |  | 1..1 | Coding | Type/identifier of event Required Pattern: At least the following
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110106
Slices for subtype |  | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this
subtype:deidentify |  | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
action |  | 0..1 | code | Type of action performed during the event Required Pattern: R
outcome |  | 1..1 | code | Whether the event succeeded or failed
outcomeDesc | S | 0..1 | string | Description of the event outcome
purposeOfEvent | S | 0..* | CodeableConcept | The purposeOfUse of the event
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110153
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
network |  | 1..1 | BackboneElement | Logical network location for application activity
agent:recipient |  | 0..* | BackboneElement | Actor involved in the event
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://dicom.nema.org/resources/ontology/DCM
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 110152
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
network |  | 1..1 | BackboneElement | Logical network location for application activity
agent:custodian |  | 0..1 | BackboneElement | Actor involved in the event
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://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
agent:authorizer |  | 0..1 | BackboneElement | Actor involved in the event
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://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
who |  | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who
Slices for entity |  | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value:type
entity:patient |  | 1..1 | BackboneElement | Data or objects used
what |  | 1..1 | Reference(Patient) | Specific instance of resource
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: 1
role |  | 1..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: 1
entity:deid |  | 0..1 | BackboneElement | Data or objects used
what | S | 1..1 | Reference(Resource) | Specific instance of resource
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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
entity:consent |  | 0..1 | BackboneElement | Data or objects used
what | S | 1..1 | Reference(Resource) | Specific instance of resource
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://hl7.org/fhir/resource-types
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.subtype:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG

#### Constraints

Id | Grade | Path(s) | Description | Expression
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
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://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: 110106
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 | Σ | 1..* | Coding | More specific type/id for the event Slice: Unordered, Open by value:$this Binding: AuditEventSub-Type (extensible): Sub-type of event.
subtype:deidentify | Σ | 1..1 | Coding | More specific type/id for the event Binding: Audit Event Subtype for De-Identification (required)
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: R
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.
outcomeDesc | S Σ | 0..1 | string | Description of the event outcome
purposeOfEvent | S Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent |  | 2..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value: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 (extensible): The reason the activity took place.
agent:source | C | 1..1 | BackboneElement | Actor involved in the event Constraints: val-audit-source
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
media |  | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
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 (extensible): The reason the activity took place.
agent:recipient |  | 0..* | 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 |  | 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
media |  | 0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
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 (extensible): The reason the activity took place.
agent:custodian |  | 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 |  | 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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 159541003
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
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 (extensible): The reason the activity took place.
agent:authorizer |  | 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 |  | 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://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 429577009
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
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 (extensible): The reason the activity took place.
source |  | 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 |  | 0..1 | string | Logical source location within the enterprise
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 | 2..* | BackboneElement | Data or objects used Slice: Unordered, Open by value: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:patient | 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(Patient) | 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: 1
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: 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: 1
display |  | 0..1 | string | Representation defined by the system
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 |
entity:deid | 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 | S Σ | 1..1 | Reference(Resource) | 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: https://profiles.ihe.net/ITI/DeId/CodeSystem/DeIdentificationEntityType
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DeId-algorithm
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:consent | 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 | S Σ | 1..1 | Reference(Resource) | 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://hl7.org/fhir/resource-types
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: Consent
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 |
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:deidentify | Base | required | Audit Event Subtype for De-Identification | 📦0.0.1-current | This IG
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 v7.1
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 v7.1
AuditEvent.agent:source.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:source.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:recipient.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:recipient.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:custodian.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:custodian.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:authorizer.​type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:authorizer.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
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 | 📍4.0.1 | FHIR Std.
AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:patient.​securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:deid.​securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity:consent.​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:patient, AuditEvent.entity:deid, AuditEvent.entity:consent | Either a name or a query (NOT both) | `name.empty() or query.empty()`
val-audit-source | error | AuditEvent.agent:source | The Audit Source is this agent too. | `$this.who = %resource.source.observer`

This structure is derived from AuditEvent

Summary

Mandatory: 11 elements(11 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.subtype
- The element 1 is sliced based on the value of AuditEvent.agent
- The element 1 is sliced based on the value of AuditEvent.entity

Other representations of profile: CSV, Excel, Schematron