This page is part of the IHE Basic Audit Log Patterns (BALP) (v1.1.1: Trial Implementation) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Basic Audit Log Patterns (BALP)

Official URL: https://profiles.ihe.net/ITI/BALP/ImplementationGuide/ihe.iti.balp				Version: 1.1.1
Active as of 2022-10-21				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 on 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: Profiles
   1. 52 BasicAudit Introduction
   2. 52.1 BasicAudit Actors and Content
   3. 52.2 BasicAudit Actor Options
   4. 52.3 BasicAudit Required Groupings
   5. 52.4 BasicAudit Overview
   6. 52.5 BasicAudit Security Considerations
   7. 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 documents

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.

Download

You can also download:

• this entire guide
• the definition resources in json, xml, ttl, or csv format, or
• the example resources in json, xml or ttl format.

The source code for this Implementation Guide can be found on IHE GitHub https://github.com/IHE/ITI.BasicAudit.

Cross Version Analysis

This is an R4 IG. None of the features it uses are changed from R4B, so it can be used as is with R4B systems. Packages for both R4 (ihe.iti.balp.r4) and R4B (ihe.iti.balp.r4b) are available.

Dependency Table

Globals Table

No Global profiles found

IP Statements

• This publication includes IP from Audit Event ID. These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association.
• This publication includes IP from Iso_21089_2017_Health_Record_Lifecycle_Events. These codes are excerpted from ISO Standard, TS 21089-2017 - Health Informatics - Trusted End-to-End Information Flows, Copyright by ISO International. Copies of this standard are available through the ISO Web Site at www.iso.org.
• This publication includes IP from DICOM Controlled Terminology Definitions. These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association.
• This publication includes IP from SNOMED Clinical Terms® (SNOMED CT®). This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact http://www.snomed.org/snomed-ct/get-snomed-ct or info@snomed.org.
• This publication includes IP from LOINC. This material contains content from LOINC. LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc.
• This publication includes IP from identifierType. Copyright HL7. Licensed under creative commons public domain