Kommunen-API

Die Kommunen-API dient der programmatischen Übermittlung von Kommunendaten an das Portal für Elektronische Meldungen Psychiatrie (PEMP).

Datenspezifikation

Die Struktur der zu übermittelnden Daten wird auf einer eigenen Seite beschrieben.

Aktivierung der API

Ein Kommunen-Benutzer hat nach dem Login die Möglichkeit, die API zu aktivieren. Dazu muss er über den Menüpunkt "API" auf den Button "API aktivieren" klicken. Nach der Aktivierung wird ein API-Key generiert, der für die Authentifizierung bei der API benötigt wird.

Der API-Key kann jederzeit neugeneriert werden. Dazu muss der Kommunen-Benutzer über den Menüpunkt "API" auf den Button "API-Key neugenerieren" klicken. Der alte API-Key wird dabei ungültig.

Authentifizierung

Der unter Aktivierung der API generierte API-Key muss bei jeder Anfrage an die API im Authorization-Header mitgegeben werden:

Authorization: ApiKey <my-api-key>

Alle Anfragen müssen über HTTPS gestellt werden. Anfragen über HTTP werden nicht unterstützt. Ebenso werden alle Anfragen ohne API-Key fehlschlagen.

Endpunkt

PUT /api/kommunen/daten

Erstellt oder aktualisiert die Kommunendaten. Das Erfassungsjahr wird dabei aus dem Jahr des aktuellen Datums abgeleitet.

Hinweis: Je nach Cache-Status des Servers kann der Response mehrere Minuten in Anspruch nehmen. Achten Sie daher bitte darauf, einen Timeout von mindestens 5 Minuten für Ihre Anfrage zu setzen.

Parameter

Keine

Request body

Die Daten der Kommunen für das angegebene Erfassungsjahr als FHIR-QuestionnaireResponse in JSON.

Content-Type: application/json

Responses

HTTP-Code Response Beschreibung
200 OK 
{
  "validation-result": "[PRELIMINARY-VALID|INVALID]",
  "errors": array of {
    "message": string,
    "linkId": string,
    "displayText": string
  },
  "warnings": array of {
    "message": string,
    "linkId": string,
    "displayText": string
  }
}
 Die Struktur der Daten ist korrekt, sodass diese verarbeitet werden konnten. Die Validierung der Inhalte der Daten wird in validation-result angegeben:
  • PRELIMINARY-VALID: Die Daten sind vorläufig korrekt. Die vollständige Validierung wird erst bei der Freigabe bzw. Überprüfung der Daten eines berechtigten Kommunenbenutzers im PEMP-Portal durchgeführt.
  • INVALID: Die Daten sind nicht korrekt, können aber durch berechtigte Kommunen-Benutzer im PEMP-Portal korrigiert werden. Sollten jedoch die Antwortdaten zu stark vom Questionnaire abweichen, kann es sein, dass der Fragebogen im PEMP-Portal nicht gerendert werden kann.
Neu 08/2025:
  • errors enthält eine Liste von Fehlern, falls diese bei der Validierung festgestellt wurden. Fehler hindern eine Freigabe der Daten.
  • warnings enthält eine Liste von Warnungen, falls diese bei der Validierung festgestellt wurden. Warnungen hindern die Freigabe der Daten nicht, sollten jedoch idealerweise (ggfs. auch erst für spätere Berichtsjahre) behoben werden.
Waren die Daten bereits freigegeben, wird die Freigabe mit diesem Request zurückgezogen.
400 Bad Request Kein oder { "errors": string array } Die übermittelten Daten entsprechen nicht der Struktur des erforderten FHIR-QuestionnaireResponses. Je nach Ursache der Nichtverarbeitbarkeit können die Gründe im Response angegeben werden oder nicht.
401 Unauthorized Kein Der API-Key ist nicht gültig oder fehlt.
403 Forbidden Kein Der Zeitraum zum Einsenden von Daten für das aktuelle Erfassungsjahr ist abgelaufen.

Beispiel (curl) 

			
curl PUT -H "Authorization: ApiKey abc123" -H "Content-Type: application/json" \
-d '{"resourceType":"QuestionnaireResponse", ...}' \
https://www.fachaufsicht-psychiatrie-niedersachsen.de/api/kommunen/daten