ISiK CapabilityStatement Dokumentenverwaltung Rolle - 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 "ISiKCapabilityStatementDokumentenverwaltungRolle". Diese Rolle beschreibt verpflichtende Interaktionen zur Erstellung, dem Abruf und der Aktualisierung von Dokumenten.

CanonicalURLhttps://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementDokumentenverwaltungRolle
Intentionrequirements
Statusactive
Version5.1.1

Anforderungen an die FHIR-API

Modusserver

Interaktionen

RessourcentypVerbindlichkeitREADSEARCHCREATE
BinarySHALLSHALL
DocumentReferenceSHALLSHALLSHALLSHALL

Profile

RessourcentypProfileVerbindlichkeit
Binaryhttps://gematik.de/fhir/isik/StructureDefinition/ISiKBinarySHALL
DocumentReferencehttps://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadatenSHALL

Ressourcentyp-spezifische Operations

Globale Operations

Dokumenten-Endpunkt

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
DocumentReferenceidentifierSHALL

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.

http://hl7.org/fhir/SearchParameter/clinical-identifier
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.

http://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

RessourcenTyptable
DocumentReference
DocumentReference:patient (SHALL)
DocumentReference:encounter (SHALL)
Binary