HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Communication Audit Event Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-communication-audit-event Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreCommunicationAuditEvent

Security and access audit trail for creation, routing, access, delivery, acknowledgement, or escalation of a hub communication.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... code SΣ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity SΣ 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] S 1..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 BackboneElement Whether the event succeeded or failed
.... 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
... authorization SΣ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
... basedOn S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role S 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Σ 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 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
... source SΣ 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 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Σ 1..* BackboneElement Data or objects used
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... what SΣ 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel S 0..* CodeableConcept Security labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... detail S 0..* BackboneElement Additional Information about the entity
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 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().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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Record of an event
... category S 0..* CodeableConcept Type/identifier of event
... code S 1..1 CodeableConcept Specific type of event
... action S 1..1 code Type of action performed during the event
... occurred[x] S 1..1 Period, dateTime When the activity occurred
... recorded S 1..1 instant Time when the event was recorded
... outcome S 0..1 BackboneElement Whether the event succeeded or failed
... authorization S 0..* CodeableConcept Authorization related to the event
... basedOn S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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
.... type S 0..1 CodeableConcept How agent participated
.... role S 0..* CodeableConcept Agent role in the event
.... who S 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
.... requestor S 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 0..* uri Policy that authorized the agent participation in the event
.... network[x] S 0..1 Reference(Endpoint), uri, string This agent network location for the activity
... source S 1..1 BackboneElement Audit Event Reporter
.... site S 0..1 Reference(Location) Logical source location within the enterprise
.... observer S 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 0..* CodeableConcept The type of source where event originated
... entity S 1..* BackboneElement Data or objects used
.... what S 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
.... securityLabel S 0..* CodeableConcept Security labels on the entity
.... detail S 0..* BackboneElement Additional Information about the entity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category SΣ 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
... code SΣ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity SΣ 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] S 1..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Time when the event was recorded
... outcome SΣ 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 S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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 S 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role S 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Σ 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 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 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 S 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 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Σ 1..* 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Σ 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel S 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 S 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 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().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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... code SΣ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity SΣ 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] S 1..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Time when the event was recorded
... outcome SΣ 0..1 BackboneElement Whether the event succeeded or failed
.... 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
... authorization SΣ 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
... basedOn S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role S 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Σ 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 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
... source SΣ 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site S 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 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Σ 1..* BackboneElement Data or objects used
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... what SΣ 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel S 0..* CodeableConcept Security labels on the entity
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
.... detail S 0..* BackboneElement Additional Information about the entity
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 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().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()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AuditEvent 0..* AuditEvent Record of an event
... category S 0..* CodeableConcept Type/identifier of event
... code S 1..1 CodeableConcept Specific type of event
... action S 1..1 code Type of action performed during the event
... occurred[x] S 1..1 Period, dateTime When the activity occurred
... recorded S 1..1 instant Time when the event was recorded
... outcome S 0..1 BackboneElement Whether the event succeeded or failed
... authorization S 0..* CodeableConcept Authorization related to the event
... basedOn S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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
.... type S 0..1 CodeableConcept How agent participated
.... role S 0..* CodeableConcept Agent role in the event
.... who S 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Identifier of who
.... requestor S 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 0..* uri Policy that authorized the agent participation in the event
.... network[x] S 0..1 Reference(Endpoint), uri, string This agent network location for the activity
... source S 1..1 BackboneElement Audit Event Reporter
.... site S 0..1 Reference(Location) Logical source location within the enterprise
.... observer S 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 0..* CodeableConcept The type of source where event originated
... entity S 1..* BackboneElement Data or objects used
.... what S 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
.... securityLabel S 0..* CodeableConcept Security labels on the entity
.... detail S 0..* BackboneElement Additional Information about the entity

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... category SΣ 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
... code SΣ 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubType (example): Specific type of event.
... action SΣ 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): DICOM Audit Event Action
... severity SΣ 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] S 1..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded SΣ 1..1 instant Time when the event was recorded
... outcome SΣ 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 S 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
... patient S 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
... encounter S 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 S 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (preferred): The Participation type of the agent to the event.
.... role S 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Σ 1..1 boolean Whether user is initiator
.... location S 0..1 Reference(Location) The agent location when the event occurred
.... policy S 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 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 S 0..1 Reference(Location) Logical source location within the enterprise
.... observer SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
.... type S 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Σ 1..* 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Σ 1..1 Reference(ZM-Core Communication Request Profile | ZM-Core Communication Profile | ZM-Core Communication Task Profile | ZM-Core Communication Consent Profile) Specific instance of resource
.... role S 0..1 CodeableConcept What role the entity played
Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
.... securityLabel S 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 S 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.code Base example Audit Event Sub-Type 📍5.0.0 FHIR Std.
AuditEvent.action Base required Audit Event Action 📍5.0.0 FHIR Std.
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base preferred Audit Event Outcome 📍5.0.0 FHIR Std.
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.agent.type Base preferred Participation Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.role Base example Security Role Type 📍5.0.0 FHIR Std.
AuditEvent.agent.authorization Base example PurposeOfUse 📦3.1.0 THO v7.1
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base example Audit Event Entity Role 📍5.0.0 FHIR Std.
AuditEvent.entity.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
AuditEvent.entity.detail.​type Base example Audit Event ID 📍5.0.0 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().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()

 

Other representations of profile: CSV, Excel, Schematron