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: Basic AuditEvent for a successful Update

Official URL: https://profiles.ihe.net/ITI/BALP/StructureDefinition/IHE.BasicAudit.Update Version: 1.1.3
Active as of 2024-02-14 Computable Name: Update

A basic AuditEvent profile for when a RESTful Update action happens successfully.

  • Given a Resource Update is requested
  • And that resource does not have a Patient subject or is otherwise associated with a Patient
    • when the resource is Patient specific then PatientUpdate is used
  • And the request is authorized
  • When successful
    • Note a failure AuditEvent may follow this pattern, but would not be a successful outcome and should have an OperationOutcome
  • Then the AuditEvent recorded will conform
  • And where the server supports FHIR Versioning the AuditEvent should use the version specific id

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..*AuditEventEvent record kept for security purposes
... type 1..1CodingType/identifier of event
Required Pattern: At least the following
.... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
.... code1..1codeSymbol in syntax defined by the system
Fixed Value: rest
... Slices for subtype 1..*CodingMore specific type/id for the event
Slice: Unordered, Open by value:$this
.... subtype:anyUpdate 1..1CodingMore specific type/id for the event
Binding: all Updates (required)
... action 0..1codeType of action performed during the event
Required Pattern: U
... outcome 1..1codeWhether the event succeeded or failed
Required Pattern: 0
... Slices for agent 2..*BackboneElementActor involved in the event
Slice: Unordered, Open by pattern:type
.... agent:client 1..1BackboneElementActor involved in the event
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 110153
..... who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... media 0..0
..... network 1..1BackboneElementLogical network location for application activity
.... agent:server 1..1BackboneElementActor involved in the event
..... type 1..1CodeableConceptHow agent participated
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://dicom.nema.org/resources/ontology/DCM
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 110152
..... who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... media 0..0
..... network 1..1BackboneElementLogical network location for application activity
.... agent:user 0..1BackboneElementActor involved in the event
..... type 0..1CodeableConceptHow agent participated
Binding: participant source types for RESTful create (required)
..... role S0..*CodeableConceptAgent role in the event
..... who 1..1Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)Identifier of who
..... name S0..1stringHuman friendly name for the agent
..... requestor 1..1booleanWhether user is initiator
Required Pattern: true
..... media 0..0
..... network 0..0
..... purposeOfUse S0..*CodeableConceptReason given for this user
... source S1..1BackboneElementAudit Event Reporter
... Slices for entity 1..*BackboneElementData or objects used
Slice: Unordered, Open by pattern:type
.... entity:transaction 0..1BackboneElementData or objects used
..... what
...... identifier
....... value 1..1stringthe value of X-Request-Id
..... type 1..1CodingType of entity involved
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: https://profiles.ihe.net/ITI/BALP/CodeSystem/BasicAuditEntityType
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: XrequestId
.... entity:data 1..1BackboneElementData or objects used
..... what 1..1Reference(Resource)Specific instance of resource
..... type 1..1CodingType of entity involved
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/audit-entity-type
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 2
..... role 1..1CodingWhat role the entity played
Binding: RESTful objects role in the event (required)
..... securityLabel 0..*Codingmay contain the security labels on the resource returned

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.subtype:anyUpdaterequiredAllUpdateVS
https://profiles.ihe.net/ITI/BALP/ValueSet/AllUpdateVS
from this IG
AuditEvent.agent:user.typerequiredDataSources
https://profiles.ihe.net/ITI/BALP/ValueSet/DataSources
from this IG
AuditEvent.entity:data.rolerequiredRestObjectRoles
https://profiles.ihe.net/ITI/BALP/ValueSet/RestObjectRoles
from this IG

 

Other representations of profile: CSV, Excel, Schematron