Skip to main content

Audit Trails

LifeOmic FHIR Service optionally supports Audit Trails for monitoring changes made to FHIR resources for maintaining a security log. The Audit Trail is composed of FHIR Audit Events. Each Audit Event tracks who, what, when, where, and why the corresponding FHIR resource was changed.

Audit Events are produced when a user, or the LifeOmic Platform, creates, edits, or deletes a FHIR resource. Each Audit Event references the versioned FHIR resource that was manipulated.

When Audit Trails are enabled, FHIR resources are given a unique version identifier. A new version identifier is attributed every time the resource is manipulated. See the versioning documentation for more information.

Example​

The following Audit Event tracks an update made to a FHIR Patient resource.

{
    "resourceType": "AuditEvent",
    "meta": {
        "tag": [
            {
                "system": "http://lifeomic.com/fhir/dataset",
                "code": "ec41bb27-4601-4c3e-99e1-af66b0233586"
            }
        ],
        "lastUpdated": "2020-06-22T13:52:39.713Z",
        "versionId": "1592833960"
    },
    "type": {
        "system": "http://terminology.hl7.org/CodeSystem/audit-event-type",
        "code": "rest",
        "display": "Restful Operation"
    },
    "subtype": [
        {
            "system": "http://hl7.org/fhir/restful-interaction",
            "code": "update",
            "display": "update"
        }
    ],
    "action": "U",
    "recorded": "2020-06-22T13:52:39.710Z",
    "agent": [
        {
            "requestor": true,
            "userId": {
                "value": "john.doe"
            },
            "network": {
                "address": "0.0.0.0",
                "type": "2"
            }
        }
    ],
    "source": {
        "site": "Cloud",
        "identifier": {
            "value": "fhir.us.lifeomic.com"
        },
        "type": [
            {
                "system": "http://hl7.org/fhir/security-source-type",
                "code": "3",
                "display": "Web Server"
            }
        ]
    },
    "entity": [
        {
            "reference": {
                "reference": "Patient/8d5db8df-27a0-4fd0-83ce-fc0b2e40a4d8/_history/1592240287"
            },
            "lifecycle": {
                "system": "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle",
                "code": "2",
                "display": "Import / Copy"
            }
        },
        {
            "reference": {
                "reference": "Patient/8d5db8df-27a0-4fd0-83ce-fc0b2e40a4d8/_history/1592833960"
            },
            "lifecycle": {
                "system": "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle",
                "code": "3",
                "display": "Amendment"
            }
        }
    ],
    "id": "62a2f094-1619-48d2-a158-f7542f21a91e"
}