CapabilityStatement für Rolle "ISiKCapabilityStatementTerminologieRolle" - Konformitätserklärung (CapabilityStatement)

Beschreibung

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.

Zweck

CapabilityStatement für die Rolle "ISiKCapabilityStatementTerminologieRolle". Diese Rolle beschreibt verpflichtende Interaktionen zum Abruf und der Verarbeitung von Terminologie-Ressourcen.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementTerminologieRolle
Intentionrequirements
Statusactive
Version5.0.0-rc

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypVerbindlichkeitREADSEARCH
CodeSystemMAYMAYMAY
ValueSetSHALLSHALL

Profile

RessourcentypProfile
CodeSystemhttps://gematik.de/fhir/isik/StructureDefinition/ISiKCodeSystem
ValueSethttps://gematik.de/fhir/isik/StructureDefinition/ISiKValueSet

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
CodeSystem_idSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-id
CodeSystem_tagSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-tag
CodeSystem_countSHALL

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

CodeSystem_hasMAY

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.

CodeSystemurlMAY

Beispiel:
GET [base]/CodeSystem?url=http://example.org/fhir/CodeSystem/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-url
ValueSet_idSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-id
ValueSet_tagSHALL

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.

http://hl7.org/fhir/SearchParameter/Resource-tag
ValueSet_countSHALL

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

ValueSet_hasMAY

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.

ValueSeturlSHALL

Beispiel:
GET [base]/ValueSet?url=http://example.org/fhir/ValueSet/test
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-url
ValueSetnameSHALL

Beispiel:
GET [base]/ValueSet?name=TestValueSet
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-name
ValueSetstatusSHALL

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

http://hl7.org/fhir/SearchParameter/conformance-status
ValueSetversionSHALL

Beispiel:
GET [base]/ValueSet?version=1.0.0
Anwendungshinweis:
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-version
ValueSetcontext-type-valueMAY

Beispiel:
GET [base]/ValueSet?context-type-value=http://terminology.hl7.org/CodeSystem/usage-context-type|focus$http://hl7.org/fhir/resource-types|Encounter
Anwendungshinweis:
Mit dieser Abfrage können hausinterne Kataloge anhand des Ressource-Typs ermittelt werden. Diese Informationen sind u.a. relevant im Kontext von:
* Hausinternen Prozeduren/Diagnosen-Codes * Kodierung von Encounter-Informationen (z.B. Wahlleistungen, Orttypen)
Use Cases im Zusammenhang:
(A) Zur Konfigurationszeit können passende ValueSets von einem Server spezifisch für einen Ressourcentyp abgerufen und vorbereitend auf eine Systemintegration begutachtet bzw. in Client-Systeme eingebunden werden. In diesem Sinne wird die Abfrage im Kontext der Terminvereinbarung durch einen Termin-Requestor genutzt.
(B) Zur Laufzeit können spezifische ValueSets synchronisiert bzw. direkt in die Eingabemasken von Clients eingebunden werden.
Weitere Details siehe FHIR-Kernspezifikation.

http://hl7.org/fhir/SearchParameter/conformance-context-type-value

(Reverse-)Include

RessourcenTyp
CodeSystem
ValueSet