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
| Active as of 2026-10-27 |
{
"resourceType" : "OperationDefinition",
"id" : "verification-sample",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition verification-sample</b></p><a name=\"verification-sample\"> </a><a name=\"hcverification-sample\"> </a><p>URL: [base]/AuditEvent/$verification-sample</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>clientId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>Exact source application client identifier; non-blank and at most 256 characters.</p>\n</div></td></tr><tr><td>IN</td><td>serviceBaseUrl</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Absolute HTTP(S) service base URL without credentials, query or fragment; at most 256 characters. Matches the exact base or a path below it.</p>\n</div></td></tr><tr><td>IN</td><td>startDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Inclusive full timestamp with timezone and at most millisecond precision.</p>\n</div></td></tr><tr><td>IN</td><td>endDate</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>Exclusive full timestamp with timezone and at most millisecond precision.</p>\n</div></td></tr><tr><td>IN</td><td>percentage</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#decimal\">decimal</a></td><td/><td><div><p>Fraction greater than zero and at most one; rounded up once across all unique groups.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td/></tr></table></div>"
},
"url" : "https://fhir-ig.digital.health.nz/auditevents/OperationDefinition/verification-sample",
"version" : "0.1.0",
"name" : "VerificationSample",
"title" : "Verification sample",
"status" : "active",
"kind" : "operation",
"date" : "2026-10-27T00:04:10+00:00",
"description" : "Deterministic global percentage sample of unique clinical accesses for an authorized client, service base URL and period.",
"affectsState" : false,
"code" : "verification-sample",
"resource" : [
"AuditEvent"
],
"system" : false,
"type" : true,
"instance" : false,
"parameter" : [
{
"name" : "clientId",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Exact source application client identifier; non-blank and at most 256 characters.",
"type" : "string"
},
{
"name" : "serviceBaseUrl",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Absolute HTTP(S) service base URL without credentials, query or fragment; at most 256 characters. Matches the exact base or a path below it.",
"type" : "uri"
},
{
"name" : "startDate",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Inclusive full timestamp with timezone and at most millisecond precision.",
"type" : "dateTime"
},
{
"name" : "endDate",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Exclusive full timestamp with timezone and at most millisecond precision.",
"type" : "dateTime"
},
{
"name" : "percentage",
"use" : "in",
"min" : 1,
"max" : "1",
"documentation" : "Fraction greater than zero and at most one; rounded up once across all unique groups.",
"type" : "decimal"
},
{
"name" : "return",
"use" : "out",
"min" : 1,
"max" : "1",
"type" : "Bundle"
}
]
}