Patientenbrief anzeigen

Gibt die Details eines einzelnen Patientenbriefs zurück.

Request

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

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige ID des Patientenbriefs

Response

Erfolg (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Befundbericht Juni 2026",
    "text": "Sehr geehrte Kollegin, sehr geehrter Kollege, ich berichte über folgende Befunde ...",
    "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"
    }
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige ID des Patientenbriefs
data.name	string | null	Bezeichnung des Briefs
data.text	string | null	Inhalt des Briefs
data.date	string	Datum des Briefs (YYYY-MM-DD)
data.printed	boolean | null	Gibt an, ob der Brief gedruckt wurde
data.customer	object | null	Zugeordneter Kunde
data.customer.id	string (UUID)	Kunden-ID
data.customer.firstName	string	Vorname des Kunden
data.customer.lastName	string	Nachname des Kunden
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

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/patient-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	Patientenbrief nicht gefunden