Skip to content

Arztbriefe abrufen

Gibt eine paginierte Liste aller Arztbriefe des Unternehmens zurück.

Request

GET /api/oauth/v2/resource/doctor-letters

HeaderWert
AuthorizationBearer {access_token}

Query-Parameter

ParameterTypPflichtBeschreibung
offsetintegerNeinStartposition (Standard: 0, Min: 0)
limitintegerNeinAnzahl Ergebnisse (Standard: 50, Min: 1, Max: 200)

Response

Erfolg (200 OK)

json
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Arztbrief zur Überweisung",
      "text": "Sehr geehrte Kollegin, sehr geehrter Kollege, ich berichte über die Patientin Anna Muster...",
      "date": "2026-06-09",
      "printed": false,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "treatingUser": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "firstName": "Dr. Maria",
        "lastName": "Huber"
      },
      "receiver": {
        "title": "Dr.",
        "firstName": "Klaus",
        "lastName": "Berger",
        "institute": "Facharztpraxis Innere Medizin",
        "street": "Hauptstraße 12",
        "zip": "4020",
        "city": "Linz",
        "country": "AT",
        "tel": "0732123456",
        "telCode": "+43",
        "fax": null,
        "email": "k.berger@beispiel.at"
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Entlassungsbrief",
      "text": null,
      "date": "2026-06-08",
      "printed": true,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      },
      "treatingUser": {
        "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
        "firstName": "Dr. Maria",
        "lastName": "Huber"
      },
      "receiver": null
    }
  ],
  "meta": {
    "total": 18,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

FeldTypBeschreibung
dataArrayListe der Arztbriefe
data[].idstring (UUID)Eindeutige ID des Arztbriefs
data[].namestring | nullBezeichnung des Arztbriefs
data[].textstring | nullInhalt des Arztbriefs
data[].datestring | nullDatum des Arztbriefs (YYYY-MM-DD)
data[].printedboolean | nullGibt an, ob der Brief gedruckt wurde
data[].customerobject | nullZugeordnete:r Patient:in
data[].customer.idstring (UUID)Kunden-ID
data[].customer.firstNamestringVorname
data[].customer.lastNamestringNachname
data[].treatingUserobject | nullBehandelnde:r Benutzer:in
data[].treatingUser.idstring (UUID)Benutzer-ID
data[].treatingUser.firstNamestringVorname
data[].treatingUser.lastNamestringNachname
data[].receiverobject | nullEmpfänger:in des Arztbriefs
data[].receiver.titlestring | nullTitel
data[].receiver.firstNamestring | nullVorname
data[].receiver.lastNamestring | nullNachname
data[].receiver.institutestring | nullInstitut oder Einrichtung
data[].receiver.streetstring | nullStraße
data[].receiver.zipstring | nullPostleitzahl
data[].receiver.citystring | nullOrt
data[].receiver.countrystring | nullLand (ISO 3166-1 alpha-2)
data[].receiver.telstring | nullTelefonnummer
data[].receiver.telCodestring | nullTelefonvorwahl
data[].receiver.faxstring | nullFaxnummer
data[].receiver.emailstring | nullE-Mail-Adresse
meta.totalintegerGesamtanzahl der Arztbriefe
meta.offsetintegerAktuelle Startposition
meta.limitintegerAnzahl der zurückgegebenen Einträge
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/doctor-letters?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Mögliche Fehler

StatusCodeBeschreibung
401invalid_clientUngültiger oder fehlender Access Token
403insufficient_scopeScope medicals nicht vorhanden

Offisy GmbH