Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-AuditEvent | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_AuditEvent_R3 | ||
This cross-version profile allows R5 AuditEvent content to be represented via FHIR STU3 AuditEvent resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍20150326 | FHIR Std. |
| AuditEvent.source.identifier.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
  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: Common Languages  (extensible): A human language.
| |||||
| 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 | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
   extension:severity |
0..1 | code | R5: emergency | alert | critical | error | warning | notice | informational | debug (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity Binding: R5AuditEventSeverityForR3 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | |||||
| extension:occurred |
0..1 | Period, dateTime | R5: When the activity occurred (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred | |||||
| extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(0.1.0) | Task) | R5: Workflow authorization within which this event occurred (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn | |||||
| extension:patient |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient) | R5: The patient is the subject of the data used/created/updated/deleted during the activity (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient | |||||
 extension:encounter |
0..1 | Reference(Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter) | R5: Encounter within which this event occurred or which the event is tightly associated (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter | |||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
Σ | 1..1 | Coding | Type/identifier of event Binding: Audit Event ID (extensible): Type of event. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:category |
0..* | CodeableConcept | R5: category additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category Binding: Audit Event ID (example): Type of event. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
 userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| subtype |
Σ | 0..* | Coding | More specific type/id for the event Binding: Audit Event Sub-Type (extensible): Sub-type of event. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:code |
1..1 | CodeableConcept | R5: Specific type of event additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code Binding: Audit Event Sub-Type (example): Specific type of event. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event | ||||
| recorded |
Σ | 1..1 | instant | Time when the event occurred on source | ||||
| outcome |
Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:code |
1..1 | Coding | R5: Whether the event succeeded or failed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome | |||||
| extension:detail |
0..* | CodeableConcept | R5: Additional outcome detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail Binding: R5AuditEventOutcomeDetailForR3 (0.1.0) (example): A code that provides details as the exact issue. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| outcomeDesc |
Σ | 0..1 | string | Description of the event outcome | ||||
| purposeOfEvent |
Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place. | ||||
| agent |
1..* | BackboneElement | Actor involved in the event | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: How agent participated (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent.type Binding: R5ParticipationRoleTypeForR3 (0.1.0) (preferred): The Participation type of the agent to the event. | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event | |||||
 reference |
Σ | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | Direct reference to resource | ||||
| userId |
Σ | 0..1 | Identifier | Unique identifier for the user | ||||
| altId |
0..1 | string | Alternative User id e.g. authentication | |||||
| name |
0..1 | string | Human-meaningful 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: Media Type Code (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 | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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|2014-03-26 (extensible): The reason the activity took place. | |||||
| source |
1..1 | BackboneElement | Audit Event Reporter | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| site |
0..1 | string | Logical source location within the enterprise | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:site |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: site additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| identifier |
Σ | 1..1 | Identifier | The identity of source detecting the event | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:observer |
1..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: observer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.observer | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
 type |
0..* | Coding | The type of source where event originated Binding: Audit Event Source Type (extensible): Code specifying the type of system that detected and recorded the event. | |||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..* | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type Binding: Audit Event Source Type (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| entity |
C | 0..* | BackboneElement | Data or objects used Constraints: sev-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:what |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Specific instance of resource additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| extension:agent |
0..* | (Complex) | R5: Entity is attributed to this agent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..1 | Identifier | Specific instance of object | ||||
| reference |
Σ | 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:role |
0..1 | CodeableConcept | R5: role additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:securityLabel |
0..* | CodeableConcept | R5: securityLabel additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel Binding: R5SecurityLabelExamplesForR3 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:value |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, time, dateTime, Period | R5: Property value additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | string | Name of the property | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type Binding: Audit Event ID (example): Additional detail about an entity used in an event. | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| value |
1..1 | base64Binary | Property value | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍20150326 | FHIR Std. |
| AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍20100826 | FHIR Std. |
| AuditEvent.action | Base | required | AuditEventAction | 📍3.0.2 | FHIR Std. |
| AuditEvent.outcome | Base | required | AuditEventOutcome | 📍3.0.2 | FHIR Std. |
| AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📍2014-03-26 | FHIR Std. |
| AuditEvent.agent.role | Base | extensible |
SecurityRoleType
|
📍1.8.0 | tx.fhir.org |
| AuditEvent.agent.media | Base | extensible | Media Type Code | 📍20100826 | FHIR Std. |
| AuditEvent.agent.network.type | Base | required | AuditEventAgentNetworkType | 📍3.0.2 | FHIR Std. |
| AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📍2014-03-26 | FHIR Std. |
| AuditEvent.source.identifier.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| AuditEvent.source.identifier.type | Base | extensible | Identifier Type Codes | 📍3.0.2 | FHIR Std. |
| AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍20100826 | FHIR Std. |
| AuditEvent.entity.type | Base | extensible | AuditEventEntityType | 📍3.0.2 | FHIR Std. |
| AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍3.0.2 | FHIR Std. |
| AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍1.1.0 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | extensible |
All Security Labels
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | Either a name or a query (NOT both) |
name.empty() or query.empty()
|
This structure is derived from AuditEvent
Summary
Mandatory: 0 element(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍20150326 | FHIR Std. |
| AuditEvent.source.identifier.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from AuditEvent
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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: Common Languages (extensible): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:severity |
0..1 | code | R5: emergency | alert | critical | error | warning | notice | informational | debug (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.severity Binding: R5AuditEventSeverityForR3 (0.1.0) (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | |||||
| extension:occurred |
0..1 | Period, dateTime | R5: When the activity occurred (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.occurred | |||||
| extension:basedOn |
0..* | Reference(Cross-version Profile for R5.CarePlan for use in FHIR STU3(0.1.0) | CarePlan | Cross-version Profile for R5.DeviceRequest for use in FHIR STU3(0.1.0) | DeviceRequest | Cross-version Profile for R5.ImmunizationRecommendation for use in FHIR STU3(0.1.0) | ImmunizationRecommendation | Cross-version Profile for R5.MedicationRequest for use in FHIR STU3(0.1.0) | MedicationRequest | Cross-version Profile for R5.NutritionOrder for use in FHIR STU3(0.1.0) | NutritionOrder | Cross-version Profile for R5.ServiceRequest for use in FHIR STU3(0.1.0) | ReferralRequest | Cross-version Profile for R5.Task for use in FHIR STU3(0.1.0) | Task) | R5: Workflow authorization within which this event occurred (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.basedOn | |||||
| extension:patient |
0..1 | Reference(Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient) | R5: The patient is the subject of the data used/created/updated/deleted during the activity (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.patient | |||||
| extension:encounter |
0..1 | Reference(Cross-version Profile for R5.Encounter for use in FHIR STU3(0.1.0) | Encounter) | R5: Encounter within which this event occurred or which the event is tightly associated (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.encounter | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
Σ | 1..1 | Coding | Type/identifier of event Binding: Audit Event ID (extensible): Type of event. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:category |
0..* | CodeableConcept | R5: category additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.category Binding: Audit Event ID (example): Type of event. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| subtype |
Σ | 0..* | Coding | More specific type/id for the event Binding: Audit Event Sub-Type (extensible): Sub-type of event. | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:code |
1..1 | CodeableConcept | R5: Specific type of event additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.code Binding: Audit Event Sub-Type (example): Specific type of event. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| action |
Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event | ||||
| recorded |
Σ | 1..1 | instant | Time when the event occurred on source | ||||
| outcome |
Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:code |
1..1 | Coding | R5: Whether the event succeeded or failed (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.code Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome | |||||
| extension:detail |
0..* | CodeableConcept | R5: Additional outcome detail (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.outcome.detail Binding: R5AuditEventOutcomeDetailForR3 (0.1.0) (example): A code that provides details as the exact issue. | |||||
| value |
0..1 | code | Primitive value for code | |||||
| outcomeDesc |
Σ | 0..1 | string | Description of the event outcome | ||||
| purposeOfEvent |
Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place. | ||||
| agent |
1..* | BackboneElement | Actor involved in the event | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: How agent participated (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent.type Binding: R5ParticipationRoleTypeForR3 (0.1.0) (preferred): The Participation type of the agent to the event. | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| role |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event | |||||
| reference |
Σ | 0..1 | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) | Direct reference to resource | ||||
| userId |
Σ | 0..1 | Identifier | Unique identifier for the user | ||||
| altId |
0..1 | string | Alternative User id e.g. authentication | |||||
| name |
0..1 | string | Human-meaningful 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: Media Type Code (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 | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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|2014-03-26 (extensible): The reason the activity took place. | |||||
| source |
1..1 | BackboneElement | Audit Event Reporter | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| extension |
0..* | Extension | Additional Content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| site |
0..1 | string | Logical source location within the enterprise | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:site |
0..1 | Reference(Cross-version Profile for R5.Location for use in FHIR STU3(0.1.0) | Location) | R5: site additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.site | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| identifier |
Σ | 1..1 | Identifier | The identity of source detecting the event | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:observer |
1..1 | Reference(Cross-version Profile for R5.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R5.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R5.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R5.CareTeam for use in FHIR STU3(0.1.0) | CareTeam | Cross-version Profile for R5.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R5.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R5.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson) | R5: observer additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.observer | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| type |
0..* | Coding | The type of source where event originated Binding: Audit Event Source Type (extensible): Code specifying the type of system that detected and recorded the event. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..* | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.source.type Binding: Audit Event Source Type (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| entity |
C | 0..* | BackboneElement | Data or objects used Constraints: sev-1 | ||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:what |
0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R5: Specific instance of resource additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |||||
| extension:agent |
0..* | (Complex) | R5: Entity is attributed to this agent (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.agent | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 0..1 | Identifier | Specific instance of object | ||||
| reference |
Σ | 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 | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:role |
0..1 | CodeableConcept | R5: role additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.role Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| 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. | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:securityLabel |
0..* | CodeableConcept | R5: securityLabel additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.securityLabel Binding: R5SecurityLabelExamplesForR3 (0.1.0) (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| 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 | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:value |
0..1 | Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, time, dateTime, Period | R5: Property value additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.value | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| type |
1..1 | string | Name of the property | |||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:type |
0..1 | CodeableConcept | R5: type additional types URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-AuditEvent.entity.detail.type Binding: Audit Event ID (example): Additional detail about an entity used in an event. | |||||
| value |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
| value |
1..1 | base64Binary | Property value | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.language | Base | extensible |
Common Languages
|
📍3.0.2 | tx.fhir.org |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍20150326 | FHIR Std. |
| AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍20100826 | FHIR Std. |
| AuditEvent.action | Base | required | AuditEventAction | 📍3.0.2 | FHIR Std. |
| AuditEvent.outcome | Base | required | AuditEventOutcome | 📍3.0.2 | FHIR Std. |
| AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📍2014-03-26 | FHIR Std. |
| AuditEvent.agent.role | Base | extensible |
SecurityRoleType
|
📍1.8.0 | tx.fhir.org |
| AuditEvent.agent.media | Base | extensible | Media Type Code | 📍20100826 | FHIR Std. |
| AuditEvent.agent.network.type | Base | required | AuditEventAgentNetworkType | 📍3.0.2 | FHIR Std. |
| AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📍2014-03-26 | FHIR Std. |
| AuditEvent.source.identifier.use | Base | required | IdentifierUse | 📍3.0.2 | FHIR Std. |
| AuditEvent.source.identifier.type | Base | extensible | Identifier Type Codes | 📍3.0.2 | FHIR Std. |
| AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍20100826 | FHIR Std. |
| AuditEvent.entity.type | Base | extensible | AuditEventEntityType | 📍3.0.2 | FHIR Std. |
| AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍3.0.2 | FHIR Std. |
| AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍1.1.0 | FHIR Std. |
| AuditEvent.entity.securityLabel | Base | extensible |
All Security Labels
|
📍3.0.2 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-1 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain any narrative |
contained.text.empty()
|
| 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 |
contained.where(('#'+id in %resource.descendants().reference).not()).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()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() | (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 | Either a name or a query (NOT both) |
name.empty() or query.empty()
|
This structure is derived from AuditEvent
Summary
Mandatory: 0 element(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
