Instance: eEKP-702-CapabilityStatement
InstanceOf: CapabilityStatement
Usage: #definition
* copyright = """(c)Copyright 2025 ELGA GmbH- All Rights Reserved"""
* copyrightLabel = "ELGA GmbH"
* date = "2026-06-02"
* description = """# Überblick
![Übersicht: eEKP Anbindung der Länder](assets/eEKP_FHIR_Overview.png)
Dieser Abschnitt gibt eine allgemeine Einführung in die FHIR API für eEKP für Krankenanstalten (702).

<!-- Kommentar
## Berechtigte Anwender
Diese API kann von Client-Agenten verwendet werden, die die Rolle der Krankenanstalten (Code: 702) abbilden.

## Status
Die API befindet sich noch in der Entwicklung

## Technologie
Diese API ist RESTful und verwendet HTTP POST zum Senden von Daten und HTTP GET zum Lesen von Daten.

Sie entspricht dem globalen FHIR-Standard für den Datenaustausch im Gesundheitswesen, insbesondere FHIR RX (v5.0.0).

## Netzzugang
Für den Zugang ist eine Anbindung an das Gesundheitsnetz und die entsprechende Umgebung erforderlich.

## Sicherheit und Autorisierung

Der Zugriff wird über Komponenten des ELGA- und e-Health-Berechtigungssystems autorisiert. Dazu sind im API-Katalog folgende Beschreibungen zu finden (benötigte Tokens, etc.):
* ELGA OAuth2 Authorization Server (EOAS)
* Service Facade (SF)


## Fehlermeldungen
TODO: tbd

## Umgebungen und Endpunkte
TODO: Liste der verfügbaren Umgebungen (Test, Produktion) und deren zugehörige Endpunkte.

## Change Log
TODO: Link auf Jira Ticket

-->"""
* fhirVersion = #4.0.1
* format = #application/fhir+json
* kind = #requirements
* name = "ekp:role:702"
* patchFormat = #application/json-patch+json
* publisher = "ELGA GmbH - e-Health Architektur"
* purpose = """Dieses CapabilityStatement beschreibt, welche FHIR Interaktionen, Operationen, Suchparameter, Ressourcen und Profile für die Rolle 702 unterstützt bzw. erlaubt werden"""
* status = #active
* title = "eEKP FHIR-Anbindung"
* version = "1.1.0"
* contact.name = "mail"
* contact.telecom.system = #email
* contact.telecom.value = "office@elga.gv.at"
* rest.documentation = """Beschreibung der RESTful-Schnittstelle des Servers"""
* rest.mode = #server
* rest.operation.definition = "http://example.org/fhir/OperationDefinition/CreateEkps"
* rest.operation.documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/CreateEkps".

### Zweck
Über diesen Endpunkt wird die Operation zum Erstellen eines EKP-S ermöglicht. Hierzu wird entweder der erste Tag der letzten Regelblutung oder der bereits ausgerechnete Geburtstermin als Input benötigt.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Ein eEKP Access Token muss vorhanden sein
"""
* rest.operation.name = "CreateEkps"
* rest.resource[+].conditionalCreate = false
* rest.resource[=].conditionalDelete = #not-supported
* rest.resource[=].conditionalRead = #not-supported
* rest.resource[=].conditionalUpdate = false
* rest.resource[=].documentation = """Ein strukturierter Set von Fragen und deren Antworten für die Geburtenmeldung im Kontext von eEKP."""
* rest.resource[=].profile = "http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse"
* rest.resource[=].readHistory = false
* rest.resource[=].type = #QuestionnaireResponse
* rest.resource[=].updateCreate = false
* rest.resource[=].versioning = #no-version
* rest.resource[=].interaction[+].code = #create
* rest.resource[=].interaction[=].documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/QuestionnaireResponse" mittels der "create"-Interaktion.


### Zweck
Über diesen Endpunkt wird ein strukturiertes Set von Fragen und deren Antworten für die Geburtenmeldung im Kontext der eEKP übermittelt. Dafür wird die FHIR-Ressource "QuestionnaireResponse" verwendet.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Ein eEKP Access Token muss vorhanden sein
"""
* rest.resource[=].interaction[+].code = #update
* rest.resource[=].interaction[=].documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/QuestionnaireResponse" mittels der "update"-Interaktion.


### Zweck
Über diesen Endpunkt wird ein strukturiertes Set von Fragen und deren Antworten für die Geburtenmeldung im Kontext der eEKP aktualisiert. Dafür wird die FHIR-Ressource "QuestionnaireResponse" verwendet.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Ein eEKP Access Token muss vorhanden sein
* Die UntersuchungsId für die zu aktualisierende Ressource muss bekannt sein
"""
* rest.resource[=].interaction[+].code = #search-type
* rest.resource[=].interaction[=].documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/QuestionnaireResponse" mittels der "search"-Interaktion (via eEKP-Fachidentifikator, Untersuchungs-ID, Untersuchungskapitel).


### Zweck
Über diesen Endpunkt wird das Laden eines Untersuchungskapitels ermöglicht. Dafür wird die FHIR-Ressource "QuestionnaireResponse" verwendet.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Die relevanten DocumentReference-Metadaten müssen über eine ITI-67-Abfrage ermittelt worden sein (u.a. der eEKP-Fachidentifikator, Untersuchungs-ID sowie der Code des Untersuchungskapitels).
* Ein eEKP Access Token muss vorhanden sein
"""
* rest.resource[=].searchParam[+].documentation = """eEKP-Untersuchungs-Id; urn:oid:1.2.40.0.34.4.30|456"""
* rest.resource[=].searchParam[=].name = "identifier"
* rest.resource[=].searchParam[=].type = #token
* rest.resource[=].searchParam[+].documentation = """eEKP-Fachidentifikator; urn:oid:1.2.40.0.34.4.29|123"""
* rest.resource[=].searchParam[=].name = "identifier"
* rest.resource[=].searchParam[=].type = #token
* rest.resource[=].searchParam[+].documentation = """eEKP-Untersuchungscode; urn:oid:1.2.40.0.34.5.267|GS"""
* rest.resource[=].searchParam[=].name = "code"
* rest.resource[=].searchParam[=].type = #token
* rest.resource[+].conditionalCreate = false
* rest.resource[=].conditionalDelete = #not-supported
* rest.resource[=].conditionalRead = #not-supported
* rest.resource[=].conditionalUpdate = false
* rest.resource[=].documentation = """Metadaten zum eEKP entsprechend IHE MHD"""
* rest.resource[=].profile = "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference"
* rest.resource[=].readHistory = false
* rest.resource[=].type = #DocumentReference
* rest.resource[=].updateCreate = false
* rest.resource[=].versioning = #no-version
* rest.resource[=].interaction.code = #search-type
* rest.resource[=].interaction.documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/DocumentReference" mittels der "search"-Interaktion.

### Zweck
Über diesen Endpunkt werden die Metadaten sowie das Dokument selbst zum eEKP retourniert. Dafür wird die FHIR-Ressource "DocumentReference" verwendet, welche auch das CDA-Dokument als Anhang enthält.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Ein eEKP Access Token muss vorhanden sein
"""
* rest.resource[=].searchParam[+].documentation = """Identifikator des Subjekts (Es muss entweder patient oder patient.identifier angegeben werden); GH:oeLdSEb0l+8kSdJWjOYyYmnYki0="""
* rest.resource[=].searchParam[=].name = "patient.identifier"
* rest.resource[=].searchParam[=].type = #token
* rest.resource[=].searchParam[+].documentation = """Identifikator des Subjekts (Es muss entweder patient oder patient.identifier angegeben werden); GH:oeLdSEb0l+8kSdJWjOYyYmnYki0="""
* rest.resource[=].searchParam[=].name = "patient"
* rest.resource[=].searchParam[=].type = #reference
* rest.resource[+].documentation = """Eine Gesamtabfrage des eEKP."""
* rest.resource[=].profile = "http://hl7.org/fhir/StructureDefinition/Binary"
* rest.resource[=].type = #Binary
* rest.resource[=].interaction.code = #read
* rest.resource[=].interaction.documentation = """## Überblick
Dieser Abschnitt gibt einen allgemeine Überblick über die Verwendung des Endpunkts "/Binary".

### Zweck
Über diesen Endpunkt wird das Laden eines vollständigen eEKP als Dokument (PDF) ermöglicht. Dafür wird die FHIR-Ressource "Binary" verwendet. Als logische ID wird der eEKP-Fachidentifikator verwendet.

### Vorbedingungen
* Zu behandelnde Person muss identifiziert worden sein
* Ein aktiver und gültiger Kontakt zur behandelnden Person muss vorhanden sein
* Die relevanten DocumentReference-Metadaten müssen über eine ITI-67-Abfrage ermittelt worden sein (u.a. der eEKP-Fachidentifikator).
* Ein eEKP Access Token muss vorhanden sein
"""
* rest.security.cors = true
* rest.security.description = """Verweis auf technische Beschreibung zum ELGA Authorization Server"""
* rest.security.service.coding.code = #OAuth2
* rest.security.service.coding.display = "OAuth"
* rest.security.service.coding.system = "restful-security-service"