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

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

Resource Profile: OAUTHaccessTokenUseComprehensive - Detailed Descriptions

Active as of 2024-02-14

Definitions for the IHE.BasicAudit.OAUTHaccessTokenUse.Comprehensive resource profile.

Guidance on how to interpret the contents of this table can be found here

0. AuditEvent
2. AuditEvent.agent
SlicingThis element introduces a set of slices on AuditEvent.agent. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • pattern @ type
4. AuditEvent.agent:oClient
Slice NameoClient
Control1..1
6. AuditEvent.agent:oClient.type
Control1..?
Pattern Value{
  "coding" : [{
    "system" : "http://dicom.nema.org/resources/ontology/DCM",
    "code" : "110150"
  }]
}
8. AuditEvent.agent:oClient.who
Shortclient identifier
Comments

May be an Device Resource, but more likely an identifier given the App identified in the OAuth token

Control1..?
10. AuditEvent.agent:oClient.who.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
12. AuditEvent.agent:oClient.who.identifier.value
ShortToken client ID (client_id)
Control1..?
14. AuditEvent.agent:oClient.media
Control0..0
16. AuditEvent.agent:oClient.network
ShortThe client as known by TCP connection information
Must Supporttrue
18. AuditEvent.agent:oUser
Slice NameoUser
Control0..1
20. AuditEvent.agent:oUser.type
Control1..?
Pattern Value{
  "coding" : [{
    "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
    "code" : "IRCP"
  }]
}
22. AuditEvent.agent:oUser.role
Comments

if the OAuth token includes any roles, they are recorded here

Must Supporttrue
24. AuditEvent.agent:oUser.who
ShortMay be a Resource, but likely just an identifier from the OAuth token
Control1..?
26. AuditEvent.agent:oUser.who.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
28. AuditEvent.agent:oUser.who.identifier.system
ShortToken Issuer (TOKEN_ISSUER)
Must Supporttrue
30. AuditEvent.agent:oUser.who.identifier.value
ShortUser ID (USER_ID)
Must Supporttrue
32. AuditEvent.agent:oUser.who.display
ShortUser Name (USER_NAME)
Must Supporttrue
34. AuditEvent.agent:oUser.name
ShortUser Name (USER_NAME)
Comments

This is more searchable than .who.display

Must Supporttrue
36. AuditEvent.agent:oUser.requestor
Pattern Valuetrue
38. AuditEvent.agent:oUser.policy
Shortjti (JWT ID)
Control1..1
40. AuditEvent.agent:oUser.media
Control0..0
42. AuditEvent.agent:oUser.network
Control0..0
44. AuditEvent.agent:oUser.purposeOfUse
Comments

if the OAuth token includes a PurposeOfUse it is recorded here

Must Supporttrue