FHIR © HL7.org  |  FHIRsmith 0.18.0  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagech.fhir.ig.ch-health-dossier
Resource TypeCapabilityStatement
IdCapabilityStatement-CH.ATC.PatientAuditConsumer.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/ehealthsuisse/ch-health-dossier/CapabilityStatement-CH.ATC.PatientAuditConsumer.html
URLhttp://fhir.ch/ig/ch-health-dossier/CapabilityStatement/CH.ATC.PatientAuditConsumer
Version1.0.0-preview
Statusactive
Date2026-10-22
NameCH_ATC_PatientAuditConsumer
TitleCH:ATC Patient Audit Consumer (client)
Realmch
Authorityhl7
DescriptionDefines the CapabilityStatement for the Patient Audit Consumer actor of ITI-81.
CopyrightCC0-1.0
Kindrequirements

Resources that use this resource

CapabilityStatement
ch.fhir.ig.ch-health-dossier#currentCH.HealthDossier.AppHealth App (client)

Resources that this resource uses

StructureDefinition
ch.fhir.ig.ch-health-dossier#currentChAuditTrailEventCH Audit Trail Event

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement CH.ATC.PatientAuditConsumer

CH:ATC Patient Audit Consumer (client)

  • Implementation Guide Version: 1.0.0-preview
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Published on: 2026-10-22
  • Published by: eHealth Suisse

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.

FHIR RESTful Capabilities

Mode: client

The Patient Audit Consumer initiates the Retrieve ATNA Audit Event [ITI-81] transaction with the Retrieve Audit Message Option to retrieve the audit trail of a health dossier from the Patient Audit Record Service.

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
AuditEventSupported Profiles
  CH Audit Trail Event
ydate, agent.identifier, entity.identifier, entity-type, entity-role, subtype

Resource Conformance: unspecified AuditEvent

Core FHIR Resource
AuditEvent
Reference Policy
Interaction summary
  • Supports
    search-type

    ITI-81

Supported Profiles

CH Audit Trail Event

Documentation

For Retrieve ATNA Audit Event [ITI-81]. The Patient Audit Consumer MAY use the _sort result parameter on date; when it relies on a specific order of the audit events, it SHALL request it with _sort.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLagent.identifiertoken
SHALLentity.identifiertoken

SHALL be included in every query and SHALL carry the EPR-SPID of the holder.

SHALLentity-typetoken
SHALLentity-roletoken
SHALLsubtypetoken
 

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "CH.ATC.PatientAuditConsumer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-health-dossier/CapabilityStatement/CH.ATC.PatientAuditConsumer",
  "version": "1.0.0-preview",
  "name": "CH_ATC_PatientAuditConsumer",
  "title": "CH:ATC Patient Audit Consumer (client)",
  "status": "active",
  "date": "2026-10-22",
  "publisher": "eHealth Suisse",
  "contact": [
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch"
        }
      ]
    },
    {
      "name": "eHealth Suisse",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.e-health-suisse.ch",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Defines the CapabilityStatement for the Patient Audit Consumer actor of ITI-81.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CH"
        }
      ]
    }
  ],
  "copyright": "CC0-1.0",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "The Patient Audit Consumer initiates the Retrieve ATNA Audit Event [ITI-81] transaction with the Retrieve Audit Message Option to retrieve the audit trail of a health dossier from the Patient Audit Record Service.",
      "resource": [
        {
          "type": "AuditEvent",
          "supportedProfile": [
            "http://fhir.ch/ig/ch-health-dossier/StructureDefinition/ChAuditTrailEvent"
          ],
          "documentation": "For Retrieve ATNA Audit Event [ITI-81]. The Patient Audit Consumer MAY use the _sort result parameter on date; when it relies on a specific order of the audit events, it SHALL request it with _sort.",
          "interaction": [
            {
              "code": "search-type",
              "documentation": "ITI-81"
            }
          ],
          "searchParam": [
            {
              "name": "date",
              "type": "date"
            },
            {
              "name": "agent.identifier",
              "type": "token"
            },
            {
              "name": "entity.identifier",
              "type": "token",
              "documentation": "SHALL be included in every query and SHALL carry the EPR-SPID of the holder."
            },
            {
              "name": "entity-type",
              "type": "token"
            },
            {
              "name": "entity-role",
              "type": "token"
            },
            {
              "name": "subtype",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}