Basic Audit Log Patterns (BALP)
1.1.4-current - ci-build International flag

Basic Audit Log Patterns (BALP), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.1.4-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.BasicAudit/ and changes regularly. See the Directory of published versions

CapabilityStatement: IHE BALP Audit Creator

Official URL: https://profiles.ihe.net/ITI/BALP/CapabilityStatement/IHE.BALP.AuditCreator Version: 1.1.4-current
Active as of 2022-10-28 Computable Name: IHE_BALP_AuditCreator

CapabilityStatement for Audit Creator Actor in BALP.

This Actor is derived off of the ATNA Secure Application or Secure Node actor with ATNA ATX:FHIR Feed Option using ITI-20.

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement IHE.BALP.AuditCreator

IHE BALP Audit Creator

  • Implementation Guide Version: 1.1.4-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-10-28
  • Published by: IHE IT Infrastructure Technical Committee

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

BALP Audit Creator will CREATE AuditEvent resources, and send them to the Audit Record Repository with ATNA ATX:FHIR Feed Option using ITI-20 FHIR support.

Security

ATNA required, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AuditEventSupported Profiles
  Basic AuditEvent for a successful Create not related to a Patient
  Basic AuditEvent for a successful Read
  Basic AuditEvent for a successful Update
  Basic AuditEvent for a successful Delete
  Basic AuditEvent for a successful Query
  Basic AuditEvent for a successful Create with known Patient subject
  Basic AuditEvent for a successful Read with a Patient
  Basic AuditEvent for a successful Update with a Patient subject
  Basic AuditEvent for a successful Delete with Patient
  Basic AuditEvent for a successful Query with Patient
  IHE IUA ITI-71 AuditEvent for a successful Get Access Token
  Basic AuditEvent pattern for when an activity was authorized by an IUA access token
  Basic AuditEvent pattern for oAuth Opaque
  Basic AuditEvent pattern for oAuth Opaque
  Basic AuditEvent pattern for when an activity was authorized by an SAML access token Comprehensive
  Basic AuditEvent pattern for when an activity was authorized by an SAML access token Minimal
  Basic AuditEvent pattern for when an Authorization permit is decided
  Audit Event for a Privacy Disclosure as recorded by a Recipient
  Audit Event for Privacy Disclosure at Source		y

Resource Conformance: supported AuditEvent

Core FHIR Resource
AuditEvent
Reference Policy
Interaction summary
  • Supports create.

Supported Profiles

Basic AuditEvent for a successful Create not related to a Patient
Basic AuditEvent for a successful Read
Basic AuditEvent for a successful Update
Basic AuditEvent for a successful Delete
Basic AuditEvent for a successful Query
Basic AuditEvent for a successful Create with known Patient subject
Basic AuditEvent for a successful Read with a Patient
Basic AuditEvent for a successful Update with a Patient subject
Basic AuditEvent for a successful Delete with Patient
Basic AuditEvent for a successful Query with Patient
IHE IUA ITI-71 AuditEvent for a successful Get Access Token
Basic AuditEvent pattern for when an activity was authorized by an IUA access token
Basic AuditEvent pattern for oAuth Opaque
Basic AuditEvent pattern for oAuth Opaque
Basic AuditEvent pattern for when an activity was authorized by an SAML access token Comprehensive
Basic AuditEvent pattern for when an activity was authorized by an SAML access token Minimal
Basic AuditEvent pattern for when an Authorization permit is decided
Audit Event for a Privacy Disclosure as recorded by a Recipient
Audit Event for Privacy Disclosure at Source

Documentation

For ATNA Record Audit Event [ITI-20] using FHIR. . Note that all BALP Content profiles are listed here.