Appearance
Übergabebuch
1. Überblick
Im Folgenden wird ein Übergabebuch-Eintrag für die App go.book als „Journal“ bezeichnet.
2. Liste der Mitarbeiter
Wichtig sind hier vor allem die Felder status und mandant_id.
status: 0bedeutet, dass dieser Mitarbeiter aktuell aktiv ist.status: 8bedeutet archiviert.status: 9bedeutet gelöscht.
Alle Mitarbeiter mit status > 0 können ignoriert werden.
mandant_id ist die konkrete ID der jeweiligen Pflegeeinrichtung.
Diese wird später für das Anlegen eines go.book-Eintrags (Journal) benötigt.
Request
http
GET /web/v3/rest/MitarbeiterHeader
text
Bearer <bearer>Response
text
Mitarbeiter[]3. Liste der Patienten
Auch hier gibt es das Feld status.
Es gelten die gleichen Bedeutungen wie bei den Mitarbeitern.
Request
http
GET /web/v3/rest/PatientHeader
text
Bearer <bearer>Response
text
Patient[]4. Liste der Journal-Prioritäten
Beispiele für Prioritäten:
- Information
- Normal
- Wichtig
Die id ist entscheidend, um später einen neuen Journal-Eintrag zu erstellen.
Request
http
GET /web/v3/rest/JournalPrioHeader
text
Bearer <bearer>Response
text
JournalPrio[]5. Liste mit den Bildern (SVG) für einen Journal-Typ
Dies sind die entsprechenden Bilder im SVG-Format für einen Journal-Typen (JournalTyp).
Request
http
GET /web/v3/rest/JournalTypImageHeader
text
Bearer <bearer>Response
text
JournalTypImage[]6. Liste der möglichen Journal-Typen
Dazugehörig können die Bilder aus dem vorhergehenden Request dargestellt werden.
Auch hier ist die id entscheidend, um später den neuen Journal-Eintrag zu erstellen.
Request
http
GET /web/v3/rest/JournalTypHeader
text
Bearer <bearer>Response
text
JournalTyp[]7. Journal-Eintrag erstellen
Jetzt erfolgt das eigentliche Anlegen eines go.book-Eintrags (Journal).
Bedeutung der Felder
| Feld | Beschreibung |
|---|---|
patient_id | ID des Patienten |
mandant_id | mandant_id aus dem Mitarbeiter-Datensatz |
journal_prio_id | ID der Priorität |
journal_typ_id | ID des Typs |
text | Text des Eintrags |
date | Datum des Eintrags |
time | Uhrzeit des Eintrags |
Den gleichen Request gibt es auch als PUT-Request, falls Einträge nachträglich bearbeitet werden sollen.
Request
http
POST /web/v3/rest/JournalHeader
text
Bearer <bearer>Body
json
{
"patient_id": 1,
"mandant_id": 426,
"journal_prio_id": 3,
"journal_typ_id": 2,
"text": "Die Tochter von Frau Weber war heute vor Ort und hat mitgeholfen",
"date": "2022-10-26",
"time": "20:00:00"
}Response
text
<created_id>8. Journal-Protokoll-Eintrag erstellen
Zusätzlich sollte nach dem Erstellen des Journal-Eintrags ein Protokoll-Eintrag angelegt werden.
Dieser enthält Zusatzinformationen darüber, von wem bzw. durch welche App der Eintrag erstellt wurde.
Bedeutung der Felder
| Feld | Beschreibung |
|---|---|
journal_id | ID aus der Response beim Erstellen des Journal-Eintrags |
mitarbeiter_id | ID des Mitarbeiters, der den Eintrag erstellt hat |
mandant_id | mandant_id aus dem Mitarbeiter-Datensatz |
name | Name der Instanz, die den Eintrag erstellt hat, z. B. App oder WebApp |
typ | Kann immer mit 1 gefüllt werden; 1 bedeutet „Journal Eintrag erstellt“ |
Request
http
POST /web/v3/rest/JournalProtocolHeader
text
Bearer <bearer>Body
json
{
"journal_id": 6,
"mitarbeiter_id": 1,
"mandant_id": 426,
"name": "nooa WebApp",
"typ": 1
}Response
text
<created_id>