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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

HiraCapabilityStatement

FHIR API for AuditEvents

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

AuditEventCorrelationIdSearchParameter

A search parameter for finding AuditEvents by their correlation ID.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Hira Audit Event

Constrains the AuditEvent resource to represent Data Access through the Hira Connector Plane

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

AuditEvent.Agent additional details

This extension stores detailed information about the agent

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

NZ purpose of use

Reason for performing one or more operations on information, which may be permitted by source system’s security policy in accordance with one or more privacy policies and consent directives. Usage Notes: The rationale or purpose for an act relating to the management of personal health information, such as collecting personal health information for research or public health purposes.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

NZ Purpose Of Use

Additional codes to be incorporated with HL7 v3 Value Set Purpose of Use

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example profile instance UC1

Example Hira Audit Event for UC1: Member of the public (patient) accesses their own health record (Successful Request)

Example profile instance UC1

Example Hira Audit Event for UC1: Member of the public (patient) accesses their own health record (Server Error Response)

Example profile instance UC1

Example Hira Audit Event for UC1: Member of the public (patient) accesses their own health record (POST Search example)

Example profile instance UC2

Example Hira Audit Event for UC2: Member of the public accesses their child’s record

Example profile instance UC3

Example Hira Audit Event for UC3: Member of the public accesses another member of the public (patient’s) health

Example profile instance UC4

Example Hira Audit Event for UC4: Member of the health workforce accesses a patient’s health record