Spezifikationen

Übersicht

Spezifikation V01.3 gültig ab 17.12.2019

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.

Zugangsdaten und Testdaten für den Webservice

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

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

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

Die Testdateien müssen mit der Einrichtungs-ID (header/care_provider/registration@value) 100002 verwendet werden.

Neues in der REST-API

Veröffentlicht am: 06.12.2019Neu

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.