Endpoints / getPatientHistory

getPatientHistory

KG-Journal abfragen

Verlaufseinträge der Krankengeschichte eines Patienten, absteigend nach Datum. Kein Anamnese-Formular: Hauptleiden und Allergien liegen in eigenen Listen und kommen hier nicht vor. Gelöschte Einträge sind immer ausgeschlossen.

HTTP Request

POST https://dev.vitabyte.ch/v1/hx/getPatientHistory
Auth basicAuth apiKey

Request Parameters

⚠ Ohne limit wird der gesamte Verlauf inklusive aller Attachment-Lookups geladen — bei langen Krankengeschichten spürbar langsam.

Parameter Pflicht Typ Beispiel / Default
patid

0 führt zum Fehler "Please provide a patient id.".

required integer
789
limit

0 oder fehlend bedeutet kein Limit — der komplette Verlauf.

optional integer
default: 0
20
category

Prefix-Match auf die Kategorie; leer = alle.

optional string
Konsultation
text

Contains-Match auf den Eintragstext.

optional string
teaser

Contains-Match auf das Prozedere-Feld.

optional string

Response Parameters

attachments ist immer ein Array (leer, wenn keine Dateien hängen); der md5 lässt sich direkt in getAttachment verwenden. userid kommt als String.

Field Typ Beschreibung
historyid integer ID des KG-Eintrags
category string Kategorie bzw. Titel des Eintrags
text string Inhalt des Eintrags
date string Datum und Uhrzeit
teaser string Prozedere-Feld (rechte KG-Spalte)
author string Autor des Eintrags
userid string User-ID des Autors
attachments array Angehängte Dateien mit file, md5 und size

Demo

Referenz und Beispiele stammen aus der internen API-Collection — die OpenAPI-Spec deckt diesen Endpoint noch nicht ab.

POST https://dev.vitabyte.ch/v1/hx/getPatientHistory
Payload
{
    "patid": 789,
    "limit": 20,
    "category": "Konsultation",
    "text": "",
    "teaser": ""
}
Response
{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "historyid": 4711,
            "category": "Konsultation",
            "text": "Der Patient zeigt an den Handgelenken nach Gartenarbeit kreisförmige Rötungen mit starkem Juckreiz. Fotos sind angehängt.",
            "date": "2026-07-28 10:15:00",
            "teaser": "Kontrolle in 2 Wochen",
            "author": "Dr. med. Gregor Haus",
            "userid": "3",
            "attachments": [
                {
                    "file": "befund.pdf",
                    "md5": "a3f5effbaf4b369f085809cac9c42845",
                    "size": 12345
                }
            ]
        },
        {
            "historyid": 4695,
            "category": "Konsultation",
            "text": "Patient erscheint für ein ärztliches Attest.",
            "date": "2026-07-14 18:54:00",
            "teaser": "",
            "author": "Dr. med. Gregor Haus",
            "userid": "3",
            "attachments": []
        }
    ]
}