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

Resource Profile: Update - Detailed Descriptions

Active as of 2024-11-14

Definitions for the IHE.BasicAudit.Update resource profile.

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

0. AuditEvent
2. AuditEvent.type
Pattern Value{
  "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
  "code" : "rest"
}
4. AuditEvent.subtype
Control1..?
SlicingThis element introduces a set of slices on AuditEvent.subtype. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
  • 6. AuditEvent.subtype:anyUpdate
    Slice NameanyUpdate
    Control1..1
    BindingThe codes SHALL be taken from all Updates
    (required to https://profiles.ihe.net/ITI/BALP/ValueSet/AllUpdateVS)
    8. AuditEvent.action
    Pattern ValueU
    10. AuditEvent.outcome
    Control1..?
    Pattern Value0
    12. AuditEvent.agent
    Control2..?
    SlicingThis element introduces a set of slices on AuditEvent.agent. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ type
    • 14. AuditEvent.agent:client
      Slice Nameclient
      Control1..1
      16. AuditEvent.agent:client.type
      Control1..?
      Pattern Value{
        "coding" : [{
          "system" : "http://dicom.nema.org/resources/ontology/DCM",
          "code" : "110153"
        }]
      }
      18. AuditEvent.agent:client.who
      Control1..?
      20. AuditEvent.agent:client.media
      Control0..0
      22. AuditEvent.agent:client.network
      Control1..?
      24. AuditEvent.agent:server
      Slice Nameserver
      Control1..1
      26. AuditEvent.agent:server.type
      Control1..?
      Pattern Value{
        "coding" : [{
          "system" : "http://dicom.nema.org/resources/ontology/DCM",
          "code" : "110152"
        }]
      }
      28. AuditEvent.agent:server.who
      Control1..?
      30. AuditEvent.agent:server.media
      Control0..0
      32. AuditEvent.agent:server.network
      Control1..?
      34. AuditEvent.agent:user
      Slice Nameuser
      Control0..1
      36. AuditEvent.agent:user.type
      BindingThe codes SHALL be taken from participant source types for RESTful create
      (required to https://profiles.ihe.net/ITI/BALP/ValueSet/DataSources)
      38. AuditEvent.agent:user.role
      Must Supporttrue
      40. AuditEvent.agent:user.who
      Control1..?
      42. AuditEvent.agent:user.name
      Must Supporttrue
      44. AuditEvent.agent:user.requestor
      Pattern Valuetrue
      46. AuditEvent.agent:user.media
      Control0..0
      48. AuditEvent.agent:user.network
      Control0..0
      50. AuditEvent.agent:user.purposeOfUse
      Must Supporttrue
      52. AuditEvent.source
      Must Supporttrue
      54. AuditEvent.entity
      Control1..?
      SlicingThis element introduces a set of slices on AuditEvent.entity. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ type
      • 56. AuditEvent.entity:transaction
        Slice Nametransaction
        Control0..1
        58. AuditEvent.entity:transaction.what
        60. AuditEvent.entity:transaction.what.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        62. AuditEvent.entity:transaction.what.identifier.value
        Shortthe value of X-Request-Id
        Control1..?
        64. AuditEvent.entity:transaction.type
        Control1..?
        Pattern Value{
          "system" : "https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType",
          "code" : "XrequestId"
        }
        66. AuditEvent.entity:data
        Slice Namedata
        Control1..1
        68. AuditEvent.entity:data.what
        Control1..?
        70. AuditEvent.entity:data.type
        Control1..?
        Pattern Value{
          "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
          "code" : "2"
        }
        72. AuditEvent.entity:data.role
        Control1..?
        BindingThe codes SHALL be taken from RESTful objects role in the event
        (required to https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles)
        74. AuditEvent.entity:data.securityLabel
        Shortmay contain the security labels on the resource returned