OZO FHIR implementation guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: OZO AuditEvent

AuditEvent profile for OZO AAA Proxy to comply with NEN7510 standards

Usages:

• Examples for this Profile: AuditEvent/AuditEvent-Practitioner-Manu-Access, AuditEvent/AuditEvent-Practitioner-Mark-Access, AuditEvent/AuditEvent-REST-Create-Example, AuditEvent/AuditEvent-REST-Search-Example... Show 3 more, AuditEvent/AuditEvent-REST-Update-Failure, AuditEvent/AuditEvent-RelatedPerson-Access and AuditEvent/AuditEvent-System-Access

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	SΣ	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	SΣ	1..1	code	Type of action performed (C,R,U,D,E) Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded	SΣ	1..1	instant	When the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	SΣ	0..1	string	Description of the event outcome
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: OZO AuditEvent Agent Type ValueSet (extensible)
who	SΣ	1..1	Reference(Practitioner | RelatedPerson | Device)	Identifier of who performed the action
requestor	SΣ	1..1	boolean	Whether user is initiator
source	S	1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	0..1	string	Logical source location within the enterprise
observer	SΣ	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	SC	0..*	BackboneElement	Data or objects used Constraints: sev-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle	S	0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
query	SΣC	0..1	base64Binary	Query parameters if applicable
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 From the FHIR Standard
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role From the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
type	S	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	S	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	S	1..1	code	Type of action performed (C,R,U,D,E)
recorded	S	1..1	instant	When the event was recorded
outcome	S	1..1	code	Whether the event succeeded or failed
outcomeDesc	S	0..1	string	Description of the event outcome
agent	S	1..*	BackboneElement	Actor involved in the event
type	S	0..1	CodeableConcept	How agent participated Binding: OZO AuditEvent Agent Type ValueSet (extensible)
who	S	1..1	Reference(Practitioner | RelatedPerson | Device)	Identifier of who performed the action
requestor	S	1..1	boolean	Whether user is initiator
source	S	1..1	BackboneElement	Audit Event Reporter
site	S	0..1	string	Logical source location within the enterprise
observer	S	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	S	0..*	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played
lifecycle	S	0..1	Coding	Life-cycle stage for the entity
query	S	0..1	base64Binary	Query parameters if applicable
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	SΣ	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	SΣ	1..1	code	Type of action performed (C,R,U,D,E) Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		0..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	When the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	SΣ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
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: OZO AuditEvent Agent Type ValueSet (extensible)
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 | RelatedPerson | Device)	Identifier of who performed the action
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	SΣ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source	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	string	Logical source location within the enterprise
observer	SΣ	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	SC	0..*	BackboneElement	Data or objects used Constraints: sev-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle	S	0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	SΣC	0..1	base64Binary	Query parameters if applicable
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 From the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
AuditEvent.agent.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype From the FHIR Standard
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 From the FHIR Standard
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role From the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

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

Extensions

This structure refers to these extensions:

• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	SΣ	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	SΣ	1..1	code	Type of action performed (C,R,U,D,E) Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded	SΣ	1..1	instant	When the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	SΣ	0..1	string	Description of the event outcome
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: OZO AuditEvent Agent Type ValueSet (extensible)
who	SΣ	1..1	Reference(Practitioner | RelatedPerson | Device)	Identifier of who performed the action
requestor	SΣ	1..1	boolean	Whether user is initiator
source	S	1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site	S	0..1	string	Logical source location within the enterprise
observer	SΣ	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	SC	0..*	BackboneElement	Data or objects used Constraints: sev-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle	S	0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
query	SΣC	0..1	base64Binary	Query parameters if applicable
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 From the FHIR Standard
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role From the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

Differential View

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
type	S	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	S	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	S	1..1	code	Type of action performed (C,R,U,D,E)
recorded	S	1..1	instant	When the event was recorded
outcome	S	1..1	code	Whether the event succeeded or failed
outcomeDesc	S	0..1	string	Description of the event outcome
agent	S	1..*	BackboneElement	Actor involved in the event
type	S	0..1	CodeableConcept	How agent participated Binding: OZO AuditEvent Agent Type ValueSet (extensible)
who	S	1..1	Reference(Practitioner | RelatedPerson | Device)	Identifier of who performed the action
requestor	S	1..1	boolean	Whether user is initiator
source	S	1..1	BackboneElement	Audit Event Reporter
site	S	0..1	string	Logical source location within the enterprise
observer	S	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	S	0..*	BackboneElement	Data or objects used
what	S	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played
lifecycle	S	0..1	Coding	Life-cycle stage for the entity
query	S	0..1	base64Binary	Query parameters if applicable
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:traceId	S	0..1	string	OZO Trace ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
extension:spanId	S	0..1	string	OZO Span ID URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
extension:resourceOrigin	S	0..1	string	OZO Resource Origin URL: http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	SΣ	1..1	Coding	Type of event (rest, transmit) Binding: OZO AuditEvent Type ValueSet (required)
subtype	SΣ	0..*	Coding	Specific type of event (read, create, update, delete, search, capabilities) Binding: OZO AuditEvent Subtype ValueSet (extensible)
action	SΣ	1..1	code	Type of action performed (C,R,U,D,E) Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period		0..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	When the event was recorded
outcome	SΣ	1..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	SΣ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
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: OZO AuditEvent Agent Type ValueSet (extensible)
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 | RelatedPerson | Device)	Identifier of who performed the action
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	SΣ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source	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	string	Logical source location within the enterprise
observer	SΣ	1..1	Reference(Device)	The identity of source detecting the event
type	S	1..*	Coding	The type of source where event originated Binding: OZO AuditEvent Source Type ValueSet (extensible)
entity	SC	0..*	BackboneElement	Data or objects used Constraints: sev-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	1..1	Reference(Resource)	Specific resource accessed
type	S	0..1	Coding	Type of entity involved Binding: OZO AuditEvent Entity Type ValueSet (extensible)
role	S	0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle	S	0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	SΣC	0..1	base64Binary	Query parameters if applicable
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	required	OZOAuditEventTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-type-vs From this IG
AuditEvent.subtype	extensible	OZOAuditEventSubtypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-subtype-vs From this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 From the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	extensible	OZOAuditEventAgentTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-agent-type-vs From this IG
AuditEvent.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
AuditEvent.agent.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype From the FHIR Standard
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 From the FHIR Standard
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	extensible	OZOAuditEventSourceTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-source-type-vs From this IG
AuditEvent.entity.type	extensible	OZOAuditEventEntityTypeVS http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/ValueSet/ozo-auditevent-entity-type-vs From this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role From the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard

Constraints

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

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

Extensions

This structure refers to these extensions:

• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-trace-id
• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-span-id
• http://headease.gitlab.io/ozo-refererence-impl/ozo-implementation-guide/StructureDefinition/ozo-resource-origin

Other representations of profile: CSV, Excel, Schematron