EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide
1.1.0 - Informative Release 1
EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide
1.1.0 - Informative Release 1
EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide, published by HL7 International / Electronic Health Records. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ehrs-rle-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ehrs-rle/StructureDefinition/ehrsrle-auditevent | Version: 1.1.0 | |||
| Standards status: Informative | Maturity Level: 1 | Computable Name: EHRSFunctionalModelRecordLifecycleEventsAuditEvent | ||
Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AuditEvent | 0..* | AuditEvent | Record of an event | |
  category | S | 0..* | CodeableConcept | Type/identifier of event |
| code | S | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) |
| action | S | 0..1 | code | Type of action performed during the event |
| recorded | S | 1..1 | instant | Time when the event was recorded |
| authorization | S | 0..* | CodeableConcept | Authorization related to the event |
 agent | S | 1..* | BackboneElement | Actor involved in the event |
 who | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | S | 0..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred |
| network[x] | S | 0..1 | Reference(Endpoint), uri, string | This agent network location for the activity |
 authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
 entity | S | 0..* | BackboneElement | Data or objects used |
 what | S | 0..1 | Reference(Resource) | Specific instance of resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AuditEvent.code | preferred | RecordLifecycleEvents |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Record of an event | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 category | SΣ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. |
| code | SΣ | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) |
| action | SΣ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action |
| recorded | SΣ | 1..1 | instant | Time when the event was recorded |
| authorization | SΣ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. |
| agent | SΣ | 1..* | BackboneElement | Actor involved in the event |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 who | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | SΣ | 0..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred |
 network[x] | S | 0..1 | This agent network location for the activity | |
| networkReference | Reference(Endpoint) | |||
| networkUri | uri | |||
| networkString | string | |||
| authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. |
| source | SΣ | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| entity | SΣ | 0..* | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | SΣ | 0..1 | Reference(Resource) | Specific instance of resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AuditEvent.category | example | AuditEventID |
| AuditEvent.code | preferred | RecordLifecycleEvents |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.authorization | example | PurposeOfUse |
| AuditEvent.agent.authorization | example | PurposeOfUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Record of an event | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category | SΣ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. | ||||
| code | SΣ | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) | ||||
| action | SΣ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action | ||||
| severity | Σ | 0..1 | code | emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | ||||
| occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | SΣ | 1..1 | instant | Time when the event was recorded | ||||
| outcome | Σ | 0..1 | BackboneElement | Whether the event succeeded or failed | ||||
| 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 | ||||
| code | Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome | ||||
| detail | Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. | ||||
| authorization | SΣ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient | 0..1 | Reference(Patient) | The patient is the subject of the data used/created/updated/deleted during the activity | |||||
| encounter | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| agent | SΣ | 1..* | BackboneElement | Actor involved in the event | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): 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 | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor | SΣ | 0..1 | boolean | Whether user is initiator | ||||
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred | ||||
| policy | 0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] | S | 0..1 | This agent network location for the activity | |||||
| networkReference | Reference(Endpoint) | |||||||
| networkUri | uri | |||||||
| networkString | string | |||||||
| authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | ||||
| source | SΣ | 1..1 | BackboneElement | Audit Event Reporter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site | 0..1 | Reference(Location) | Logical source location within the enterprise | |||||
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event | ||||
| type | 0..* | CodeableConcept | The type of source where event originated Binding: AuditEventSourceType (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. | |||||
| entity | SΣ | 0..* | BackboneElement | Data or objects used | ||||
| 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Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| role | 0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| securityLabel | 0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query | Σ | 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 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] | 1..1 | Property value | ||||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| valueBase64Binary | base64Binary | |||||||
| agent | 0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| AuditEvent.language | required | AllLanguages |
| AuditEvent.category | example | AuditEventID |
| AuditEvent.code | preferred | RecordLifecycleEvents |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.severity | required | AuditEventSeverity |
| AuditEvent.outcome.code | preferred | AuditEventOutcome |
| AuditEvent.outcome.detail | example | AuditEventOutcomeDetail |
| AuditEvent.authorization | example | PurposeOfUse |
| AuditEvent.agent.type | preferred | ParticipationRoleType |
| AuditEvent.agent.role | example | SecurityRoleType |
| AuditEvent.agent.authorization | example | PurposeOfUse |
| AuditEvent.source.type | preferred | AuditEventSourceType |
| AuditEvent.entity.role | example | AuditEventEntityRole |
| AuditEvent.entity.securityLabel | example | SecurityLabelExamples |
| AuditEvent.entity.detail.type | example | AuditEventID |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
This structure is derived from AuditEvent
Differential View
This structure is derived from AuditEvent
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Record of an event | |
| category | S | 0..* | CodeableConcept | Type/identifier of event |
| code | S | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) |
| action | S | 0..1 | code | Type of action performed during the event |
| recorded | S | 1..1 | instant | Time when the event was recorded |
| authorization | S | 0..* | CodeableConcept | Authorization related to the event |
| agent | S | 1..* | BackboneElement | Actor involved in the event |
| who | S | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | S | 0..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred |
| network[x] | S | 0..1 | Reference(Endpoint), uri, string | This agent network location for the activity |
| authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent |
| source | S | 1..1 | BackboneElement | Audit Event Reporter |
| entity | S | 0..* | BackboneElement | Data or objects used |
| what | S | 0..1 | Reference(Resource) | Specific instance of resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AuditEvent.code | preferred | RecordLifecycleEvents |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Record of an event | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | SΣ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. |
| code | SΣ | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) |
| action | SΣ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action |
| recorded | SΣ | 1..1 | instant | Time when the event was recorded |
| authorization | SΣ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. |
| agent | SΣ | 1..* | BackboneElement | Actor involved in the event |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| who | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who |
| requestor | SΣ | 0..1 | boolean | Whether user is initiator |
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred |
| network[x] | S | 0..1 | This agent network location for the activity | |
| networkReference | Reference(Endpoint) | |||
| networkUri | uri | |||
| networkString | string | |||
| authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. |
| source | SΣ | 1..1 | BackboneElement | Audit Event Reporter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event |
| entity | SΣ | 0..* | BackboneElement | Data or objects used |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| what | SΣ | 0..1 | Reference(Resource) | Specific instance of resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AuditEvent.category | example | AuditEventID |
| AuditEvent.code | preferred | RecordLifecycleEvents |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.authorization | example | PurposeOfUse |
| AuditEvent.agent.authorization | example | PurposeOfUse |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AuditEvent | 0..* | AuditEvent | Record of an event | |||||
| 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: AllLanguages (required): IETF language tag for a human language
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
| category | SΣ | 0..* | CodeableConcept | Type/identifier of event Binding: AuditEventID (example): Type of event. | ||||
| code | SΣ | 1..1 | CodeableConcept | Specific type of event Binding: ValueSet record-lifecycle-events (preferred) | ||||
| action | SΣ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action | ||||
| severity | Σ | 0..1 | code | emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3 | ||||
| occurred[x] | 0..1 | When the activity occurred | ||||||
| occurredPeriod | Period | |||||||
| occurredDateTime | dateTime | |||||||
| recorded | SΣ | 1..1 | instant | Time when the event was recorded | ||||
| outcome | Σ | 0..1 | BackboneElement | Whether the event succeeded or failed | ||||
| 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 | ||||
| code | Σ | 1..1 | Coding | Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome | ||||
| detail | Σ | 0..* | CodeableConcept | Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue. | ||||
| authorization | SΣ | 0..* | CodeableConcept | Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. | ||||
| basedOn | 0..* | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) | Workflow authorization within which this event occurred | |||||
| patient | 0..1 | Reference(Patient) | The patient is the subject of the data used/created/updated/deleted during the activity | |||||
| encounter | 0..1 | Reference(Encounter) | Encounter within which this event occurred or which the event is tightly associated | |||||
| agent | SΣ | 1..* | BackboneElement | Actor involved in the event | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | 0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (preferred): 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 | SΣ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Identifier of who | ||||
| requestor | SΣ | 0..1 | boolean | Whether user is initiator | ||||
| location | S | 0..1 | Reference(Location) | The agent location when the event occurred | ||||
| policy | 0..* | uri | Policy that authorized the agent participation in the event | |||||
| network[x] | S | 0..1 | This agent network location for the activity | |||||
| networkReference | Reference(Endpoint) | |||||||
| networkUri | uri | |||||||
| networkString | string | |||||||
| authorization | S | 0..* | CodeableConcept | Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. | ||||
| source | SΣ | 1..1 | BackboneElement | Audit Event Reporter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| site | 0..1 | Reference(Location) | Logical source location within the enterprise | |||||
| observer | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | The identity of source detecting the event | ||||
| type | 0..* | CodeableConcept | The type of source where event originated Binding: AuditEventSourceType (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. | |||||
| entity | SΣ | 0..* | BackboneElement | Data or objects used | ||||
| 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Σ | 0..1 | Reference(Resource) | Specific instance of resource | ||||
| role | 0..1 | CodeableConcept | What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role | |||||
| securityLabel | 0..* | CodeableConcept | Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | |||||
| query | Σ | 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 | CodeableConcept | Name of the property Binding: AuditEventID (example): Additional detail about an entity used in an event. | |||||
| value[x] | 1..1 | Property value | ||||||
| valueQuantity | Quantity | |||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueString | string | |||||||
| valueBoolean | boolean | |||||||
| valueInteger | integer | |||||||
| valueRange | Range | |||||||
| valueRatio | Ratio | |||||||
| valueTime | time | |||||||
| valueDateTime | dateTime | |||||||
| valuePeriod | Period | |||||||
| valueBase64Binary | base64Binary | |||||||
| agent | 0..* | See agent (AuditEvent) | Entity is attributed to this agent | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet |
| AuditEvent.language | required | AllLanguages |
| AuditEvent.category | example | AuditEventID |
| AuditEvent.code | preferred | RecordLifecycleEvents |
| AuditEvent.action | required | AuditEventAction |
| AuditEvent.severity | required | AuditEventSeverity |
| AuditEvent.outcome.code | preferred | AuditEventOutcome |
| AuditEvent.outcome.detail | example | AuditEventOutcomeDetail |
| AuditEvent.authorization | example | PurposeOfUse |
| AuditEvent.agent.type | preferred | ParticipationRoleType |
| AuditEvent.agent.role | example | SecurityRoleType |
| AuditEvent.agent.authorization | example | PurposeOfUse |
| AuditEvent.source.type | preferred | AuditEventSourceType |
| AuditEvent.entity.role | example | AuditEventEntityRole |
| AuditEvent.entity.securityLabel | example | SecurityLabelExamples |
| AuditEvent.entity.detail.type | example | AuditEventID |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() |
This structure is derived from AuditEvent
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Electronic Health Records. Package hl7.fhir.uv.ehrs-rle#1.1.0 based on FHIR 5.0.0. Generated 2024-01-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change