Audit Events Implementation Guide
0.1.0 - draft
Audit Events Implementation Guide
0.1.0 - draft
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
{
"resourceType" : "AuditEvent",
"meta" : {
"profile" : [
🔗 "https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/hira-audit-event"
]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: AuditEvent HiraAuditEventExampleUC4</b></p><a name=\"HiraAuditEventExampleUC4\"> </a><a name=\"hcHiraAuditEventExampleUC4\"> </a><a name=\"HiraAuditEventExampleUC4-en-US\"> </a><p><b>type</b>: <a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-audit-event-type.html#audit-event-type-rest\">Audit Event ID</a> rest: RESTful Operation</p><p><b>action</b>: Read/View/Print</p><p><b>recorded</b>: 2024-04-27 08:04:27+0000</p><p><b>outcome</b>: Success</p><p><b>outcomeDesc</b>: 200</p><p><b>purposeOfEvent</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-ActReason PUBHLTH}\">public health</span></p><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://standards.digital.health.nz/ns/hpi-person-id</code>/cpn-123</p><p><b>altId</b>: externalSystemId</p><p><b>name</b>: John Doe</p><p><b>requestor</b>: true</p><p><b>policy</b>: urn:uuid:1c7739fb-5099-4db9-a1f9-c928ee059640</p><h3>Networks</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Address</b></td></tr><tr><td style=\"display: none\">*</td><td>12.21.213.213</td></tr></table></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>: Te Whatu Ora (Identifier: <code>https://standards.digital.health.nz/ns/hpi-organisation-id</code>/org-123)</p><p><b>requestor</b>: false</p><p><b>location</b>: Christchurch Hospital Radiology Department (Identifier: <code>https://standards.digital.health.nz/ns/hpi-facility-id</code>/fac-123)</p></blockquote><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>: client_id123</p><p><b>name</b>: My Health Record</p><p><b>requestor</b>: false</p><h3>Networks</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Address</b></td></tr><tr><td style=\"display: none\">*</td><td>88.11.333.213</td></tr></table></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>HNZ API Gateway</td></tr></table><blockquote><p><b>entity</b></p><p><b>what</b>: <a href=\"https://fhir.digital.health.nz/fhir/R4/CarePlan\">https://fhir.digital.health.nz/fhir/R4/CarePlan</a></p><p><b>type</b>: <a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-audit-entity-type.html#audit-entity-type-2\">Audit event entity type</a> 2: System Object</p><p><b>securityLabel</b>: <a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-v3-Confidentiality.html#v3-Confidentiality-R\">Confidentiality</a> R: restricted</p><p><b>description</b>: Reading CarePlan</p><p><b>query</b>: <code>P3BhdGllbnQ9MTIzNA==</code></p><h3>Details</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Type</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>correlationId</td><td>c500dae6-ac65-4e4f-a4c1-5aa222a6a807</td></tr></table></blockquote><blockquote><p><b>entity</b></p><p><b>what</b>: Identifier: <code>https://standards.digital.health.nz/ns/nhi-id</code>/NHI123</p><p><b>role</b>: <a href=\"http://terminology.hl7.org/6.0.2/CodeSystem-object-role.html#object-role-1\">AuditEventEntityRole</a> 1: Patient</p></blockquote></div>"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-event-type",
"code" : "rest"
},
"action" : "R",
"recorded" : "2024-04-27T08:04:27.434+00:00",
"outcome" : "0",
"outcomeDesc" : "200",
"purposeOfEvent" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"code" : "PUBHLTH"
}
]
}
],
"agent" : [
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-person-id",
"value" : "cpn-123"
}
},
"altId" : "externalSystemId",
"name" : "John Doe",
"requestor" : true,
"policy" : [
"urn:uuid:1c7739fb-5099-4db9-a1f9-c928ee059640"
],
"network" : {
"address" : "12.21.213.213"
}
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-RoleClass",
"code" : "PROV"
}
]
}
],
"who" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-organisation-id",
"value" : "org-123"
},
"display" : "Te Whatu Ora"
},
"requestor" : false,
"location" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/hpi-facility-id",
"value" : "fac-123"
},
"display" : "Christchurch Hospital Radiology Department"
}
},
{
"role" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/extra-security-role-type",
"code" : "dataprocessor"
}
]
}
],
"who" : {
"display" : "client_id123"
},
"name" : "My Health Record",
"requestor" : false,
"network" : {
"address" : "88.11.333.213"
}
}
],
"source" : {
"observer" : {
"display" : "HNZ API Gateway"
}
},
"entity" : [
{
"what" : {
"reference" : "https://fhir.digital.health.nz/fhir/R4/CarePlan"
},
"type" : {
"system" : "http://terminology.hl7.org/CodeSystem/audit-entity-type",
"code" : "2"
},
"securityLabel" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code" : "R"
}
],
"description" : "Reading CarePlan",
"query" : "P3BhdGllbnQ9MTIzNA==",
"detail" : [
{
"type" : "correlationId",
"valueString" : "c500dae6-ac65-4e4f-a4c1-5aa222a6a807"
}
]
},
{
"what" : {
"identifier" : {
"system" : "https://standards.digital.health.nz/ns/nhi-id",
"value" : "NHI123"
}
},
"role" : {
"system" : "http://terminology.hl7.org/CodeSystem/object-role",
"code" : "1"
}
}
]
}