Audit Events Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• JSON

: Selected clinical access - JSON Representation

Raw json | Download

{
  "resourceType" : "AuditEvent",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: AuditEvent verification-sample-access-1</b></p><a name=\"verification-sample-access-1\"> </a><a name=\"hcverification-sample-access-1\"> </a><p><b>type</b>: <a href=\"http://terminology.hl7.org/7.5.0/CodeSystem-audit-event-type.html#audit-event-type-rest\">Audit Event ID: rest</a> (RESTful Operation)</p><p><b>action</b>: Read/View/Print</p><p><b>recorded</b>: 2026-08-05 10:15:00+1200</p><blockquote><p><b>agent</b></p><p><b>role</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/extra-security-role-type dataprocessor}\">Data Processor</span></p><p><b>who</b>: Identifier: <code>https://example.org/clients</code>/example-client</p><p><b>requestor</b>: false</p></blockquote><blockquote><p><b>agent</b></p><p><b>role</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-RoleClass PROV}\">healthcare provider</span></p><p><b>who</b>: Identifier: <code>https://example.org/clinicians</code>/clinician-123</p><p><b>requestor</b>: true</p></blockquote><h3>Sources</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Observer</b></td></tr><tr><td style=\"display: none\">*</td><td>Identifier: <code>https://example.org/systems</code>/audit-producer</td></tr></table><blockquote><p><b>entity</b></p><p><b>what</b>: Identifier: <code>https://example.org/patients</code>/patient-456</p><p><b>role</b>: <a href=\"http://terminology.hl7.org/7.5.0/CodeSystem-object-role.html#object-role-1\">AuditEventEntityRole: 1</a> (Patient)</p></blockquote><blockquote><p><b>entity</b></p><p><b>what</b>: <a href=\"https://api.example.org/s2s/Patient/patient-456\">https://api.example.org/s2s/Patient/patient-456</a></p><p><b>type</b>: <a href=\"http://terminology.hl7.org/7.5.0/CodeSystem-audit-entity-type.html#audit-entity-type-2\">Audit event entity type: 2</a> (System Object)</p></blockquote></div>"
  },
  "type" : {
    "system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
    "code" : "rest"
  },
  "action" : "R",
  "recorded" : "2026-08-05T10:15:00+12:00",
  "agent" : [
    {
      "role" : [
        {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
              "code" : "dataprocessor"
            }
          ]
        }
      ],
      "who" : {
        "identifier" : {
          "system" : "https://example.org/clients",
          "value" : "example-client"
        }
      },
      "requestor" : false
    },
    {
      "role" : [
        {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
              "code" : "PROV"
            }
          ]
        }
      ],
      "who" : {
        "identifier" : {
          "system" : "https://example.org/clinicians",
          "value" : "clinician-123"
        }
      },
      "requestor" : true
    }
  ],
  "source" : {
    "observer" : {
      "identifier" : {
        "system" : "https://example.org/systems",
        "value" : "audit-producer"
      }
    }
  },
  "entity" : [
    {
      "what" : {
        "identifier" : {
          "system" : "https://example.org/patients",
          "value" : "patient-456"
        }
      },
      "role" : {
        "system" : "http://terminology.hl7.org/CodeSystem/object-role",
        "code" : "1"
      }
    },
    {
      "what" : {
        "reference" : "https://api.example.org/s2s/Patient/patient-456"
      },
      "type" : {
        "system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
        "code" : "2"
      }
    }
  ]
}