NZ Shared Digital Health Record API
1.1.6 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Resource Profile: SDHRAuditEvent

Official URL: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAuditEvent Version: 1.1.6
Draft as of 2026-10-20 Computable Name: SDHRAuditEvent

AuditEvent returned by the SDHR verification samples operation. Contains the local verification reference, original agents, NHI and correlation ID with the minimal required FHIR AuditEvent envelope.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 1..1 id Logical id of this artifact
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
AuditEvent.type.system This element is included in summaries. 1..1 uri Identity of the terminology system
AuditEvent.type.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
AuditEvent.recorded This element is included in summaries. 1..1 instant Time of the sampled access event.
AuditEvent.agent 1..* BackboneElement Actor involved in the event
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.source 1..1 BackboneElement Audit Event Reporter
AuditEvent.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
AuditEvent.source.observer.display This element is included in summaries. 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.entity C 0..1 BackboneElement Data or objects used
Constraints: sev-1
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail.type 1..1 string Name of the property
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'
sev-1 error AuditEvent.entity Either a name or a query (NOT both) name.empty() or query.empty()

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id 1..1 id Logical id of this artifact
AuditEvent.meta 0..0 Metadata about the resource
AuditEvent.implicitRules 0..0 A set of rules under which this content was created
AuditEvent.text 0..0 Text summary of the resource, for human interpretation
AuditEvent.contained 0..0 Contained, inline Resources
AuditEvent.extension 0..0 Extension
AuditEvent.modifierExtension 0..0 Extension
AuditEvent.type
AuditEvent.type.system 1..1 uri Identity of the terminology system
AuditEvent.type.version 0..0 Version of the system - if relevant
AuditEvent.type.code 1..1 code Symbol in syntax defined by the system
AuditEvent.type.display 0..0 Representation defined by the system
AuditEvent.type.userSelected 0..0 If this coding was chosen directly by the user
AuditEvent.subtype 0..0 More specific type/id for the event
AuditEvent.action 0..0 Type of action performed during the event
AuditEvent.period 0..0 When the activity occurred
AuditEvent.recorded 1..1 instant Time of the sampled access event.
AuditEvent.outcome 0..0 Whether the event succeeded or failed
AuditEvent.outcomeDesc 0..0 Description of the event outcome
AuditEvent.purposeOfEvent 0..0 The purposeOfUse of the event
AuditEvent.source
AuditEvent.source.site 0..0 Logical source location within the enterprise
AuditEvent.source.observer
AuditEvent.source.observer.reference 0..0 Literal reference, Relative, internal or absolute URL
AuditEvent.source.observer.type 0..0 Type the reference refers to (e.g. "Patient")
AuditEvent.source.observer.identifier 0..0 Logical reference, when literal reference is not known
AuditEvent.source.observer.display 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.source.type 0..0 The type of source where event originated
AuditEvent.entity 0..1 BackboneElement Data or objects used
AuditEvent.entity.what 0..0 Specific instance of resource
AuditEvent.entity.type 0..0 Type of entity involved
AuditEvent.entity.role 0..0 What role the entity played
AuditEvent.entity.lifecycle 0..0 Life-cycle stage for the entity
AuditEvent.entity.securityLabel 0..0 Security labels on the entity
AuditEvent.entity.name 0..0 Descriptor for entity
AuditEvent.entity.description 0..0 Descriptive text
AuditEvent.entity.query 0..0 Query parameters
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 1..1 id Logical id of this artifact
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
AuditEvent.type.id 0..1 string Unique id for inter-element referencing
AuditEvent.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AuditEvent.type.system This element is included in summaries. 1..1 uri Identity of the terminology system
AuditEvent.type.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
AuditEvent.recorded This element is included in summaries. 1..1 instant Time of the sampled access event.
AuditEvent.agent 1..* BackboneElement Actor involved in the event
AuditEvent.agent.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.extension 0..* Extension Additional content defined by implementations
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.agent.role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
AuditEvent.agent.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.agent.altId 0..1 string Alternative User identity
AuditEvent.agent.name 0..1 string Human friendly name for the agent
AuditEvent.agent.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.agent.location 0..1 Reference(Location) Where
AuditEvent.agent.policy 0..* uri Policy that authorized event
AuditEvent.agent.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.agent.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.agent.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.agent.network.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.agent.network.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.
AuditEvent.agent.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.source 1..1 BackboneElement Audit Event Reporter
AuditEvent.source.id 0..1 string Unique id for inter-element referencing
AuditEvent.source.extension 0..* Extension Additional content defined by implementations
AuditEvent.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
AuditEvent.source.observer.id 0..1 string Unique id for inter-element referencing
AuditEvent.source.observer.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AuditEvent.source.observer.display This element is included in summaries. 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.entity C 0..1 BackboneElement Data or objects used
Constraints: sev-1
AuditEvent.entity.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.extension 0..* Extension Additional content defined by implementations
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail.type 1..1 string Name of the property
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'
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)
Prohibited: 29 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 1..1 id Logical id of this artifact
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
AuditEvent.type.system This element is included in summaries. 1..1 uri Identity of the terminology system
AuditEvent.type.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
AuditEvent.recorded This element is included in summaries. 1..1 instant Time of the sampled access event.
AuditEvent.agent 1..* BackboneElement Actor involved in the event
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.source 1..1 BackboneElement Audit Event Reporter
AuditEvent.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
AuditEvent.source.observer.display This element is included in summaries. 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.entity C 0..1 BackboneElement Data or objects used
Constraints: sev-1
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail.type 1..1 string Name of the property
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'
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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id 1..1 id Logical id of this artifact
AuditEvent.meta 0..0 Metadata about the resource
AuditEvent.implicitRules 0..0 A set of rules under which this content was created
AuditEvent.language 0..0 Language of the resource content
AuditEvent.text 0..0 Text summary of the resource, for human interpretation
AuditEvent.contained 0..0 Contained, inline Resources
AuditEvent.extension 0..0 Extension
AuditEvent.modifierExtension 0..0 Extension
AuditEvent.type
AuditEvent.type.system 1..1 uri Identity of the terminology system
AuditEvent.type.version 0..0 Version of the system - if relevant
AuditEvent.type.code 1..1 code Symbol in syntax defined by the system
AuditEvent.type.display 0..0 Representation defined by the system
AuditEvent.type.userSelected 0..0 If this coding was chosen directly by the user
AuditEvent.subtype 0..0 More specific type/id for the event
AuditEvent.action 0..0 Type of action performed during the event
AuditEvent.period 0..0 When the activity occurred
AuditEvent.recorded 1..1 instant Time of the sampled access event.
AuditEvent.outcome 0..0 Whether the event succeeded or failed
AuditEvent.outcomeDesc 0..0 Description of the event outcome
AuditEvent.purposeOfEvent 0..0 The purposeOfUse of the event
AuditEvent.source
AuditEvent.source.site 0..0 Logical source location within the enterprise
AuditEvent.source.observer
AuditEvent.source.observer.reference 0..0 Literal reference, Relative, internal or absolute URL
AuditEvent.source.observer.type 0..0 Type the reference refers to (e.g. "Patient")
AuditEvent.source.observer.identifier 0..0 Logical reference, when literal reference is not known
AuditEvent.source.observer.display 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.source.type 0..0 The type of source where event originated
AuditEvent.entity 0..1 BackboneElement Data or objects used
AuditEvent.entity.what 0..0 Specific instance of resource
AuditEvent.entity.type 0..0 Type of entity involved
AuditEvent.entity.role 0..0 What role the entity played
AuditEvent.entity.lifecycle 0..0 Life-cycle stage for the entity
AuditEvent.entity.securityLabel 0..0 Security labels on the entity
AuditEvent.entity.name 0..0 Descriptor for entity
AuditEvent.entity.description 0..0 Descriptive text
AuditEvent.entity.query 0..0 Query parameters
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 1..1 id Logical id of this artifact
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
AuditEvent.type.id 0..1 string Unique id for inter-element referencing
AuditEvent.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AuditEvent.type.system This element is included in summaries. 1..1 uri Identity of the terminology system
AuditEvent.type.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
AuditEvent.recorded This element is included in summaries. 1..1 instant Time of the sampled access event.
AuditEvent.agent 1..* BackboneElement Actor involved in the event
AuditEvent.agent.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.extension 0..* Extension Additional content defined by implementations
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.agent.role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
AuditEvent.agent.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.agent.altId 0..1 string Alternative User identity
AuditEvent.agent.name 0..1 string Human friendly name for the agent
AuditEvent.agent.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.agent.location 0..1 Reference(Location) Where
AuditEvent.agent.policy 0..* uri Policy that authorized event
AuditEvent.agent.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.agent.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.agent.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.agent.network.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.agent.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.agent.network.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.
AuditEvent.agent.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.source 1..1 BackboneElement Audit Event Reporter
AuditEvent.source.id 0..1 string Unique id for inter-element referencing
AuditEvent.source.extension 0..* Extension Additional content defined by implementations
AuditEvent.source.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
AuditEvent.source.observer.id 0..1 string Unique id for inter-element referencing
AuditEvent.source.observer.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
AuditEvent.source.observer.display This element is included in summaries. 1..1 string Text alternative for the resource
Required Pattern: SDHR verification samples (extensions allowed)
AuditEvent.entity C 0..1 BackboneElement Data or objects used
Constraints: sev-1
AuditEvent.entity.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.extension 0..* Extension Additional content defined by implementations
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail C 1..* BackboneElement NHI or correlation ID of the sampled request.
Constraints: sdhr-verification-detail-type
AuditEvent.entity.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.entity.detail.type 1..1 string Name of the property
AuditEvent.entity.detail.value[x] 1..1 string Property value

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.agent.type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent.media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent.network.​type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent.purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.4

Constraints

Id Grade Path(s) Description Expression
dom-2 error AuditEvent If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AuditEvent If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error AuditEvent If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AuditEvent A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sdhr-verification-detail-type error AuditEvent.entity.detail Sample details contain only the NHI or request correlation ID. type = 'nhi' or type = 'correlationId'
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)
Prohibited: 29 elements

 

Other representations of profile: CSV, Excel, Schematron