Fragebögen

Verwalten Sie die Aufnahmefragebögen, die Patienten für Ihre Organisation ausfüllen: bestehende Fragebögen auflisten und einsehen, neue anlegen, deren Metadaten aktualisieren und das SurveyJS-Modell/Theme aktualisieren, das den Fragebogen selbst darstellt.

Dieser Endpoint-Satz deckt nur Fragebogen-Metadaten und das SurveyJS-Modell ab. Funktionen wie Dateien, CSS-Snippets, Archivierung, Duplizierung und Produktempfehlungs-Zuordnungen werden im Admin Tool verwaltet, nicht über diese API.

Fragebögen auflisten

GET /v1/management/questionnaires

integer

Standard:"0"

Seitennummer (0-indexiert). Wird bei all=true ignoriert.

integer

Standard:"25"

Anzahl der Fragebögen pro Seite. Wird bei all=true ignoriert.

string

Standard:""

Filter nach Identifier-Teilstring (Groß-/Kleinschreibung wird nicht beachtet)

boolean

Standard:"false"

Archivierte (true) oder nicht archivierte (false) Fragebögen zurückgeben

boolean

Standard:"false"

Die vollständige Ergebnismenge ohne Paginierung zurückgeben

Erforderliche Berechtigung: questionnaire:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/questionnaires?page=0&limit=25&search=intake" \
  -H "X-API-Key: your-api-key-here"

Antwort

Listeneinträge lassen model, mapping, theme, meta_data und url aus — verwenden Sie Einen Fragebogen abrufen, um diese zu lesen.

{
  "data": [
    {
      "uid": "quest-abc123",
      "identifier": "weight-loss-intake",
      "version": "1",
      "type": "PRODUCT_RECOMMENDER",
      "archived": false,
      "store_anamnesis_at_patient_level": false,
      "organisation_uid": "org-xyz789",
      "created_at": 1717430400,
      "updated_at": 1717430400,
      "deleted_at": null
    }
  ],
  "totalRegistries": 1,
  "totalPages": 1
}

Antwortfelder

Feld	Typ	Beschreibung
`data`	array	Fragebögen der Organisation
`data[].uid`	string	Fragebogen-UID
`data[].identifier`	string	Fragebogen-Identifier
`data[].type`	string	Fragebogentyp (z.B. `PRODUCT_RECOMMENDER`, `DIRECT_TO_CART`)
`data[].version`	string	Fragebogen-Schemaversion
`data[].archived`	boolean	Ob der Fragebogen archiviert ist
`data[].store_anamnesis_at_patient_level`	boolean	Ob Einreichungen zusätzlich im Patientenprofil gespeichert werden
`data[].organisation_uid`	string	UID der besitzenden Organisation
`totalRegistries`	integer	Gesamtanzahl passender Fragebögen
`totalPages`	integer	Gesamtanzahl der Seiten (`1` bei `all=true`)

Einen Fragebogen abrufen

GET /v1/management/questionnaires/{questionnaire_uid}

string

erforderlich

Die Fragebogen-UID

Erforderliche Berechtigung: questionnaire:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/questionnaires/quest-abc123" \
  -H "X-API-Key: your-api-key-here"

Antwort

Enthält das SurveyJS-model/theme sowie sämtliche Beziehungen des Datensatzes. Dies sind rohe Verknüpfungs-Arrays aus dem zugrunde liegenden Datenmodell und keine kuratierte öffentliche Struktur — erwarten Sie UIDs (keine verschachtelten Objekte) und bei einem tatsächlich genutzten Fragebogen potenziell lange Arrays; leer sind sie typischerweise nur bei einem Fragebogen, der ausschließlich über diese API angelegt und verwaltet wird:

{
  "uid": "quest-abc123",
  "identifier": "weight-loss-intake",
  "version": "1",
  "type": "PRODUCT_RECOMMENDER",
  "url": null,
  "model": {
    "title": "Weight Loss Intake",
    "pages": [
      {
        "name": "BasicInfo",
        "elements": [
          {"type": "text", "name": "age", "title": "Age"}
        ]
      }
    ]
  },
  "mapping": null,
  "theme": null,
  "meta_data": {"save_number": 1},
  "archived": false,
  "store_anamnesis_at_patient_level": false,
  "organisation_uid": "org-xyz789",
  "categories": [],
  "products": [],
  "recommendations": [],
  "doctors": [],
  "patient_profile_fields": [],
  "anamnesis_list": [],
  "created_at": 1717430400,
  "updated_at": 1717430500,
  "deleted_at": null
}

Antwortfelder

Feld	Typ	Beschreibung
`uid`	string	Fragebogen-UID
`identifier`	string	Fragebogen-Identifier
`version`	string	Fragebogen-Schemaversion
`type`	string	Fragebogentyp
`model`	object \| null	SurveyJS-Modell (Seiten, Elemente)
`mapping`	array \| null	Interne Zuordnung von Antworten zu Attributen
`theme`	object \| null	SurveyJS-Theme
`meta_data`	object \| null	Interne Metadaten, inklusive `save_number` (siehe Fragebogen-Modell aktualisieren)
`archived`	boolean	Ob der Fragebogen archiviert ist
`store_anamnesis_at_patient_level`	boolean	Ob Einreichungen zusätzlich im Patientenprofil gespeichert werden
`organisation_uid`	string	UID der besitzenden Organisation
`categories`	array von Strings	UIDs der Kategorie-Zuordnungszeilen des Fragebogens (Autorenfunktion des Admin Tools)
`products`	array von Strings	UIDs der Fragebogen-zu-Produkt-Verknüpfungszeilen (nicht die UID des verknüpften Produkts selbst)
`recommendations`	array von Strings	UIDs der Produktempfehlungszeilen des Fragebogens
`doctors`	array von Strings	UIDs der Ärzte, denen dieser Fragebogen zugeordnet ist
`patient_profile_fields`	array von Objekten	`{"model_key": ..., "questionnaire_uid": ...}` für jede Patientenprofilfeld-Zuordnung (diese Verknüpfungstabelle hat einen zusammengesetzten Schlüssel, keine eigene UID)
`anamnesis_list`	array von Strings	UIDs jeder je für diesen Fragebogen erstellten Einreichung — unbegrenzt, kann bei einem stark genutzten Fragebogen sehr groß werden; nutzen Sie für Anzahlen stattdessen die Fragebogen-Einreichungsstatistiken

Die Autorenfunktionen des Admin Tools (individuelles CSS, Datei-Assets, Archivierung, Duplizierung) werden über diese API nicht bereitgestellt; die obigen Arrays spiegeln nur die Verknüpfungen, nicht diese Autorenfunktionen.

Fehlerantworten

Statuscode	Beschreibung
`401`	Fehlende oder ungültige Anmeldeinformationen
`403`	Gültige Anmeldeinformationen, aber `questionnaire:read` fehlt
`404`	Fragebogen nicht gefunden oder gehört zu einer anderen Organisation

Einen Fragebogen anlegen

POST /v1/management/questionnaires

Erforderliche Berechtigung: questionnaire:write

string

erforderlich

Fragebogen-Identifier

string

erforderlich

Fragebogentyp (z.B. PRODUCT_RECOMMENDER, DIRECT_TO_CART)

Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/questionnaires" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"identifier": "weight-loss-intake", "type": "PRODUCT_RECOMMENDER"}'

Antwort

Liefert 201 mit dem angelegten Fragebogen in der gleichen Struktur wie Einen Fragebogen abrufen. model, mapping, theme und meta_data sind null, bis sie über Fragebogen-Modell aktualisieren gesetzt werden.

Fehlerantworten

Statuscode	Beschreibung
`400`	`identifier` oder `type` fehlt
`401`	Fehlende oder ungültige Anmeldeinformationen
`403`	Gültige Anmeldeinformationen, aber `questionnaire:write` fehlt

Fragebogen-Metadaten aktualisieren

PATCH /v1/management/questionnaires/{questionnaire_uid}

Aktualisiert Fragebogen-Metadaten. Alle Body-Felder sind optional; senden Sie nur die Felder, die Sie ändern möchten. SurveyJS-Modell und Theme werden hier nicht angenommen. Veröffentlichen Sie diese über Fragebogen-Modell aktualisieren. Erforderliche Berechtigung: questionnaire:write

string

erforderlich

Die Fragebogen-UID

string

Neuer Identifier

string

Neuer Fragebogentyp

boolean

Ob Einreichungen zusätzlich im Patientenprofil gespeichert werden

array

Interne Zuordnung von Antworten zu Attributen (Array von Objekten oder null).

Beispielanfrage

curl -X PATCH "https://api.rxscale.com/v1/management/questionnaires/quest-abc123" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"identifier": "weight-loss-intake-v2"}'

Antwort

Liefert 200 mit dem aktualisierten Fragebogen in der gleichen Struktur wie Einen Fragebogen abrufen.

Fehlerantworten

Statuscode	Beschreibung
`400`	Ungültiger Payload
`401`	Fehlende oder ungültige Anmeldeinformationen
`403`	Gültige Anmeldeinformationen, aber `questionnaire:write` fehlt
`404`	Fragebogen nicht gefunden oder gehört zu einer anderen Organisation

Fragebogen-Modell aktualisieren

PATCH /v1/management/questionnaires/{questionnaire_uid}/model

Ersetzt das Live-SurveyJS-Modell eines Fragebogens der eigenen Organisation. Die Änderung wird sofort veröffentlicht und ein älterer automatisch gespeicherter Entwurf wird entfernt.

Dieser Endpunkt ändert den Fragebogen, den Patienten sehen, sofort. Senden Sie das vollständige SurveyJS-Modell und keinen partiellen Patch.

Erforderliche Berechtigung: questionnaire:write

string

erforderlich

Die Fragebogen-UID

object

erforderlich

Das vollständige SurveyJS-Fragebogenmodell, das veröffentlicht werden soll.

object

Vollständiges SurveyJS-Theme. Weglassen, um das aktuelle Theme zu behalten.

Beispielanfrage

curl -X PATCH "https://api.rxscale.com/v1/management/questionnaires/quest-abc123/model" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": {
      "title": "Weight Loss Intake",
      "pages": [
        {"name": "BasicInfo", "elements": [{"type": "text", "name": "age", "title": "Age"}]}
      ]
    }
  }'

Antwort

Liefert 200 nur mit uid, model und theme.

Fehlerantworten

Statuscode	Beschreibung
`400`	`model` fehlt oder Payload ist ungültig
`401`	Fehlende oder ungültige Anmeldeinformationen
`403`	Gültige Anmeldeinformationen, aber `questionnaire:write` fehlt
`404`	Fragebogen nicht gefunden oder gehört zu einer anderen Organisation

Fragebogen-Einreichungsstatistiken

GET /v1/management/questionnaires/{questionnaire_uid}/statistics/submissions

Liefert die Anzahl der Einreichungen pro Tag für einen Fragebogen.

Für organisationsweite Statistiken (Bestell-/Rezeptvolumen, Arzt- und Produktanzahlen, Einreichungen über alle Fragebögen) siehe Statistiken.

Erforderliche Berechtigung: statistics:read

string

erforderlich

Die Fragebogen-UID

string

Beginn des Datumsbereichs (ISO 8601). Standardmäßig 30 Tage vor end_date.

string

Ende des Datumsbereichs (ISO 8601). Standardmäßig jetzt.

Ohne angegebenen Datumsbereich werden standardmäßig die letzten 31 Tage (heute und die vorherigen 30 Tage) verwendet. Der Bereich zwischen start_date und end_date darf 30 Tage nicht überschreiten.

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/questionnaires/quest-abc123/statistics/submissions?start_date=2026-08-01T00:00:00&end_date=2026-08-31T23:59:59" \
  -H "X-API-Key: your-api-key-here"

Antwort

Jeder Tag im Bereich ist enthalten, mit 0 für Tage ohne Einreichungen:

[
  {"date": "2026-08-01", "count": 3},
  {"date": "2026-08-02", "count": 0},
  {"date": "2026-08-03", "count": 5}
]

Antwortfelder

Feld	Typ	Beschreibung
`date`	string	Kalenderdatum (`YYYY-MM-DD`)
`count`	integer	Anzahl der Einreichungen an diesem Tag

Fehlerantworten

Statuscode	Beschreibung
`400`	Der Datumsbereich überschreitet 30 Tage
`401`	Fehlende oder ungültige Anmeldeinformationen
`403`	Gültige Anmeldeinformationen, aber `statistics:read` fehlt
`404`	Fragebogen nicht gefunden oder gehört zu einer anderen Organisation

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Fragebögen

Fragebögen

Fragebögen auflisten

Beispielanfrage

Antwort

Antwortfelder

Einen Fragebogen abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Einen Fragebogen anlegen

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Metadaten aktualisieren

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Modell aktualisieren

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Einreichungsstatistiken

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

​Fragebögen

​Fragebögen auflisten

​Beispielanfrage

​Antwort

​Antwortfelder

​Einen Fragebogen abrufen

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

​Einen Fragebogen anlegen

​Beispielanfrage

​Antwort

​Fehlerantworten

​Fragebogen-Metadaten aktualisieren

​Beispielanfrage

​Antwort

​Fehlerantworten

​Fragebogen-Modell aktualisieren

​Beispielanfrage

​Antwort

​Fehlerantworten

​Fragebogen-Einreichungsstatistiken

​Beispielanfrage

​Antwort

​Antwortfelder

​Fehlerantworten

Fragebögen

Fragebögen auflisten

Beispielanfrage

Antwort

Antwortfelder

Einen Fragebogen abrufen

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten

Einen Fragebogen anlegen

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Metadaten aktualisieren

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Modell aktualisieren

Beispielanfrage

Antwort

Fehlerantworten

Fragebogen-Einreichungsstatistiken

Beispielanfrage

Antwort

Antwortfelder

Fehlerantworten