Basic Audit Log Patterns (BALP)
1.1.0 - Trial-Implementation International flag

This page is part of the IHE Basic Audit Log Patterns (BALP) (v1.1.0: Trial Implementation) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Basic Audit Log Pattern (BALP)

Official URL: Version: 1.1.0
Active as of 2022-05-04 Computable Name: IHE_ITI_BALP

The Basic Audit Log Patterns (BALP) Implementation Guide is a Content Profile that defines some basic and reusable AuditEvent patterns. This includes basic audit log profiles for FHIR RESTful operations to be used when there is not a more specific audit event defined. A focus is enabling Privacy centric AuditEvent logs that hold well formed indication of the Patient when they are the subject of the activity being recorded in the log. Where a more specific audit event can be defined it should be derived off of these basic patterns.

Organization of This Guide

This guide is organized into four main sections:

  1. Volume 1: 52 BasicAudit Introduction
    1. 52.1 BasicAudit Actors and Content
    2. 52.2 BasicAudit Actor Options
    3. 52.3 BasicAudit Required Groupings
    4. 52.4 BasicAudit Overview
    5. 52.5 BasicAudit Security Considerations
    6. 52.6 BasicAudit Cross-Profile Considerations
  2. Volume 3: Content Section
    1. 5.7 Basic Audit Log Patterns
  3. Test Plan

  4. Changes to other Profiles

See also the table of contents and the index of artifacts defined as part of this implementation guide.

Conformance Expectations

IHE uses the normative words: Shall, Should, and May according to standards conventions.

Must Support

The use of mustSupport in StructureDefinition profiles equivalent to the IHE use of R2 as defined in Appendix Z.

mustSupport of true - only has a meaning on items that are minimal cardinality of zero (0), and applies only to the source actor populating the data. The source actor shall populate the elements marked with MustSupport, if the concept is supported by the actor, a value exists, and security and consent rules permit. The consuming actors should handle these elements being populated or being absent/empty. Note that sometimes mustSupport will appear on elements with a minimal cardinality greater than zero (0), this is due to inheritance from a less constrained profile.


You can also download:

The source code for this Implementation Guide can be found on IHE GitHub.