ISiK Dokumentenaustausch Implementierungsleitfaden
Version 6.0.0-rc - ci-build

CapabilityStatement: ISiK CapabilityStatement Dokumenten Server Akteur (Expanded)

Official URL: https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementDokumentenServerAkteur Version: 6.0.0-rc
Active as of 2025-12-17 Computable Name: ISiKCapabilityStatementDokumentenServerAkteurExpanded

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein System unterstützen MUSS, welches diesen Akteur implementiert.

Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine CapabilityStatement-Ressource bereitstellen. Hierzu MUSS die capabilities-Interaktion gemäß FHIR-Kernspezifikation unterstützt werden. Der MODE-Parameter kann ignoriert werden.
Das CapabilityStatement in dieser Spezifikation stellt die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Rollen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Imports-Expectation-Extension mit den möglichen Werten ‘SHALL’ (=MUSS) ‘SHOULD’ (=SOLL) ‘MAY’ (=KANN) ‘SHOULD-NOT’ (=SOLL NICHT) verwendet.

Eine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom kind = instance liefern und im Element software den Namen und die Versionsnummer angeben.
Darüber hinaus MÜSSEN in CapabilityStatement.instantiates sämtliche Canonical URLs der implementierten Rollen angegeben werden. Die mindestens zu implementierenden Profile für einen Akteur und Interaktionen entsprechen daher den aggregierten Anforderungen der einzelnen Rolle (per ‘imports’). In den CapabilityStatements zu den Rollen sind die Anforderungen tabellarisch gelistet und weisen so die zu implementierenden Profile aus.

Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement (bzw. der in ihm importierten Rollen - siehe ‘imports’) mit SHALL gekennzeichnet sind. Das CapabilityStatement KANN darüber hinaus die mit MAY gekennzeichneten Funktionalitäten, sowie weitere Funktionalitäten auflisten, sofern diese in der Instanz implementiert wurden.

Die Verwendung der CapabilityStatement-Expectation-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.

CapabilityStatement für den Akteur "ISiKCapabilityStatementDokumentenServerAkteur". Dieser Akteur aggregiert die Rollen zur Erzeugung und dem Abruf von Metadaten für Dokumente.

ISiK CapabilityStatement Dokumenten Server Akteur (Expanded)

  • Implementation Guide Version: 6.0.0-rc
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Published on: 2025-12-17
  • Published by: gematik GmbH

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://gematik.de/fhir/isik/ImplementationGuide/ISiK-Dokumentenaustausch

FHIR RESTful Capabilities

Mode: server

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
DocumentReferenceSupported Profiles
  Erforderliche Metadaten für Dokumentenaustausch in ISiK
YYY_id, _tag, _count, _has, status, identifier, patient, type, category, creation, encounterDocumentReference:patient, DocumentReference:encounter
BinarySupported Profiles
  ISiKBinary
Y

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support search-type
    create

    siehe {{pagelink:Dokumentenbereitstellung}}

    read

    siehe {{pagelink:Dokumentenabfrage}}

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Beispiel: GET [base]/[Resourcetype]?_id=103270 Anwendungshinweis: Der Parameter _id wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource anhand der id die READ-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden, um den Abruf einer Ressource bspw. mit einem _include weiterer Ressourcen zu verbinden, z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten: GET [base]/Encounter?_id=103270&_include=Encounter:patient Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources. Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.

SHALL_tagtoken

Beispiel: GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Parameters for all resources sowie Abschnitt Tags.

SHALL_countnumber

Beispiel: GET [base]/[Resourcetype]?_count=100 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Page Count.

SHALLstatustoken

Beispiel: GET [base]/DocumentReference?status=final Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.

SHALLidentifiertoken

Beispiel: GET [base]/DocumenReference?identifier=urn:oid:1.2.840.113556.1.8000.2554.58783.21864.3474.19410.44358.58254.41281.46340
**Anwendungshinweis: Durchsucht die Elemente DocumentReference.identifier und DocumentReference.masterIdentifier nach übereinstimmenden Dokumenten.

SHALLpatientreference

Beispiel: GET [base]/DocumentReference?patient=Patient/123 GET [base]/DocumentReference?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702 GET [base]/DocumentReference?patient.identifier=1032702 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Kernspezifikation - Abschnitt Chained Parameters. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend.

SHALLtypetoken

Beispiel: GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010101 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.

SHALLcategorytoken

Beispiel: GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystem/IHEXDSclassCode|BEF Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend.

SHALLcreationdate

Beispiel: GET [base]/DocumentReference?creation=2021-11-05 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation. Dieser Suchparameter ist Teil der IHE-MHD-Spezifikation und für die Umsetzung des IHE MHD Profils für Server verpflichtend.

SHALLencounterreference

Beispiel: GET [base]/DocumentReference?encounter=Encounter/123 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation.

MAY_hasstring

Beispiel: Suche nach allen Patienten, die eine Observation mit dem Code '1234-5' haben GET [base]/Patient?_has:Observation:patient:code=1234-5 Beispiel: Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde GET [base]/Encounter?_has:Condition:encounter:code=A12.3 Anwendungshinweis: Weitere Details siehe FHIR-Kernspezifikation, Abschnitt Reverse Chaining.

 
Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • SHALL support
    read

    Für die Ressource Binary MUSS die REST-Interaktion read implementiert werden. Es MÜSSEN die Regeln aus der FHIR-Kernspezifikation zur Abfrage einer Binary Ressource beachtet werden. Siehe Serving Binary Resources using the RESTful API.

    Um die Handhabung der base64-kodierten Binary-Ressourcen clientseitig zu erleichtern,
    MUSS ein bestätigungsrelevantes System (Server) bei READ-Interaktionen Accept-Header
    mit einem Wert außer den [FHIR-Mime-Types](https://www.hl7.org/fhir/R4/http.html#mime-type) unterstützen.
    Falls ein solcher Accept-Header durch einen Client verwendet wird, MUSS  bestätigungsrelevante System (Server)
    das Binary in seiner nativen Form (definiert durch Binary.contentType) zurückgeben.
    

Supported Profiles

ISiKBinary