Uzbekistan Digital Health Platform
0.11.1 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.11.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core AuditEvent ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-auditevent Version: 0.11.1
Active as of 2025-03-29 Computable Name: UZCoreAuditEvent

Uzbekistan Core AuditEvent profile, used to track user and application activity

UZ Core AuditEvent is the immutable audit log of who accessed or changed what on the Digital Health Platform. It follows the IHE ATNA / DICOM audit model: the platform logs reads, creates, updates, deletes, searches, logins and break-glass events, recording the query behind a search and flagging failed or denied access (HTTP 401 / 403). AuditEvents are written by the platform and are read-only to clients; they link to the Patient whose data was involved.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.

Each UZ Core AuditEvent Must Have

This profile adds no top-level mandatory cardinality of its own. The required elements are the ones inherited from the base resource: a code (what happened), a recorded timestamp, at least one agent with a who, and a source with an observer. Within the dhpCategory category slice, when present, the system (DICOM dcm) and code are each 1..1.

Each UZ Core AuditEvent Must Support

  • a category - the event grouping, with a sliced dhpCategory coding from DICOM (required binding on its code);
  • a code - the specific event sub-type (required binding);
  • an action - create, read, update, delete or execute (required binding);
  • an occurredDateTime and the recorded timestamp;
  • an outcome, whose code uses the required outcome binding (success, or a failure for denied 401 / 403 access);
  • the patient whose data was involved;
  • an agent with its type, role, who and authorization (the purpose-of-use, required binding) - who may be a PractitionerRole, Practitioner, Patient or RelatedPerson;
  • an entity with its role, what, securityLabel and query (the base64-encoded search, where applicable).

Break-glass access is recorded here as an AuditEvent whose agent.authorization carries an emergency purpose-of-use.

Building the JSON, step by step

AuditEvents are written by the platform, not by clients, so you mostly read them - but it helps to know their shape. The examples below show a self-contained event and then an event that touches a patient's data. Every value shown validates against this profile. The full reference instances are linked at the bottom of the page (login, condition lookup).

A representative event (a login)

A self-contained event names what happened (code), its grouping (category), the action (E = execute), when it occurredDateTime and was recorded, the outcome.code, the agent who did it, and the source that logged it. The agent.who is a plain Reference and may point at a PractitionerRole, Practitioner, Patient or RelatedPerson:

{
  "resourceType": "AuditEvent",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-auditevent" ] },
  "category": [
    {
      "coding": [
        {
          "system": "http://dicom.nema.org/resources/ontology/DCM",
          "code": "110114",
          "display": "User Authentication"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://dicom.nema.org/resources/ontology/DCM",
        "code": "110122",
        "display": "Login"
      }
    ]
  },
  "action": "E",
  "occurredDateTime": "2023-11-09T15:23:47.123Z",
  "recorded": "2023-11-09T15:23:47.123Z",
  "outcome": { "code": { "system": "http://hl7.org/fhir/issue-severity", "code": "success" } },
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
            "code": "humanuser"
          }
        ]
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sample-security-structural-roles",
              "code": "regulated-health-professionals"
            }
          ]
        }
      ],
      "authorization": [
        {
          "coding": [
            { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "TREAT" }
          ]
        }
      ],
      "who": { "reference": "PractitionerRole/example-practitionerrole" }
    }
  ],
  "source": {
    "observer": { "display": "Uzbekistan Digital Health Platform" },
    "type": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
            "code": "4",
            "display": "Application Server"
          }
        ]
      }
    ]
  }
}

category, code, action, outcome.code, and the agent codings (type, role, authorization) each use a required binding - the value must come from the bound value set (the Snapshot view below lists each one). agent.authorization is the purpose-of-use (TREAT here); a break-glass access carries an emergency purpose-of-use instead.

An event that touched a patient's data

When the event read or changed a specific patient's record, add the patient it concerned and an entity describing the resource that was touched. Here a practitioner searched for a Condition: the action is R (read), the code is the FHIR search interaction, and entity.what references the resource that was returned. Both patient and entity.what are plain Reference types:

{
  "resourceType": "AuditEvent",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-auditevent" ] },
  "category": [
    {
      "coding": [
        {
          "system": "http://dicom.nema.org/resources/ontology/DCM",
          "code": "110112",
          "display": "Query"
        }
      ]
    }
  ],
  "code": {
    "coding": [ { "system": "http://hl7.org/fhir/restful-interaction", "code": "search" } ]
  },
  "action": "R",
  "occurredDateTime": "2025-02-15T14:02:52Z",
  "recorded": "2025-02-15T14:02:52Z",
  "outcome": { "code": { "system": "http://hl7.org/fhir/issue-severity", "code": "success" } },
  "patient": { "reference": "Patient/example-patient" },
  "agent": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
            "code": "humanuser"
          }
        ]
      },
      "role": [
        {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sample-security-structural-roles",
              "code": "regulated-health-professionals"
            }
          ]
        }
      ],
      "authorization": [
        {
          "coding": [
            { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "TREAT" }
          ]
        }
      ],
      "who": { "reference": "PractitionerRole/example-practitionerrole" }
    }
  ],
  "entity": [
    {
      "role": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/object-role",
            "code": "4",
            "display": "Domain Resource"
          }
        ]
      },
      "securityLabel": [
        {
          "coding": [
            { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "NOAUTH" }
          ]
        }
      ],
      "what": { "reference": "Condition/example-headache" }
    }
  ],
  "source": {
    "observer": { "display": "Uzbekistan Digital Health Platform" },
    "type": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/security-source-type",
            "code": "4",
            "display": "Application Server"
          }
        ]
      }
    ]
  }
}

For a search, the platform also records the query itself (base64-encoded) in entity.query. A failed or denied access (HTTP 401 / 403) is logged the same way but with a failure outcome.code.

For example API calls and a sample payload, see the Quick Start at the bottom of this page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
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.contained 0..* Resource Contained, inline Resources
AuditEvent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
AuditEvent.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
AuditEvent.category.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. This element is included in summaries. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.Slices for occurred[x] 0..1 When the activity occurred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
AuditEvent.Slices for occurred[x].occurredPeriod Period
AuditEvent.Slices for occurred[x].occurredDateTime dateTime
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. This element is included in summaries. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.outcome.code This element is included in summaries. 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.agent This element must be supported. This element is included in summaries. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.source This element is included in summaries. 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
Constraints: ext-1
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
AuditEvent.entity This element must be supported. This element is included in summaries. 0..* BackboneElement Data or objects used
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.what This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. This element is included in summaries. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)
AuditEvent.entity.detail.value[x] 1..1 Property value
AuditEvent.entity.detail.value[x].valueQuantity Quantity
AuditEvent.entity.detail.value[x].valueCodeableConcept CodeableConcept
AuditEvent.entity.detail.value[x].valueString string
AuditEvent.entity.detail.value[x].valueBoolean boolean
AuditEvent.entity.detail.value[x].valueInteger integer
AuditEvent.entity.detail.value[x].valueRange Range
AuditEvent.entity.detail.value[x].valueRatio Ratio
AuditEvent.entity.detail.value[x].valueTime time
AuditEvent.entity.detail.value[x].valueDateTime dateTime
AuditEvent.entity.detail.value[x].valuePeriod Period
AuditEvent.entity.detail.value[x].valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
AuditEvent.category This element must be supported. 0..* CodeableConcept Type/identifier of event
AuditEvent.category.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.code This element must be supported. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.code 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.agent This element must be supported. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.entity This element must be supported. 0..* BackboneElement Data or objects used
AuditEvent.entity.what This element must be supported. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
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
Constraints: ext-1
AuditEvent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
AuditEvent.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
AuditEvent.category.id 0..1 id Unique id for inter-element referencing
AuditEvent.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
AuditEvent.category.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.id 0..1 id Unique id for inter-element referencing
AuditEvent.category.Slices for coding.coding:dhpCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.version This element is included in summaries. 0..1 string Version of the system - if relevant
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.category.Slices for coding.coding:dhpCategory.display This element is included in summaries. C 0..1 string Representation defined by the system
AuditEvent.category.Slices for coding.coding:dhpCategory.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
AuditEvent.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
AuditEvent.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. This element is included in summaries. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.severity This element is included in summaries. 0..1 code emergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
AuditEvent.Slices for occurred[x] 0..1 When the activity occurred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
AuditEvent.Slices for occurred[x].occurredPeriod Period
AuditEvent.Slices for occurred[x].occurredDateTime dateTime
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. This element is included in summaries. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.id 0..1 string Unique id for inter-element referencing
AuditEvent.outcome.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.outcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.outcome.code This element is included in summaries. 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.outcome.detail This element is included in summaries. 0..* CodeableConcept Additional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
AuditEvent.authorization This element is included in summaries. 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (3.1.0) (example): The authorized purposeOfUse for the activity.
AuditEvent.basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
AuditEvent.agent This element must be supported. This element is included in summaries. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.requestor This element is included in summaries. 0..1 boolean Whether user is initiator
AuditEvent.agent.location 0..1 Reference(Location) The agent location when the event occurred
AuditEvent.agent.policy 0..* uri Policy that authorized the agent participation in the event
AuditEvent.agent.network[x] 0..1 This agent network location for the activity
AuditEvent.agent.network[x].networkReference Reference(Endpoint)
AuditEvent.agent.network[x].networkUri uri
AuditEvent.agent.network[x].networkString string
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.source This element is included in summaries. 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
Constraints: ext-1
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
Constraints: ext-1
AuditEvent.source.site 0..1 Reference(Location) Logical source location within the enterprise
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
AuditEvent.source.type 0..* CodeableConcept The type of source where event originated
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
AuditEvent.entity This element must be supported. This element is included in summaries. 0..* BackboneElement Data or objects used
AuditEvent.entity.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.what This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. This element is included in summaries. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.detail.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)
AuditEvent.entity.detail.value[x] 1..1 Property value
AuditEvent.entity.detail.value[x].valueQuantity Quantity
AuditEvent.entity.detail.value[x].valueCodeableConcept CodeableConcept
AuditEvent.entity.detail.value[x].valueString string
AuditEvent.entity.detail.value[x].valueBoolean boolean
AuditEvent.entity.detail.value[x].valueInteger integer
AuditEvent.entity.detail.value[x].valueRange Range
AuditEvent.entity.detail.value[x].valueRatio Ratio
AuditEvent.entity.detail.value[x].valueTime time
AuditEvent.entity.detail.value[x].valueDateTime dateTime
AuditEvent.entity.detail.value[x].valuePeriod Period
AuditEvent.entity.detail.value[x].valueBase64Binary base64Binary
AuditEvent.entity.agent 0..* See agent (AuditEvent) Entity is attributed to this agent

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.3
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.category.coding
  • The element 1 is sliced based on the value of AuditEvent.occurred[x]
  • The element 1 is sliced based on the value of AuditEvent.agent.role
  • The element 1 is sliced based on the value of AuditEvent.agent.authorization
  • The element 1 is sliced based on the value of AuditEvent.entity.securityLabel

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
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.contained 0..* Resource Contained, inline Resources
AuditEvent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
AuditEvent.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
AuditEvent.category.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. This element is included in summaries. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.Slices for occurred[x] 0..1 When the activity occurred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
AuditEvent.Slices for occurred[x].occurredPeriod Period
AuditEvent.Slices for occurred[x].occurredDateTime dateTime
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. This element is included in summaries. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.outcome.code This element is included in summaries. 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.agent This element must be supported. This element is included in summaries. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.source This element is included in summaries. 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
Constraints: ext-1
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
AuditEvent.entity This element must be supported. This element is included in summaries. 0..* BackboneElement Data or objects used
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.what This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. This element is included in summaries. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)
AuditEvent.entity.detail.value[x] 1..1 Property value
AuditEvent.entity.detail.value[x].valueQuantity Quantity
AuditEvent.entity.detail.value[x].valueCodeableConcept CodeableConcept
AuditEvent.entity.detail.value[x].valueString string
AuditEvent.entity.detail.value[x].valueBoolean boolean
AuditEvent.entity.detail.value[x].valueInteger integer
AuditEvent.entity.detail.value[x].valueRange Range
AuditEvent.entity.detail.value[x].valueRatio Ratio
AuditEvent.entity.detail.value[x].valueTime time
AuditEvent.entity.detail.value[x].valueDateTime dateTime
AuditEvent.entity.detail.value[x].valuePeriod Period
AuditEvent.entity.detail.value[x].valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
AuditEvent.category This element must be supported. 0..* CodeableConcept Type/identifier of event
AuditEvent.category.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.code This element must be supported. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.Slices for occurred[x] 0..1 Period, dateTime When the activity occurred
Slice: Unordered, Open by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.code 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.agent This element must be supported. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.entity This element must be supported. 0..* BackboneElement Data or objects used
AuditEvent.entity.what This element must be supported. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
AuditEvent 0..* AuditEvent(5.0.0) Record of an event
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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
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
Constraints: ext-1
AuditEvent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
AuditEvent.category This element must be supported. This element is included in summaries. 0..* CodeableConcept Type/identifier of event
Binding: AuditEventID (example): Type of event.
AuditEvent.category.id 0..1 id Unique id for inter-element referencing
AuditEvent.category.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
AuditEvent.category.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.category.Slices for coding.coding:dhpCategory This element must be supported. This element is included in summaries. 0..1 Coding Code defined by a terminology system
AuditEvent.category.Slices for coding.coding:dhpCategory.id 0..1 id Unique id for inter-element referencing
AuditEvent.category.Slices for coding.coding:dhpCategory.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
AuditEvent.category.Slices for coding.coding:dhpCategory.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://dicom.nema.org/resources/ontology/DCM (extensions allowed)
AuditEvent.category.Slices for coding.coding:dhpCategory.version This element is included in summaries. 0..1 string Version of the system - if relevant
AuditEvent.category.Slices for coding.coding:dhpCategory.code This element must be supported. This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Binding: AuditEventTypeVS (0.11.1) (required)
AuditEvent.category.Slices for coding.coding:dhpCategory.display This element is included in summaries. C 0..1 string Representation defined by the system
AuditEvent.category.Slices for coding.coding:dhpCategory.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
AuditEvent.category.text This element is included in summaries. 0..1 string Plain text representation of the concept
AuditEvent.code This element must be supported. This element is included in summaries. 1..1 CodeableConcept Specific type of event
Binding: AuditEventSubTypeVS (0.11.1) (required)
AuditEvent.action This element must be supported. This element is included in summaries. 0..1 code Type of action performed during the event
Binding: AuditEventActionVS (0.11.1) (required)
AuditEvent.severity This element is included in summaries. 0..1 code emergency | alert | critical | error | warning | notice | informational | debug
Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
AuditEvent.Slices for occurred[x] 0..1 When the activity occurred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
AuditEvent.Slices for occurred[x].occurredPeriod Period
AuditEvent.Slices for occurred[x].occurredDateTime dateTime
AuditEvent.Slices for occurred[x].occurred[x]:occurredDateTime This element must be supported. 0..1 dateTime When the activity occurred
AuditEvent.recorded This element must be supported. This element is included in summaries. 1..1 instant Time when the event was recorded
AuditEvent.outcome This element must be supported. This element is included in summaries. 0..1 BackboneElement Whether the event succeeded or failed
AuditEvent.outcome.id 0..1 string Unique id for inter-element referencing
AuditEvent.outcome.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.outcome.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.outcome.code This element is included in summaries. 1..1 Coding Whether the event succeeded or failed
Binding: AuditEventOutcomeVS (0.11.1) (required)
AuditEvent.outcome.detail This element is included in summaries. 0..* CodeableConcept Additional outcome detail
Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
AuditEvent.authorization This element is included in summaries. 0..* CodeableConcept Authorization related to the event
Binding: PurposeOfUse (3.1.0) (example): The authorized purposeOfUse for the activity.
AuditEvent.basedOn 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest | Task) Workflow authorization within which this event occurred
AuditEvent.patient This element must be supported. 0..1 Reference(Patient) The patient is the subject of the data used/created/updated/deleted during the activity
AuditEvent.encounter 0..1 Reference(Encounter) Encounter within which this event occurred or which the event is tightly associated
AuditEvent.agent This element must be supported. This element is included in summaries. 1..* BackboneElement Actor involved in the event
AuditEvent.agent.id 0..1 string Unique id for inter-element referencing
AuditEvent.agent.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.agent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.agent.type This element must be supported. 0..1 CodeableConcept How agent participated
Binding: AuditParticipationRoleTypeVS (0.11.1) (required)
AuditEvent.agent.Slices for role This element must be supported. 0..* CodeableConcept Agent role in the event
Slice: Unordered, Open by value:$this
Binding: SecurityRoleTypeVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for role.role:dhpRole This element must be supported. 0..* CodeableConcept Agent role from the national value set
Binding: SecurityRoleTypeVS (0.11.1) (required)
AuditEvent.agent.who This element must be supported. This element is included in summaries. 1..1 Reference(UZ Core PractitionerRole(0.11.1) | UZ Core Practitioner(0.11.1) | UZ Core Patient(0.11.1) | UZ Core RelatedPerson(0.11.1)) Identifier of who
AuditEvent.agent.requestor This element is included in summaries. 0..1 boolean Whether user is initiator
AuditEvent.agent.location 0..1 Reference(Location) The agent location when the event occurred
AuditEvent.agent.policy 0..* uri Policy that authorized the agent participation in the event
AuditEvent.agent.network[x] 0..1 This agent network location for the activity
AuditEvent.agent.network[x].networkReference Reference(Endpoint)
AuditEvent.agent.network[x].networkUri uri
AuditEvent.agent.network[x].networkString string
AuditEvent.agent.Slices for authorization This element must be supported. 0..* CodeableConcept Allowable authorization for this agent
Slice: Unordered, Open by value:$this
Binding: AuditPurposeOfUseVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.agent.Slices for authorization.authorization:dhpAuthorization This element must be supported. 0..* CodeableConcept Purpose of use from the national value set
Binding: AuditPurposeOfUseVS (0.11.1) (required)
AuditEvent.source This element is included in summaries. 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
Constraints: ext-1
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
Constraints: ext-1
AuditEvent.source.site 0..1 Reference(Location) Logical source location within the enterprise
AuditEvent.source.observer This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) The identity of source detecting the event
AuditEvent.source.type 0..* CodeableConcept The type of source where event originated
Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
AuditEvent.entity This element must be supported. This element is included in summaries. 0..* BackboneElement Data or objects used
AuditEvent.entity.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.entity.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.what This element must be supported. This element is included in summaries. 0..1 Reference(Resource) Specific instance of resource
AuditEvent.entity.role This element must be supported. 0..1 CodeableConcept What role the entity played
Binding: ObjectRoleVS (0.11.1) (required)
AuditEvent.entity.Slices for securityLabel This element must be supported. 0..* CodeableConcept Security labels on the entity
Slice: Unordered, Open by value:$this
Binding: SecurityLabelVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
AuditEvent.entity.Slices for securityLabel.securityLabel:dhpSecurityLabel This element must be supported. 0..* CodeableConcept Security label from the national value set
Binding: SecurityLabelVS (0.11.1) (required)
AuditEvent.entity.query This element must be supported. This element is included in summaries. 0..1 base64Binary Query parameters
AuditEvent.entity.detail This element must be supported. 0..* BackboneElement Additional Information about the entity
AuditEvent.entity.detail.id 0..1 string Unique id for inter-element referencing
AuditEvent.entity.detail.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
AuditEvent.entity.detail.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
AuditEvent.entity.detail.type 1..1 CodeableConcept Name of the property
Binding: AuditEventDetailTypeVS (0.11.1) (example)
AuditEvent.entity.detail.value[x] 1..1 Property value
AuditEvent.entity.detail.value[x].valueQuantity Quantity
AuditEvent.entity.detail.value[x].valueCodeableConcept CodeableConcept
AuditEvent.entity.detail.value[x].valueString string
AuditEvent.entity.detail.value[x].valueBoolean boolean
AuditEvent.entity.detail.value[x].valueInteger integer
AuditEvent.entity.detail.value[x].valueRange Range
AuditEvent.entity.detail.value[x].valueRatio Ratio
AuditEvent.entity.detail.value[x].valueTime time
AuditEvent.entity.detail.value[x].valueDateTime dateTime
AuditEvent.entity.detail.value[x].valuePeriod Period
AuditEvent.entity.detail.value[x].valueBase64Binary base64Binary
AuditEvent.entity.agent 0..* See agent (AuditEvent) Entity is attributed to this agent

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AuditEvent.language Base required All Languages 📍5.0.0 FHIR Std.
AuditEvent.category Base example Audit Event ID 📍5.0.0 FHIR Std.
AuditEvent.category.​coding:dhpCategory.code Base required Audit event type 📍0.11.1 This IG
AuditEvent.code Base required Audit event subtype 📍0.11.1 This IG
AuditEvent.action Base required Audit event action 📍0.11.1 This IG
AuditEvent.severity Base required Audit Event Severity 📍5.0.0 FHIR Std.
AuditEvent.outcome.code Base required Audit event outcome 📍0.11.1 This IG
AuditEvent.outcome.detail Base example Audit Event Outcome Detail 📍5.0.0 FHIR Std.
AuditEvent.authorization Base example PurposeOfUse 📍3.1.0 THO v7.3
AuditEvent.agent.type Base required Audit event role type 📍0.11.1 This IG
AuditEvent.agent.role Base preferred Security role type 📍0.11.1 This IG
AuditEvent.agent.role:dhpRole Base required Security role type 📍0.11.1 This IG
AuditEvent.agent.authorization Base preferred Purpose of use 📍0.11.1 This IG
AuditEvent.agent.authorization:dhpAuthorization Base required Purpose of use 📍0.11.1 This IG
AuditEvent.source.type Base preferred Audit Event Source Type 📍5.0.0 FHIR Std.
AuditEvent.entity.role Base required Object role 📍0.11.1 This IG
AuditEvent.entity.securityLabel Base preferred Security label 📍0.11.1 This IG
AuditEvent.entity.securityLabel:dhpSecurityLabel Base required Security label 📍0.11.1 This IG
AuditEvent.entity.detail.​type Base example Types of Audit Event Details 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from AuditEvent

Summary

Mandatory: 0 element(2 nested mandatory elements)
Must-Support: 24 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.category.coding
  • The element 1 is sliced based on the value of AuditEvent.occurred[x]
  • The element 1 is sliced based on the value of AuditEvent.agent.role
  • The element 1 is sliced based on the value of AuditEvent.agent.authorization
  • The element 1 is sliced based on the value of AuditEvent.entity.securityLabel

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its value and must be URL-encoded as %7C.

AuditEvents are written by the platform and are read-only to clients - there is no create or update path. Query the audit log with read and search.

Read by server id

GET [base]/AuditEvent/[id]

Search the audit log

GET [base]/AuditEvent?patient=Patient/[id]
GET [base]/AuditEvent?patient=Patient/[id]&date=ge2025-01-01
GET [base]/AuditEvent?agent=PractitionerRole/[id]
GET [base]/AuditEvent?patient=Patient/[id]&action=R
GET [base]/AuditEvent?patient=Patient/[id]&category=http://dicom.nema.org/resources/ontology/DCM%7C110112
GET [base]/AuditEvent?patient=Patient/[id]&entity=Condition/[id]
GET [base]/AuditEvent?patient=Patient/[id]&outcome=http://hl7.org/fhir/issue-severity%7Cerror

In FHIR R5 the event grouping is searched with category and the specific sub-type with code (R4's type / subtype). In this profile outcome.code is bound to the issue-severity value set, so a denied or failed access is searchable as error (or fatal) rather than success.

See the CapabilityStatement for the full list of supported search parameters.