Arztbrief anzeigen

Gibt die Details eines einzelnen Arztbriefs zurück.

Request

GET /api/oauth/v2/resource/doctor-letters/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige ID des Arztbriefs

Response

Erfolg (200 OK)

{
  "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"
    }
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige ID des Arztbriefs
data.name	string | null	Bezeichnung des Arztbriefs
data.text	string | null	Inhalt des Arztbriefs
data.date	string | null	Datum des Arztbriefs (YYYY-MM-DD)
data.printed	boolean | null	Gibt an, ob der Brief gedruckt wurde
data.customer	object | null	Zugeordnete:r Patient:in
data.customer.id	string (UUID)	Kunden-ID
data.customer.firstName	string	Vorname
data.customer.lastName	string	Nachname
data.treatingUser	object | null	Behandelnde:r Benutzer:in
data.treatingUser.id	string (UUID)	Benutzer-ID
data.treatingUser.firstName	string	Vorname
data.treatingUser.lastName	string	Nachname
data.receiver	object | null	Empfänger:in des Arztbriefs
data.receiver.title	string | null	Titel
data.receiver.firstName	string | null	Vorname
data.receiver.lastName	string | null	Nachname
data.receiver.institute	string | null	Institut oder Einrichtung
data.receiver.street	string | null	Straße
data.receiver.zip	string | null	Postleitzahl
data.receiver.city	string | null	Ort
data.receiver.country	string | null	Land (ISO 3166-1 alpha-2)
data.receiver.tel	string | null	Telefonnummer
data.receiver.telCode	string | null	Telefonvorwahl
data.receiver.fax	string | null	Faxnummer
data.receiver.email	string | null	E-Mail-Adresse

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/doctor-letters/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope medicals nicht vorhanden
404	not_found	Arztbrief nicht gefunden