...
| Version | Datum | Autor | Kapitel | Änderung | Status |
|---|---|---|---|---|---|
| 1.1 | 15.06.2026 | kv.digital GmbH | Health Check Endpoint | Neues Kapitel | in Kraft |
| 1.0 | 0105.06.2026 | kv.digital GmbH | alle | Erstellung | in Kraft- |
| Inhalt |
|---|
Allgemein
Sobald das Audit erfolgreich abgeschlossen ist und Sie die Zertifizierung erhalten haben, können Sie die Schnittstelle final in die Produktivumgebung Ihrer Software oder Plattform integrieren.
Hierzu stellt Ihnen die kv.digital einen Zugangslink zur Produktivumgebung sowie die erforderlichen Zugangsdaten bereit (OAuth2 mit dem Client‑Credential‑Flow).
Für die Nutzung ist außerdem eine VPN‑Verbindung einer Site-to-Site-VPN‑Verbindung (VPN-Verbindung) zwischen den vertrauenswürdigen Umgebungen der Client‑ und der Server‑Systeme erforderlich, die zur sicheren Speicherung des Schlüsselmaterials Client‑seitig in Hardware ausgelegt ist.
...
📌 Empfehlung:
Setzen Sie die Seite auf „Beobachten“, um automatisch über Änderungen und Störungen informiert zu werden.
Health Check Endpoint
Der Health-Check-Endpunkt dient dazu, die grundlegende Erreichbarkeit und Funktionsfähigkeit der Anwendung zu prüfen.
Endpoint-Definition
URL:
| Codeblock |
|---|
{baseURL}/api/v2/healthcheck |
HTTP-Methode:
| Codeblock |
|---|
GET |
FHIR-Kontext:
Es handelt sich ausdrücklich nicht um einen FHIR-Endpunkt.
Request:
Der Endpoint benötigt keine speziellen Header oder Parameter.
Response:
Erfolgreicher Fall
Wenn der Service erreichbar ist und läuft:
| Codeblock |
|---|
HTTP/1.1 200 OK |
- Es wird kein Response-Body erwartet.
- Der Statuscode allein signalisiert den erfolgreichen Health-Zustand.
Fehlerfall:
Falls der Service nicht funktionsfähig ist, wird ein HTTP-Statuscode ungleich 200 zurückgegeben.
Schritt 1: Anmeldung zur Integration
...