Konformitätserklärung (CapabilityStatement)

Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine CapabilityStatement-Ressource bereitstellen.

Hierzu MUSS die capabilities-Interaktion gemäß FHIR-Spezifikation 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 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.

Eine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom kind= "instance" liefern und im Element software den Namen und die Versionsnummer angeben.

Das CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement 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 (Requirement) ISiK-Terminplanung

Das nachfolgende CapabilityStatement repräsentiert die Anforderungen an ein Termin-Repository.

Link Simplifier Profil Übersicht

REST Capabilities Server

ModeServer

Resource Interactions

Resource TypeSupported ProfilesReadSearchTypePatchCreateUpdate
ScheduleISiKKalenderSHALLSHALL
SlotISiKTerminblockSHALLSHALL
AppointmentISiKTerminSHALLSHALLSHALL
CommunicationISiKNachrichtSHALLSHALLSHALLSHALL
HealthcareServiceISiKMedizinischeBehandlungseinheitSHALLSHALL
BinaryISiKBinarySHALLSHALL

Operations per resource type

Schedule

No operations are stated for this resource type

Slot

No operations are stated for this resource type

Appointment

OperationReferenceDocumentationLevel
bookBook

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

SHALL

Communication

No operations are stated for this resource type

HealthcareService

No operations are stated for this resource type

Binary

No operations are stated for this resource type

Search Parameters per resource type

Schedule

NameTypeDocumentationLevel
_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.

SHALL
_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.

MAY
activetoken

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

SHALL
service-typetoken

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

SHALL
specialtytoken

Beispiel:
GET [base]/Schedule?specialty=urn:oid:1.2.276.0.76.5.114|535
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
actorreference

Beispiel:
GET [base]/Schedule?actor=Practitioner/ISiKPractitionerExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL

Supported Reverse Includes:

  • Slot:schedule
  • Schedule:actor

Slot

NameTypeDocumentationLevel
_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.

SHALL
_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.

MAY
schedulereference

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.

SHALL
statustoken

Beispiel:
GET [base]/Slot?status=free&schedule=Schedule/ISiKTerminExampleGET [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.
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
startdate

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.

SHALL

Supported Includes:

  • Slot:schedule

Supported Reverse Includes:

  • Appointment:slot

Appointment

NameTypeDocumentationLevel
_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.

SHALL
_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.

MAY
statustoken

Beispiel:
GET [base]/Appointment?status=booked
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
service-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.

SHALL
specialtytoken

Beispiel:
GET [base]/Appointment?specialty=urn:oid:1.2.276.0.76.5.114|535
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.

SHALL
datedate

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.

SHALL
slotreference

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

SHALL
actorreference

Beispiel:
GET [base]/Appointment?actor=Patient/ISiKPatientExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL

Supported Includes:

  • Appointment:slot
  • Appointment:actor

Communication

NameTypeDocumentationLevel
_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.

SHALL
_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.

MAY
subjectreference

Beispiel:
GET [base]/Communication?subject=Patient/ISiKPatientExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

MAY
patientreference

Beispiel:
GET [base]/Communication?patient=Patient/ISiKPatientExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
recipientreference

Beispiel:
GET [base]/Communication?recipient=Practitioner/ISiKPractitionerExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
senderreference

Beispiel:
GET [base]/Communication?sender=Practitioner/ISiKPractitionerExample
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL

Supported Includes:

  • Communication:recipient
  • Communication:sender
  • Communication:subject

HealthcareService

NameTypeDocumentationLevel
_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.

SHALL
_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.

MAY
activetoken

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

SHALL
service-typetoken

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

SHALL
specialtytoken

Beispiel:
GET [base]/HealthcareService?specialty=urn:oid:1.2.276.0.76.5.114|535
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL
namestring

Beispiel:
GET [base]/HealthcareService?name=Medizinische Behandlungseinheit Des Fachbereichs 0100
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

SHALL

Supported Includes:

  • Schedule:actor
  • Communication:recipient
  • Appointment:actor

Binary

No search parameters are stated for this resource type