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

CapabilityStatement: HiraCapabilityStatement

Official URL: https://fhir-ig.digital.health.nz/auditevents/CapabilityStatement/HiraCapabilityStatement Version: 0.1.0
Draft as of 2024-04-18 Computable Name:

FHIR API for AuditEvents

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement HiraCapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: 2024-04-18
  • Published by: null

Note to Implementers: FHIR Capabilities

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.

SHALL Support the Following Implementation Guides

  • https://build.fhir.org/ig/tewhatuora/fhir-auditevents

FHIR RESTful Capabilities

Mode: server

Details the FHIR Server API for AuditEvents. This API allows for the creation, retrieval and searching of AuditEvent resources.

Security
Enable CORS: no
Security services supported: SMART-on-FHIR

Details security requirements are detailed at security.

Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the batchinteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AuditEventhttp://hl7.org/fhir/StructureDefinition/AuditEvent
Additional supported profiles:
  Hira Audit Event		yyypatient, correlationId

Resource Conformance: supported AuditEvent

Base System Profile
http://hl7.org/fhir/StructureDefinition/AuditEvent
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir-ig.digital.health.nz/auditevents/StructureDefinition/hira-audit-event

Interaction summary
  • Supports read, search-type, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Allows searching for AuditEvent resources by patient. e.g. [base]/AuditEvent?patient=https://api.hip.digital.health.nz/fhir/Patient/ZXP7823

SHALLcorrelationIdstring

Allows searching for AuditEvent resources by correlationId. e.g. [base]/AuditEvent?correlationId=123456. This is a custom parameter.