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
| Draft as of 2024-04-18 |
{
"resourceType" : "CapabilityStatement",
"id" : "HiraCapabilityStatement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement HiraCapabilityStatement</b></p><a name=\"HiraCapabilityStatement\"> </a><a name=\"hcHiraCapabilityStatement\"> </a><a name=\"HiraCapabilityStatement-en-US\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 0.1.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-18 </li><li>Published by: null </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>https://build.fhir.org/ig/tewhatuora/fhir-auditevents</li></ul><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div><p>Details the FHIR Server API for AuditEvents. This API allows for the creation, retrieval and searching of AuditEvent resources.</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>Details security requirements are detailed at <a href=\"./security.html\">security</a>.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li><li>Supports the <code>batch</code>interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AuditEvent1-1\">AuditEvent</a></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html\">http://hl7.org/fhir/StructureDefinition/AuditEvent</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-hira-audit-event.html\">Hira Audit Event</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td>patient, correlationId</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"AuditEvent1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>AuditEvent</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/auditevent.html\">http://hl7.org/fhir/StructureDefinition/AuditEvent</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-hira-audit-event.html\">https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/hira-audit-event</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>, <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows searching for AuditEvent resources by patient. e.g. [base]/AuditEvent?patient=https://api.hip.digital.health.nz/fhir/Patient/ZXP7823</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"SearchParameter-AuditEventCorrelationIdSearchParameter.html\">correlationId</a></td><td><code>string</code></td><td><div><p>Allows searching for AuditEvent resources by correlationId. e.g. [base]/AuditEvent?correlationId=123456. This is a custom parameter.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "https://fhir-ig.digital.health.nz/auditevents/CapabilityStatement/HiraCapabilityStatement",
"version" : "0.1.0",
"status" : "draft",
"date" : "2024-04-18",
"description" : "FHIR API for AuditEvents",
"kind" : "instance",
"implementation" : {
"description" : "Audit Events API",
"url" : "https://auditevents.digital.health.nz/fhir/R4"
},
"fhirVersion" : "4.0.1",
"format" : [
"json"
],
"implementationGuide" : [
"https://build.fhir.org/ig/tewhatuora/fhir-auditevents"
],
"rest" : [
{
"mode" : "server",
"documentation" : "Details the FHIR Server API for AuditEvents. This API allows for the creation, retrieval and searching of AuditEvent resources.",
"security" : {
"extension" : [
{
"extension" : [
{
"url" : "token",
"valueUri" : "https://ppd.auth.services.health.nz/realms/hnz-integration/protocol/openid-connect/token"
}
],
"url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
}
],
"cors" : false,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "Details security requirements are detailed at [security](./security.html)."
},
"resource" : [
{
"type" : "AuditEvent",
"profile" : "http://hl7.org/fhir/StructureDefinition/AuditEvent",
"supportedProfile" : [
🔗 "https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/hira-audit-event"
],
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
},
{
"code" : "create"
}
],
"versioning" : "versioned",
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/AuditEvent-patient",
"type" : "reference",
"documentation" : "Allows searching for AuditEvent resources by patient. e.g. [base]/AuditEvent?patient=https://api.hip.digital.health.nz/fhir/Patient/ZXP7823"
},
{
"name" : "correlationId",
"definition" : "https://fhir-ig.digital.health.nz/auditevents/SearchParameter/AuditEventCorrelationIdSearchParameter",
"type" : "string",
"documentation" : "Allows searching for AuditEvent resources by correlationId. e.g. [base]/AuditEvent?correlationId=123456. This is a custom parameter."
}
]
}
],
"interaction" : [
{
"code" : "transaction"
},
{
"code" : "batch"
}
]
}
]
}