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

ValueSet: Agent types holding User-Agent

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

AuditEvent.agent.type values holding OAuth/SAML identified user. Note that user is not just users, but representes the higest agent responsible for triggering the activity being recorded in the AuditEvent.

Often this agent also has a type coding that is more specific to the transaction and the direction of the transaction.

  • // use for query/retrieve
  • // use for push/create/update
  • // use when the user is the patient
  • “Author” // used with create/update
  • “Informant” // used with export
  • “Custodian” // used with export


This value set is not used here; it may be used elsewhere (e.g. specifications and/or implementations that use this content)

Logical Definition (CLD)

This value set includes codes based on the following rules:



This value set contains 4 concepts

  UserSamlAgent SAML Agent participant
  UserOauthAgent OAuth Agent participant
  AuthzOauthService Authorization Server
  homeCommunityIdurn:ihe:iti:xca:2010IHE homeCommunityId

Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
System The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance)
Display The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code