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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
1..* | BackboneElement | Actor involved in the event | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator | |
![]() ![]() |
1..1 | BackboneElement | Audit Event Reporter | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() |
C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | string | Name of the property | |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..0 | Metadata about the resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..0 | Representation defined by the system | ||
![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() |
0..0 | More specific type/id for the event | ||
![]() ![]() |
0..0 | Type of action performed during the event | ||
![]() ![]() |
0..0 | When the activity occurred | ||
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
0..0 | Whether the event succeeded or failed | ||
![]() ![]() |
0..0 | Description of the event outcome | ||
![]() ![]() |
0..0 | The purposeOfUse of the event | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Logical source location within the enterprise | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() ![]() |
0..0 | The type of source where event originated | ||
![]() ![]() |
0..1 | BackboneElement | Data or objects used | |
![]() ![]() ![]() |
0..0 | Specific instance of resource | ||
![]() ![]() ![]() |
0..0 | Type of entity involved | ||
![]() ![]() ![]() |
0..0 | What role the entity played | ||
![]() ![]() ![]() |
0..0 | Life-cycle stage for the entity | ||
![]() ![]() ![]() |
0..0 | Security labels on the entity | ||
![]() ![]() ![]() |
0..0 | Descriptor for entity | ||
![]() ![]() ![]() |
0..0 | Descriptive text | ||
![]() ![]() ![]() |
0..0 | Query parameters | ||
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| 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'
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
1..* | BackboneElement | Actor involved in the event | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
![]() ![]() ![]() |
0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
![]() ![]() ![]() |
0..1 | string | Alternative User identity | |
![]() ![]() ![]() |
0..1 | string | Human friendly name for the agent | |
![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator | |
![]() ![]() ![]() |
0..1 | Reference(Location) | Where | |
![]() ![]() ![]() |
0..* | uri | Policy that authorized event | |
![]() ![]() ![]() |
0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |
![]() ![]() ![]() |
0..1 | BackboneElement | Logical network location for application activity | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | string | Identifier for the network access point of the user device | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |
![]() ![]() |
1..1 | BackboneElement | Audit Event Reporter | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() |
C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | string | Name of the property | |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| 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 |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
1..* | BackboneElement | Actor involved in the event | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator | |
![]() ![]() |
1..1 | BackboneElement | Audit Event Reporter | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() |
C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | string | Name of the property | |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
0..0 | Metadata about the resource | ||
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Language of the resource content | ||
![]() ![]() |
0..0 | Text summary of the resource, for human interpretation | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() |
0..0 | Representation defined by the system | ||
![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() |
0..0 | More specific type/id for the event | ||
![]() ![]() |
0..0 | Type of action performed during the event | ||
![]() ![]() |
0..0 | When the activity occurred | ||
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
0..0 | Whether the event succeeded or failed | ||
![]() ![]() |
0..0 | Description of the event outcome | ||
![]() ![]() |
0..0 | The purposeOfUse of the event | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Logical source location within the enterprise | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Literal reference, Relative, internal or absolute URL | ||
![]() ![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") | ||
![]() ![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() ![]() |
0..0 | The type of source where event originated | ||
![]() ![]() |
0..1 | BackboneElement | Data or objects used | |
![]() ![]() ![]() |
0..0 | Specific instance of resource | ||
![]() ![]() ![]() |
0..0 | Type of entity involved | ||
![]() ![]() ![]() |
0..0 | What role the entity played | ||
![]() ![]() ![]() |
0..0 | Life-cycle stage for the entity | ||
![]() ![]() ![]() |
0..0 | Security labels on the entity | ||
![]() ![]() ![]() |
0..0 | Descriptor for entity | ||
![]() ![]() ![]() |
0..0 | Descriptive text | ||
![]() ![]() ![]() |
0..0 | Query parameters | ||
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() |
1..1 | instant | Time of the sampled access event. | |
![]() ![]() |
1..* | BackboneElement | Actor involved in the event | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |
![]() ![]() ![]() |
0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who | |
![]() ![]() ![]() |
0..1 | string | Alternative User identity | |
![]() ![]() ![]() |
0..1 | string | Human friendly name for the agent | |
![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator | |
![]() ![]() ![]() |
0..1 | Reference(Location) | Where | |
![]() ![]() ![]() |
0..* | uri | Policy that authorized event | |
![]() ![]() ![]() |
0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |
![]() ![]() ![]() |
0..1 | BackboneElement | Logical network location for application activity | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | string | Identifier for the network access point of the user device | |
![]() ![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |
![]() ![]() |
1..1 | BackboneElement | Audit Event Reporter | |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
1..1 | string | Text alternative for the resource Required Pattern: SDHR verification samples (extensions allowed) | |
![]() ![]() |
C | 0..1 | BackboneElement | Data or objects used Constraints: sev-1 |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 1..* | BackboneElement | NHI or correlation ID of the sampled request. Constraints: sdhr-verification-detail-type |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
1..1 | string | Name of the property | |
![]() ![]() ![]() ![]() |
1..1 | string | Property value | |
Documentation for this format | ||||
| 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 |
| 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
Other representations of profile: CSV, Excel, Schematron