Spezifikationen

Übersicht

Testinstanz für Softwareanbieter

https://api.das-pflege.de

Für die Weberfassung unter www.das-pflege.de bietet die DAS Pflege zwei Alternativen an, einen Daten-Upload und einen Webservice. Für beide Alternativen stellt sie jeweils einen Testzugang bereit, mit der Softwareanbieter die jeweilige Funktion auf der o.g. Testinstanz testen können. Hintergründe zu den Erfassungsmodi können Sie den FAQ und der Technischen Dokumentation der aktuellen Spezifikation entnehmen.


Testdateien

Zum einfachen Testen dieser Übertragungswege stellen wir Ihnen Testdateien zur Verfügung. Unabhängig vom Übertragungsmodus und ob Sie diese oder eigene Testdateien verwenden, ist im Element bzw. Attribut header/care_provider/target_date/@value immer das aktuelle Datum im Format YYYY-MM-DD einzutragen.


Zugangsdaten für den Webservice

Es ist für jeden Benutzerkreis ein Testzugang eingerichtet. Die Zugangsdaten finden Sie in der Dokumentation der REST-API.

Im Element bzw. Attribut header/care_provider/registration/@value ist bei Tests des Webservice in den XML-Dateien immer die Einrichtungs-ID 100001 zu verwenden.


Zugangsdaten für die Funktion Daten-Upload (nur für Pflegeeinrichtungen)

Benutzer: testuser-upload@aqua-institut.de
Passwort: 123456Test!

Im Element bzw. Attribut header/care_provider/registration/@value ist bei Tests des Daten-Uploads in den XML-Dateien immer die Einrichtungs-ID 100002 zu verwenden.

Neues in der REST-API

Veröffentlicht am: 12.11.2020

Produktivschaltung: Neuer Endpunkt für Metadaten einer Pflegeeinrichtung

  • GET /api/pflegeeinrichtungen/{pflegeeinrichtungId}

    Zugriff für Pflegeeinrichtungen, Landesverbände und Prüfdienste. Details sind der Endpunktbeschreibung zu entnehmen.


Veröffentlicht am: 06.10.2020

CORS: Content-Disposition als Access-Control-Expose-Header beim Download von Importdateien und Validierungsprotokollen

  • Responses zu folgenden Endpunkten erlauben nun Clients den Zugriff auf Content-Disposition:
    • /api/datenerfassung/importvorgaenge/{id}/importdatei
    • /api/datenerfassung/importvorgaenge/{id}/validierungsprotokoll

Veröffentlicht am: 21.07.2020

CORS: Content-Disposition als Access-Control-Expose-Header beim Download von Berichten

  • Responses zu /api/pflegeeinrichtungen/{pflegeeinrichtungId}/berichte/{berichtId}/download erlauben nun Clients den Zugriff auf Content-Disposition.

Produktivschaltung: Neues Attribut linkDownload in ReportRestDto

  • Dieses führt im Gegensatz zu downloadlink Schema und Host und geht damit und mit der Benennung konform zu Attributen in QsSaveDataResultDto. downloadlink wurde gleichzeitig auf Deprecated gesetzt. Eine endgültige Entfernung wird erst nach langfristiger Vorankündigung durchgeführt.

Produktivschaltung: Berichte und Importvorgänge: Filterfunktionen nach Stichtag

  • Die Endpunkte zum Abfragen von Importvorgängen und Berichten wurden um einen Filter erweitert, der Einträge nach dem zugrundeliegenden Stichtag filtert. Bei Importvorgängen können damit jedoch nur Importe bezogen werden, die nach dem 25.06.2020 durchgeführt wurden.

    Details sind den betroffenen Endpunkten zu entnehmen:

    • ​/api​/pflegeeinrichtungen​/{pflegeeinrichtungId}​/berichte
    • /api​/datenerfassung​/importvorgaenge

Produktivschaltung: Neuer Endpunkt für Erhebungsfristen

  • GET /api/pflegeeinrichtungen/{pflegeeinrichtungId}/fristen

    Der Endpunkt liefert zu einer Pflegeeinrichtung alle Erhebungszeiträume inkl. Erhebungen ohne Veröffentlichung und jeweils alle dazugehörigen Fristen. Details sind der Endpunktbeschreibung zu entnehmen.


Veröffentlicht am: 16.03.2020 (Testinstanz) / vsl. 19-23.03.2020 (Produktivinstanz)Neu

Verschleierte IDs der Importvorgänge über api/datenerfassung/importvorgaenge (nur Testinstanz)

  • Um auf der Testinstanz keinen Einblick in die Importdateien und Validierungsprotokolle anderer Nutzer zu bekommen, hat die ID jedes über api/datenerfassung/importvorgaenge zurückgegebenen Importvorgangs den Wert -1. Zum Abruf von Importvorgängen vermerken Sie bitte in diesem Fall die bei der Datenerfassung zurückgebene ID bzw. den zurückgebenen Link. Dies betrifft ausschließlich die Testinstanz.

Änderung am Model QsDataImportEventRestDto : 8-stelliger Zufallswert für IDs neuer Importvorgänge

  • Die ID neuer Importvorgänge wird zudem ein 8-stelliger Zufallswert sein. Diese Änderung betrifft sowohl die Test- als auch die Produktivinstanz (letztere vsl. ab 19-23.03.2020).

Veröffentlicht am: 05.03.2020

Konsistentere Rückgabe für Endpunkt api/datenerfassung

  • Mit dem Accept-Header application/vnd.das-pflege.v2+json wird im Erfolgs- und im Fehlerfall stets dasselbe Ergebnis zurückgegeben: Eine Instanz von QsSaveDataResultDto mit Links zum Validierungsprotokoll, zur Importdatei und zum Importvorgang. Der alte Rückgabetyp für den Accept-Header application/xml bleibt aus Gründen der Abwärtskompatibilität vorhanden. Details sind der Endpunktbeschreibung der REST-API-Dokumentation zu entnehmen.

Veröffentlicht am: 06.12.2019

Erweiterung des Models ReportRestDto

  • Neuer Rückgabeparameter stichtag vom Typ string im Format yyyy-MM-dd

Veröffentlicht am: 29.11.2019

Nichtabwärtskompatible Änderungen: Umbenennungen von Rückgabeparametern sowie Endpunkt-Pfaden für die Datenerfassung

  • Geänderte Rückgabeparameter
    • ReportRestDto
      • berichtId statt berichtsId
      • pflegeeinrichtungId statt einrichtungsNr
      • einrichtungsbezogeneLaufendeNummer statt zyklus
      • berichtTyp statt berichtsTyp
      • berichtName statt berichtsName
      • downloadlink statt link
      • Änderung des Rückgabetyps von berichtTyp auf BerichtTyp (siehe Model ReportRestDto)
      • Änderung des Rückgabetyps von dateiTyp auf DateiTyp (siehe Model ReportRestDto)
    • QsDataImportEventRestDto
      • importVorgangId statt importEventId
      • startDatum statt startDate
      • endDatum statt endDate
      • benutzerEmail statt userEmail
      • importKanal statt importChannel
      • erfolg statt success
      • einrichtungsId enfernt
      • Änderung des Rückgabetyps von importKanal auf ImportKanal (siehe Model QsDataImportEventRestDto)
    • PflegeeinrichtungMinimalRestDto statt PflegeeinrichtungMinimalDto
      • pflegeeinrichtungId statt einrichtungsNr
      • pflegeeinrichtungName statt einrichtungsBezeichnung
  • Geänderte Endpunkte für die Datenerfassung
    • /api/datenerfassung/importvorgaenge statt /api/datenerfassung/import-events
    • /api/datenerfassung/importvorgaenge/{id} statt /api/datenerfassung/import-events/{id}
    • /api/datenerfassung/importvorgaenge/{id}/importdatei statt /api/datenerfassung/import-events/{id}/import-file
    • /api/datenerfassung/importvorgaenge/{id}/validierungsprotokoll statt /api/datenerfassung/import-events/{id}/validation-protocol
Hinweis: Es ist nicht geplant, zukünftig erneut nichtabwärtskompatible Änderungen vorzunehmen. Notwendige zukünftige Änderungen streben wir als abwärtskompatibel an.

Veröffentlicht am: 22.11.2019

Freischaltung für den produktiven Betrieb

Neuer Endpunkt ​/api/pflegeeinrichtungen/{pflegeeinrichtungId}/zweitstichprobe

  • Endpunkt für Prüfdienste zum Beziehen von Zweitstichproben.

Neuer Endpunkt ​/api​/pflegeeinrichtungen​/{pflegeeinrichtungId}​/berichte/maxId

  • Convenience-Methode zum Abfragen der höchsten Berichts-ID einer Pflegeeinrichtung

Alle Endpunkte mit Rückgabetyp JSON

  • Änderung des Response-Content-Types von application/json auf application/json;charset=utf-8

Veröffentlicht am: 30.10.2019

Endpunkte ​/api​/pflegeeinrichtungen​/{pflegeeinrichtungId}​/berichte und ​/api​/pflegeeinrichtungen​/{pflegeeinrichtungId}​/berichte/{berichtId}

  • Hinzunahme der Felder dateiTyp und contentType zum Model ReportRestDto

Endpunkt ​/api/pflegeeinrichtungen/{pflegeeinrichtungId}/berichte/{berichtId}/download

  • Prüfung auf Übereinstimmung des Accept-Headers zum Content-Typen des angeforderten Berichts. Bei fehlender Übereinstimmung erhält die Antwort den Status 406.