Konformitätserklärung (CapabilityStatement)

Beschreibung

Dieses CapabilityStatement beschreibt alle Interaktionen, die ein ISiK-konformes System unterstützen MUSS bzw. KANN, um das Bestätigungsverfahren für dieses Modul zu bestehen.

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 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. Darüber hinaus MUSS in CapabilityStatement.instantiates die Canonical URL des nachfolgenden CapabilityStatements angegeben werden.

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.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementDokumentenaustauschServer
Intentionrequirements
Statusactive
Version4.0.1

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypProfileVerbindlichkeitREADSEARCHCREATE
DocumentReferencehttps://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadatenSHALLSHALLSHALLSHALL
Binaryhttps://gematik.de/fhir/isik/StructureDefinition/ISiKBinarySHALLSHALL

Ressourcentyp-spezifische Operations

RessourcenTypNameSpezifikationVerbindlichkeit
DocumentReferenceupdate-metadatahttps://gematik.de/fhir/isik/OperationDefinition/UpdateMetadataMAY
DocumentReferencegenerate-metadatahttps://profiles.ihe.net/ITI/MHD/OperationDefinition/generate-metadataMAY

Suchparameter

RessourcenTypSuchParameterVerbindlichkeitHinweiseDefinition
DocumentReference_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
DocumentReference_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
DocumentReference_countSHALL

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

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

DocumentReferencestatusSHALL

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.

http://hl7.org/fhir/SearchParameter/DocumentReference-status
DocumentReferencepatientSHALL

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.

http://hl7.org/fhir/SearchParameter/clinical-patient
DocumentReferencetypeSHALL

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.

http://hl7.org/fhir/SearchParameter/clinical-type
DocumentReferencecategorySHALL

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.

http://hl7.org/fhir/SearchParameter/DocumentReference-category
DocumentReferencecreationSHALL

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.

https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation
DocumentReferenceencounterSHALL

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

http://hl7.org/fhir/SearchParameter/clinical-encounter

(Reverse-)Include

RessourcenTypInclude
DocumentReferenceDocumentReference:patient; DocumentReference:encounter
Binary