Notice: This guidance is under active development by NHS England and content may be added or updated on a regular basis.
Record Audit Event
Actors
Actor | Description |
---|---|
Audit Creator | The service creating the audit |
Audit Record Repository | Spine - The repository holding the centralised audit records |
Use Cases
For a background on the basic concepts see IHE Basic Audit Log Patterns (BALP)
Record Audit Event
The service using the FHIR API for spine auditing sends a FHIR AuditEvent to the Audit Record Repository.
See also IHE RESTful ATNA (Query and Feed)
POST https://auditrecordrepository.example.nhs.uk/FHIR/R4/AuditEvent
Event Payload Example
- AuditEvent-app-restricted-fhir-pds-read-Example
- AuditEvent-patient-flag-Example
- AuditEvent-patient-restricted-fhir-pds-update-Example
- AuditEvent-user-restricted-hl7v3-gpsummary-read-Example
Entity Mapping
Description | FHIR AuditEvent |
---|---|
Type of operation - Create Read Update Delete | action |
DateTime the event happened | recorded |
ODS code of the organisation | agent[organisation].identifier.value |
Name of the organisation | agent[organisation].display |
User identifier | agent[user].identifier.value |
User Name | agent[user].display |
ProductId or ASID of the service | agent[endpoint].who.identifier |
Role Profile ID of the user | agent[userRole].identifier.value |
Audit Creator Identifier code | source.observer.identifier.value |
Audit Creator system Identifier | source.site |
Audit Creator Name (the system which has generated the event) | source.observer.display |
Patient NHS number | entity[patient].what.identifier.value |
Transaction ID of the message | entity[transaction].what.identifier |
Human readable interactionID | entity[endpoint].name |
Spine Accredited System Id | entity[endpoint].what.identifier.value |
HL7V3 identifier, for FHIR there is no standard | entity[endpoint].detail[interactionIdentifier].valueString |
High level grouping of the message types | entity[endpoint].detail[productIdentifier].valueString |
ODS code of the organisation submitted in the message/headers | entity[submittedOrganisation].what.identifier.value |