Endpoints / searchPatients

searchPatients

Volltext-Suche über Patienten

Sucht in Nachname, Vorname, Mail, Mobile, AHV-Nummer. Mindestens 2 Zeichen. Limit default 20.

HTTP Request

POST https://dev.vitabyte.ch/v1/system/searchPatients

Auth basicAuth apiKey

Request Parameters

Mindestens ein Suchkriterium ist Pflicht.
⚠ Strikte Parameter-Prüfung: der Endpoint weist jedes unbekannte Feld ab — auch ein Tippfehler führt sofort zu { "status": false, "msg": "Unknown parameter(s): …", "results": null }. Erlaubt sind ausschliesslich die Felder in dieser Tabelle.

Parameter	Pflicht	Typ	Beispiel / Default
`lastname` Contains-Match, findet auch Doppelnamen.	optional	string	Mustermann
`firstname` Contains-Match.	optional	string	Max
`dob` Akzeptiert DD.MM.YYYY und YYYY-MM-DD.	optional	string	01.12.1990
`patid` Exact-Match, positiver Integer.	optional	integer	789
`mail` Exact-Match; länger als 7 Zeichen und muss ein @ enthalten.	optional	string
`ahv` Exact-Match.	optional	string
`offset`	optional	integer	default: `0`
`limit` Maximal 1000; ungültige Werte fallen still auf 100 zurück.	optional	integer	default: `100` 100

Response Parameters

⚠ Envelope-Sonderfall: die Treffer stehen in results (Plural), nicht in result — und ohne Treffer ist results null, nicht []. Die Datensätze enthalten dieselben Felder wie getCustomerById inklusive language; language ist aber kein Suchkriterium.

Demo

Parameter und Beispiele stammen aus der internen API-Collection; die OpenAPI-Spec weicht für diesen Endpoint davon ab.

POST https://dev.vitabyte.ch/v1/system/searchPatients

Payload

{
    "lastname": "Mustermann",
    "firstname": "Max",
    "dob": "01.12.1990",
    "offset": 0,
    "limit": 100
}

Response

{
    "status": true,
    "msg": "Matched 1 customers",
    "results": [
        {
            "patid": 789,
            "lastname": "Mustermann",
            "firstname": "Max",
            "gender": "male",
            "dob": "1990-12-01",
            "title": "Herr",
            "street": "Musterstrasse 1",
            "zip": "8000",
            "city": "Zürich",
            "country": "Schweiz",
            "countrycode": "CH",
            "mobile": "+41 79 000 00 00",
            "mail": "max@example.com",
            "AHV": "756.0000.0000.00",
            "language": "de",
            "deleted": "0"
        }
    ]
}