ISiK Terminplanung Implementierungsleitfaden
Version 6.0.0-rc - ci-build

CapabilityStatement: ISiK CapabilityStatement Termin-Repository Rolle

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

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

Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (kind = requirements). Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, wird die CapabilityStatement-Expectation-Extension mit den möglichen Werten SHALL (=MUSS) und MAY (=KANN) verwendet.

Das vorliegende CapabilityStatement beschreibt Interaktionen für ein System, das Termin-Repository-Daten exponiert.

ISiK CapabilityStatement Termin-Repository Rolle

  • 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.

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 TypeProfileRSUPCSearches_include_revincludeOperations
ScheduleSupported Profiles
  ISiKKalender		YY_id, _tag, _count, _has, active, service-type, specialty, actorSlot:schedule, Schedule:actor
SlotSupported Profiles
  ISiKTerminblock		YY_id, _tag, _count, _has, schedule, status, startSlot:scheduleAppointment:slot
AppointmentSupported Profiles
  ISiKTermin		YYY_id, _tag, _count, _has, status, service-type, specialty, date, slot, actorAppointment:slot, Appointment:actor$book
HealthcareServiceSupported Profiles
  ISiKMedizinischeBehandlungseinheit		YY_id, _tag, _count, _has, active, service-type, specialty, nameSchedule:actor, Appointment:actor
Core FHIR Resource
Schedule
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKKalender

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.

SHALLactivetoken

Beispiel:
GET [base]/Schedule?active=true
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLservice-typetoken

Beispiel:
GET [base]/Schedule?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLspecialtytoken

Beispiel:
GET [base]/Schedule?specialty=http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen|ALLG
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLactorreference

Beispiel:
GET [base]/Schedule?actor=Practitioner/ISiKPractitionerExample
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
Slot
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKTerminblock

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.

SHALLschedulereference

Beispiel:
GET [base]/Slot?schedule=Schedule/ISiKKalenderExample&start=2022-12-10T09:00:00Z
GET [base]/Slot?schedule=Schedule/ISiKKalenderExample
Anwendungshinweis:
Der Suchparameter schedule MUSS in Kombination mit einem definierten Startzeitpunkt mittels Suchparameter start unterstützt werden. Der Suchparameter schedule KANN alleinstehend unterstützt werden. Beim Fehlen des start-Suchparameters SOLL der aktuelle Zeitpunkt des Servers als Startzeitpunkt per Default verwendet werden. In diesem Fall ist auch ein Chaining auf weitere verknüpfte Akteure möglich:
GET https://example.org/fhir/Slot?schedule.actor:HealthcareService.type=https://example.org/fhir/CodeSystem/Behandlungsleistung|CT
Dies kann notwendig sein, falls interdisziplinäre Kalender durch das Termin-Repository gepflegt werden (z.B. ein Kalender pro Station). In solchen Fälle wäre es sinnvoll, wenn das Termin-Repository einem Termin-Requestor eine Verknüpfung zwischen Kalender (Schedule) und Behandlungsleistung (HealthcareService) bereitstellen würde. Weitere Details siehe FHIR-Kernspezifikation.

SHALLstatustoken

Beispiel:
GET [base]/Slot?status=free&schedule=Schedule/ISiKTerminExample
GET [base]/Slot?status=free&schedule.actor:Practitioner.name=Musterarzt
Anwendungshinweis:
Der Suchparameter status MUSS in Kombination ('&') mit dem Parameter schedule unterstützt werden. Diese Abfrage KANN entweder eine direkte Angabe einer Referenz oder eine Angabe von weiteren Chaining-Parametern sein. Der Suchparameter MUSS NICHT alleinstehend unterstützt werden. Falls der Parameter nicht alleinstehend unterstützt wird, dann SOLL der Server einen Fehler-Code 422 (Unprocessable Entity) zurückgeben, falls ein Client den Parameter alleinstehend verwendet. Zudem SOLL eine OperationOutcome über die fehlende Kombination bei der Suchanfrage Auskunft geben. Weitere Details siehe FHIR-Kernspezifikation.

SHALLstartdate

Beispiel:
GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule=Schedule/ISiKTerminExample
GET [base]/Slot?start=2022-12-10T09:00:00Z&schedule.actor:Practitioner.name=Musterarzt
Anwendungshinweis:
Der Suchparameter start MUSS in Kombination ('&') mit dem Parameter schedule unterstützt werden. Diese Abfrage KANN entweder eine direkte Angabe einer Referenz oder eine Angabe von weiteren Chaining-Parametern sein. Der Suchparameter MUSS NICHT alleinstehend unterstützt werden. 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
Appointment
Reference Policy
Interaction summary
  • SHALL support read, search-type, patch.

Supported Profiles

ISiKTermin

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]/Appointment?status=booked
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLservice-typetoken

Beispiel:
GET [base]/Appointment?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT
Anwendungshinweis:
Anwendungshinweise: Bei einer Suche mit dem :not-Modifier MÜSSEN Ressourcen, die keinen Wert für Appointment.serviceType enthalten, im Suchergebnis enthalten sein. Weitere Details siehe FHIR-Kernspezifikation.

SHALLspecialtytoken

Beispiel:
GET [base]/Appointment?specialty=http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen|ALLG
Anwendungshinweis: Anwendungshinweise: Bei einer Suche mit dem :not-Modifier MÜSSEN Ressourcen, die keinen Wert für Appointment.specialty enthalten, im Suchergebnis enthalten sein. Weitere Details siehe FHIR-Kernspezifikation.

SHALLdatedate

Beispiel:
GET [base]/Appointment?date=2022-12-10T09:00:00Z
Anwendungshinweis: Die Suche wird gegen das Element Appointment.start ausgewertet.
Weitere Details siehe FHIR-Kernspezifikation.

SHALLslotreference

Beispiel:
GET [base]/Appointment?slot=Slot/ISiKSlotExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLactorreference

Beispiel:
GET [base]/Appointment?actor=Patient/ISiKPatientExample
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.

 
Extended Operations
ConformanceOperationDocumentation
SHALL$book

Die $book-Operation ermöglicht einem Termin-Requestor einen Termin in einem Termin-Repository zu buchen bzw. zu verschieben.

Core FHIR Resource
HealthcareService
Reference Policy
Interaction summary
  • SHALL support read, search-type.

Supported Profiles

ISiKMedizinischeBehandlungseinheit

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.

SHALLactivetoken

Beispiel:
GET [base]/HealthcareService?active=true
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLservice-typetoken

Beispiel:
GET [base]/HealthcareService?service-type=http://example.org/fhir/CodeSystem/ScheduleServiceType|CT
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLspecialtytoken

Beispiel:
GET [base]/HealthcareService?specialty=http://ihe-d.de/CodeSystems/AerztlicheFachrichtungen|ALLG
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALLnamestring

Beispiel:
GET [base]/HealthcareService?name=Medizinische Behandlungseinheit Des Fachbereichs 0100
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.