Audit Events Implementation Guide
0.1.0 - draft

Audit Events Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Hira Audit Event

Official URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/hira-audit-event Version: 0.1.0
Draft as of 2026-10-27 Computable Name: HiraAuditEvent

Constrains the AuditEvent resource to represent Data Access through the Hira Connector Plane

Capture of Data Access through the Hira Connector Plane

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.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AuditEvent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.action This element is included in summaries. 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
AuditEvent.recorded This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element is included in summaries. 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
AuditEvent.outcomeDesc This element is included in summaries. 1..1 string Description of the event outcome
AuditEvent.purposeOfEvent This element is included in summaries. 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:All Slices Content/Rules for all slices
AuditEvent.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:All Slices.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:healthworkforce.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:system.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation.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 The gateway or entity which logged the event
AuditEvent.Slices for entity C 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Constraints: sev-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:All Slices Content/Rules for all slices
AuditEvent.Slices for entity.entity:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource C 1..1 BackboneElement The REST or FHIR resource that is being accessed
Constraints: sev-1
AuditEvent.Slices for entity.entity:accessedResource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:dataSubject C 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
Constraints: sev-1
AuditEvent.Slices for entity.entity:dataSubject.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}

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.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG
AuditEvent.agent:slf.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.type 1..1 Coding Type/identifier of event
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.action 1..1 code Type of action performed during the event
AuditEvent.outcome 1..1 code Whether the event succeeded or failed
AuditEvent.purposeOfEvent 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.source
AuditEvent.source.observer
AuditEvent.source.observer.display 1..1 string The gateway or entity which logged the event
AuditEvent.Slices for entity 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:accessedResource 1..1 BackboneElement The REST or FHIR resource that is being accessed
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:dataSubject 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 0..1 id Logical id of this artifact
AuditEvent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AuditEvent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AuditEvent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AuditEvent.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
AuditEvent.contained 0..* Resource Contained, inline Resources
AuditEvent.extension 0..* Extension Additional content defined by implementations
AuditEvent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.subtype This element is included in summaries. 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
AuditEvent.action This element is included in summaries. 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
AuditEvent.period 0..1 Period When the activity occurred
AuditEvent.recorded This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element is included in summaries. 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
AuditEvent.outcomeDesc This element is included in summaries. 1..1 string Description of the event outcome
AuditEvent.purposeOfEvent This element is included in summaries. 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:All Slices Content/Rules for all slices
AuditEvent.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:All Slices.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:All Slices.role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
AuditEvent.Slices for agent.agent:All Slices.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:All Slices.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:All Slices.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:All Slices.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:All Slices.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:All Slices.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:All Slices.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:All Slices.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:All Slices.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:All Slices.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:All Slices.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.Slices for agent.agent:All Slices.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:All Slices.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.Slices for agent.agent:All Slices.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:slf.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:slf.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:slf.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:slf.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:slf.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:slf.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:slf.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:slf.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:slf.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:slf.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.Slices for agent.agent:slf.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:slf.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.Slices for agent.agent:slf.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:dlg.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:dlg.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:dlg.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:dlg.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:dlg.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:dlg.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:dlg.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:dlg.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:dlg.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:dlg.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.Slices for agent.agent:dlg.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:dlg.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.Slices for agent.agent:dlg.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:caregiver.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:caregiver.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:caregiver.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:caregiver.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:caregiver.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:caregiver.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:caregiver.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:caregiver.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:caregiver.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:caregiver.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.Slices for agent.agent:caregiver.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:caregiver.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.Slices for agent.agent:caregiver.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:delegatee.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:delegatee.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:delegatee.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:delegatee.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:delegatee.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:delegatee.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:delegatee.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:delegatee.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:delegatee.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:delegatee.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.Slices for agent.agent:delegatee.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:delegatee.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.Slices for agent.agent:delegatee.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:healthworkforce.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:healthworkforce.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:healthworkforce.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:healthworkforce.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:healthworkforce.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:healthworkforce.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:healthworkforce.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:healthworkforce.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:healthworkforce.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:healthworkforce.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:healthworkforce.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:healthworkforce.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.Slices for agent.agent:healthworkforce.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:healthworkforce.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.Slices for agent.agent:healthworkforce.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:system.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:system.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:system.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:system.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:system.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:system.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:system.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:system.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:system.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:system.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:system.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:system.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.Slices for agent.agent:system.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:system.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.Slices for agent.agent:system.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:organisation.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:organisation.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:organisation.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:organisation.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:organisation.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:organisation.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:organisation.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:organisation.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:organisation.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:organisation.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:organisation.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.Slices for agent.agent:organisation.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:organisation.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.Slices for agent.agent:organisation.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.site 0..1 string Logical source location within the enterprise
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.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
AuditEvent.source.observer.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AuditEvent.source.observer.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
AuditEvent.source.observer.display This element is included in summaries. 1..1 string The gateway or entity which logged the event
AuditEvent.source.type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
AuditEvent.Slices for entity C 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Constraints: sev-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:All Slices Content/Rules for all slices
AuditEvent.Slices for entity.entity:All Slices.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:All Slices.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:All Slices.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:All Slices.type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
AuditEvent.Slices for entity.entity:All Slices.role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
AuditEvent.Slices for entity.entity:All Slices.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:All Slices.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:All Slices.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:All Slices.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:All Slices.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:All Slices.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:All Slices.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:All Slices.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:All Slices.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.Slices for entity.entity:All Slices.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:All Slices.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:All Slices.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:All Slices.detail.value[x].valueBase64Binary base64Binary
AuditEvent.Slices for entity.entity:accessedResource C 1..1 BackboneElement The REST or FHIR resource that is being accessed
Constraints: sev-1
AuditEvent.Slices for entity.entity:accessedResource.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:accessedResource.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:accessedResource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:accessedResource.role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
AuditEvent.Slices for entity.entity:accessedResource.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:accessedResource.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:accessedResource.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:accessedResource.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:accessedResource.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:accessedResource.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:accessedResource.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:accessedResource.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:accessedResource.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.Slices for entity.entity:accessedResource.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x].valueBase64Binary base64Binary
AuditEvent.Slices for entity.entity:dataSubject C 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
Constraints: sev-1
AuditEvent.Slices for entity.entity:dataSubject.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:dataSubject.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:dataSubject.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:dataSubject.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:dataSubject.type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}
AuditEvent.Slices for entity.entity:dataSubject.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:dataSubject.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:dataSubject.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:dataSubject.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:dataSubject.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:dataSubject.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:dataSubject.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:dataSubject.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:dataSubject.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.Slices for entity.entity:dataSubject.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x].valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG
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.5
AuditEvent.agent:slf.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:dlg.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:caregiver.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:delegatee.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:healthworkforce.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:system.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:organisation.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.source.observer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

Summary

Mandatory: 7 elements(8 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of AuditEvent.agent
  • The element 2 is sliced based on the values of AuditEvent.entity

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AuditEvent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.action This element is included in summaries. 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
AuditEvent.recorded This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element is included in summaries. 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
AuditEvent.outcomeDesc This element is included in summaries. 1..1 string Description of the event outcome
AuditEvent.purposeOfEvent This element is included in summaries. 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:All Slices Content/Rules for all slices
AuditEvent.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:All Slices.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:healthworkforce.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:system.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation.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 The gateway or entity which logged the event
AuditEvent.Slices for entity C 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Constraints: sev-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:All Slices Content/Rules for all slices
AuditEvent.Slices for entity.entity:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource C 1..1 BackboneElement The REST or FHIR resource that is being accessed
Constraints: sev-1
AuditEvent.Slices for entity.entity:accessedResource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:dataSubject C 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
Constraints: sev-1
AuditEvent.Slices for entity.entity:dataSubject.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}

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.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG
AuditEvent.agent:slf.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.type 1..1 Coding Type/identifier of event
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.action 1..1 code Type of action performed during the event
AuditEvent.outcome 1..1 code Whether the event succeeded or failed
AuditEvent.outcomeDesc 1..1 string Description of the event outcome
AuditEvent.purposeOfEvent 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.name 0..0 Human friendly name for the agent
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.source
AuditEvent.source.observer
AuditEvent.source.observer.display 1..1 string The gateway or entity which logged the event
AuditEvent.Slices for entity 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:accessedResource 1..1 BackboneElement The REST or FHIR resource that is being accessed
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:dataSubject 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent Event record kept for security purposes
AuditEvent.id This element is included in summaries. 0..1 id Logical id of this artifact
AuditEvent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
AuditEvent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
AuditEvent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
AuditEvent.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
AuditEvent.contained 0..* Resource Contained, inline Resources
AuditEvent.extension 0..* Extension Additional content defined by implementations
AuditEvent.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
AuditEvent.type This element is included in summaries. 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
AuditEvent.subtype This element is included in summaries. 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.
AuditEvent.action This element is included in summaries. 1..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
AuditEvent.period 0..1 Period When the activity occurred
AuditEvent.recorded This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element is included in summaries. 1..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
AuditEvent.outcomeDesc This element is included in summaries. 1..1 string Description of the event outcome
AuditEvent.purposeOfEvent This element is included in summaries. 0..* CodeableConcept Purpose of use codes including NZ specific terminology
Binding: NZ purpose of use (extensible)
AuditEvent.Slices for agent 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:role, value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:All Slices Content/Rules for all slices
AuditEvent.Slices for agent.agent:All Slices.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:All Slices.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:All Slices.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:All Slices.role 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
AuditEvent.Slices for agent.agent:All Slices.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:All Slices.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:All Slices.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:All Slices.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:All Slices.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:All Slices.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:All Slices.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:All Slices.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:All Slices.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:All Slices.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:All Slices.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.Slices for agent.agent:All Slices.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:All Slices.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.Slices for agent.agent:All Slices.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:slf 0..1 BackboneElement The Patient who is logged in and accessing their own records
AuditEvent.Slices for agent.agent:slf.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:slf.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:slf.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:slf.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:slf.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:slf.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:slf.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "patient"
    }
  ]
}
AuditEvent.Slices for agent.agent:slf.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:slf.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:slf.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:slf.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:slf.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:slf.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:slf.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:slf.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:slf.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:slf.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.Slices for agent.agent:slf.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:slf.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.Slices for agent.agent:slf.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:dlg 0..1 BackboneElement The Patient who has provided delegated access to their own records
AuditEvent.Slices for agent.agent:dlg.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:dlg.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:dlg.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:dlg.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:dlg.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:dlg.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:dlg.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATOR"
    }
  ]
}
AuditEvent.Slices for agent.agent:dlg.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:dlg.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:dlg.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:dlg.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:dlg.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:dlg.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:dlg.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:dlg.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:dlg.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:dlg.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.Slices for agent.agent:dlg.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:dlg.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.Slices for agent.agent:dlg.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:caregiver 0..1 BackboneElement The Caregiver accessing a child's records
AuditEvent.Slices for agent.agent:caregiver.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:caregiver.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:caregiver.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:caregiver.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:caregiver.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:caregiver.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:caregiver.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
      "code" : "AUCG"
    }
  ]
}
AuditEvent.Slices for agent.agent:caregiver.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:caregiver.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:caregiver.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:caregiver.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:caregiver.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:caregiver.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:caregiver.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:caregiver.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:caregiver.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:caregiver.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.Slices for agent.agent:caregiver.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:caregiver.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.Slices for agent.agent:caregiver.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:delegatee 0..1 BackboneElement A Delegate accessing a patient's records on their behalf
AuditEvent.Slices for agent.agent:delegatee.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:delegatee.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:delegatee.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:delegatee.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:delegatee.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:delegatee.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:delegatee.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
AuditEvent.Slices for agent.agent:delegatee.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:delegatee.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:delegatee.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:delegatee.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:delegatee.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:delegatee.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:delegatee.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:delegatee.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:delegatee.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:delegatee.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.Slices for agent.agent:delegatee.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:delegatee.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.Slices for agent.agent:delegatee.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:healthworkforce 0..1 BackboneElement A member of the Health Workforce accessing patient records
AuditEvent.Slices for agent.agent:healthworkforce.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:healthworkforce.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:healthworkforce.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:healthworkforce.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:healthworkforce.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "https://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:healthworkforce.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:healthworkforce.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:healthworkforce.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:healthworkforce.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:healthworkforce.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:healthworkforce.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:healthworkforce.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:healthworkforce.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:healthworkforce.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:healthworkforce.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:healthworkforce.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.Slices for agent.agent:healthworkforce.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:healthworkforce.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.Slices for agent.agent:healthworkforce.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:system 0..1 BackboneElement A system accessing Patient records
AuditEvent.Slices for agent.agent:system.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:system.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:system.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:system.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:system.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:system.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:system.role 1..1 CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
      "code" : "dataprocessor"
    }
  ]
}
AuditEvent.Slices for agent.agent:system.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:system.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:system.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:system.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:system.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:system.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:system.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:system.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:system.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:system.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:system.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.Slices for agent.agent:system.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:system.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.Slices for agent.agent:system.purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.
AuditEvent.Slices for agent.agent:organisation 0..1 BackboneElement The organisation accessing Patient records
AuditEvent.Slices for agent.agent:organisation.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:organisation.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for agent.agent:organisation.Slices for extension Content/Rules for all slices
AuditEvent.Slices for agent.agent:organisation.Slices for extension.extension:additionalAgentDetails 0..1 (Complex) AuditEvent.Agent additional details
URL: https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/agent-additional-details-extension
AuditEvent.Slices for agent.agent:organisation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for agent.agent:organisation.type 0..1 CodeableConcept How agent participated
Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
AuditEvent.Slices for agent.agent:organisation.role 1..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.

Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
      "code" : "PROV"
    }
  ]
}
AuditEvent.Slices for agent.agent:organisation.who This element is included in summaries. 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
AuditEvent.Slices for agent.agent:organisation.altId 0..1 string Alternative User identity
AuditEvent.Slices for agent.agent:organisation.name 0..1 string Human friendly name for the agent
AuditEvent.Slices for agent.agent:organisation.requestor This element is included in summaries. 1..1 boolean Whether user is initiator
AuditEvent.Slices for agent.agent:organisation.location 0..1 Reference(Location) Where
AuditEvent.Slices for agent.agent:organisation.policy 0..* uri Policy that authorized event
AuditEvent.Slices for agent.agent:organisation.media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.Slices for agent.agent:organisation.network 0..1 BackboneElement Logical network location for application activity
AuditEvent.Slices for agent.agent:organisation.network.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for agent.agent:organisation.network.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for agent.agent:organisation.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.Slices for agent.agent:organisation.network.address 0..1 string Identifier for the network access point of the user device
AuditEvent.Slices for agent.agent:organisation.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.Slices for agent.agent:organisation.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.site 0..1 string Logical source location within the enterprise
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.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
AuditEvent.source.observer.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
AuditEvent.source.observer.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
AuditEvent.source.observer.display This element is included in summaries. 1..1 string The gateway or entity which logged the event
AuditEvent.source.type 0..* Coding The type of source where event originated
Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
AuditEvent.Slices for entity C 1..* BackboneElement Details of the endpoints being accessed
Slice: Unordered, Open by value:type, value:role
Constraints: sev-1

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.Slices for entity.entity:All Slices Content/Rules for all slices
AuditEvent.Slices for entity.entity:All Slices.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:All Slices.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:All Slices.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:All Slices.type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
AuditEvent.Slices for entity.entity:All Slices.role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
AuditEvent.Slices for entity.entity:All Slices.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:All Slices.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:All Slices.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:All Slices.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:All Slices.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:All Slices.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:All Slices.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:All Slices.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:All Slices.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.Slices for entity.entity:All Slices.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:All Slices.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:All Slices.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:All Slices.detail.value[x].valueBase64Binary base64Binary
AuditEvent.Slices for entity.entity:accessedResource C 1..1 BackboneElement The REST or FHIR resource that is being accessed
Constraints: sev-1
AuditEvent.Slices for entity.entity:accessedResource.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:accessedResource.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:accessedResource.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:accessedResource.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:accessedResource.type 1..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
  "code" : "2"
}
AuditEvent.Slices for entity.entity:accessedResource.role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
AuditEvent.Slices for entity.entity:accessedResource.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:accessedResource.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:accessedResource.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:accessedResource.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:accessedResource.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:accessedResource.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:accessedResource.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:accessedResource.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:accessedResource.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.Slices for entity.entity:accessedResource.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:accessedResource.detail.value[x].valueBase64Binary base64Binary
AuditEvent.Slices for entity.entity:dataSubject C 0..* BackboneElement The data subject of the accessed resource, derived from the resource itself
Constraints: sev-1
AuditEvent.Slices for entity.entity:dataSubject.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:dataSubject.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:dataSubject.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
AuditEvent.Slices for entity.entity:dataSubject.what This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.Slices for entity.entity:dataSubject.type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
AuditEvent.Slices for entity.entity:dataSubject.role 1..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
Required Pattern: 
{
  "system" : "http://terminology.hl7.org/CodeSystem/object-role",
  "code" : "1"
}
AuditEvent.Slices for entity.entity:dataSubject.lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
AuditEvent.Slices for entity.entity:dataSubject.securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.Slices for entity.entity:dataSubject.name This element is included in summaries. C 0..1 string Descriptor for entity
AuditEvent.Slices for entity.entity:dataSubject.description 0..1 string Descriptive text
AuditEvent.Slices for entity.entity:dataSubject.query This element is included in summaries. C 0..1 base64Binary Query parameters
AuditEvent.Slices for entity.entity:dataSubject.detail 0..* BackboneElement Additional Information about the entity
AuditEvent.Slices for entity.entity:dataSubject.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.Slices for entity.entity:dataSubject.detail.extension 0..* Extension Additional content defined by implementations
AuditEvent.Slices for entity.entity:dataSubject.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.Slices for entity.entity:dataSubject.detail.type 1..1 string Name of the property
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x] 1..1 Property value
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x].valueString string
AuditEvent.Slices for entity.entity:dataSubject.detail.value[x].valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AuditEvent.type Base extensible Audit Event ID 📍4.0.1 FHIR Std.
AuditEvent.subtype Base extensible Audit Event Sub-Type 📍4.0.1 FHIR Std.
AuditEvent.action Base required AuditEventAction 📍4.0.1 FHIR Std.
AuditEvent.outcome Base required AuditEventOutcome 📍4.0.1 FHIR Std.
AuditEvent.purposeOfEvent Base extensible NZ purpose of use 📦20240725 This IG
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.5
AuditEvent.agent:slf.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:slf.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:dlg.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:dlg.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:caregiver.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:caregiver.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:delegatee.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:delegatee.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:healthworkforce.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:healthworkforce.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:system.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:system.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.agent:organisation.​type Base extensible ParticipationRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​role Base example SecurityRoleType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​media Base extensible Media Type Code 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​network.type Base required AuditEventAgentNetworkType 📍4.0.1 FHIR Std.
AuditEvent.agent:organisation.​purposeOfUse Base extensible PurposeOfUse 📦3.1.0 THO v7.5
AuditEvent.source.observer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
AuditEvent.source.type Base extensible Audit Event Source Type 📍4.0.1 FHIR Std.
AuditEvent.entity.type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity.role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity.lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:accessedResource.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​type Base extensible Audit event entity type 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​role Base extensible AuditEventEntityRole 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​lifecycle Base extensible ObjectLifecycleEvents 📍4.0.1 FHIR Std.
AuditEvent.entity:dataSubject.​securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

Summary

Mandatory: 7 elements(8 nested mandatory elements)
Prohibited: 4 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of AuditEvent.agent
  • The element 2 is sliced based on the values of AuditEvent.entity

 

Other representations of profile: CSV, Excel, Schematron