Telemedizin-Anbieter

Ein Telemedizin-Anbieter ist ein externer Partner, der mit Ihrer Organisation verbunden ist, um Rezepte im Namen seiner eigenen Patienten einzureichen. Nutzen Sie diese Endpoints, um zu sehen, welche Anbieter verbunden sind, um zu steuern, was sie einreichen dürfen, und um Ihre SKUs mit einem Anbieter zu verknüpfen.

Einen neuen Anbieter zu verbinden oder seinen Namen, seine Kennung oder seinen API-Schlüssel zu ändern, erfolgt im Admin Tool. Diese Endpoints decken die Einstellungen eines bestehenden Anbieters und die SKU-Verknüpfungen ab, die diesen Anbieter mit Ihrem Katalog verbinden.

Leseberechtigung: telemedicine_provider:read
Schreibberechtigung: telemedicine_provider:write

Telemedizin-Anbieter auflisten

GET /v1/management/telemedicine-providers

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

{
  "data": [
    {
      "uid": "provider-123",
      "display_name": "Partner Clinic",
      "identifier": "partner-clinic"
    }
  ],
  "total": 1
}

Anbieter-Einstellungen abrufen

GET /v1/management/telemedicine-providers/{uid}/settings

curl -X GET "https://api.rxscale.com/v1/management/telemedicine-providers/provider-123/settings" \
  -H "X-API-Key: your-api-key-here"

{
  "allow_non_qes_signed_prescriptions": false
}

Anbieter-Einstellungen aktualisieren

PATCH /v1/management/telemedicine-providers/{uid}/settings

allow_non_qes_signed_prescriptions ist erforderlich. Wird dieser Wert aktiviert, darf dieser Anbieter Rezepte ohne qualifizierte elektronische Signatur (QES) einreichen.

curl -X PATCH "https://api.rxscale.com/v1/management/telemedicine-providers/provider-123/settings" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "allow_non_qes_signed_prescriptions": true
  }'

{
  "allow_non_qes_signed_prescriptions": true
}

SKU-Verknüpfungen

Eine SKU-Verknüpfung verbindet eine Ihrer SKUs mit einem Telemedizin-Anbieter und speichert die Kennung, die dieser Anbieter für die SKU verwendet (external_id). is_active pausiert und setzt diese Verknüpfung fort:

true — die Verknüpfung ist aktiv. deactivated_at ist null. Der Anbieter kann diese SKU auflösen.
false — die Verknüpfung ist pausiert. deactivated_at ist der Unix-Zeitstempel des Pausierens. Der Datensatz bleibt erhalten, aber Katalog und Checkout des Anbieters lösen diese SKU nicht mehr auf.

Das Löschen einer Verknüpfung entfernt die Verbindung. Das Pausieren nicht. Liste und Abruf enthalten pausierte Verknüpfungen, damit Sie sie wieder fortsetzen können.

SKU-Verknüpfungen auflisten

GET /v1/management/skus/{sku_uid}/telemedicine-provider-skus

string

erforderlich

UID der SKU, deren Verknüpfungen Sie abrufen möchten.

curl -X GET "https://api.rxscale.com/v1/management/skus/sku-123/telemedicine-provider-skus" \
  -H "X-API-Key: your-api-key-here"

{
  "data": [
    {
      "uid": "mapping-123",
      "telemedicine_provider_uid": "provider-123",
      "sku_uid": "sku-123",
      "external_id": "partner-sku-42",
      "deactivated_at": null,
      "is_active": true,
      "telemedicine_provider": {
        "uid": "provider-123",
        "display_name": "Partner Clinic",
        "identifier": "partner-clinic"
      }
    }
  ],
  "total": 1
}

Eine SKU-Verknüpfung abrufen

GET /v1/management/skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid}

string

erforderlich

UID der SKU.

string

erforderlich

UID der Verknüpfung.

curl -X GET "https://api.rxscale.com/v1/management/skus/sku-123/telemedicine-provider-skus/mapping-123" \
  -H "X-API-Key: your-api-key-here"

Die Antwort ist ein Verknüpfungsobjekt mit denselben Feldern wie ein Eintrag in der Liste.

Eine SKU-Verknüpfung anlegen

POST /v1/management/skus/{sku_uid}/telemedicine-provider-skus

Die SKU und der Anbieter müssen beide zu Ihrer Organisation gehören. Die neue Verknüpfung ist aktiv.

string

erforderlich

UID der zu verknüpfenden SKU.

string

erforderlich

UID des Telemedizin-Anbieters.

string

Die eigene Kennung des Anbieters für diese SKU. Weglassen, wenn der Anbieter Ihre SKU-UID sendet.

curl -X POST "https://api.rxscale.com/v1/management/skus/sku-123/telemedicine-provider-skus" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "telemedicine_provider_uid": "provider-123",
    "external_id": "partner-sku-42"
  }'

{
  "uid": "mapping-123",
  "telemedicine_provider_uid": "provider-123",
  "sku_uid": "sku-123",
  "external_id": "partner-sku-42",
  "deactivated_at": null,
  "is_active": true,
  "telemedicine_provider": {
    "uid": "provider-123",
    "display_name": "Partner Clinic",
    "identifier": "partner-clinic"
  }
}

Eine SKU-Verknüpfung aktualisieren

PATCH /v1/management/skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid}

Senden Sie mindestens eines der Felder is_active oder external_id.

string

erforderlich

UID der SKU.

string

erforderlich

UID der Verknüpfung.

boolean

false pausiert die Verknüpfung. true setzt sie fort.

string

Ersatz für die eigene Kennung des Anbieters für diese SKU.

Pausieren:

curl -X PATCH "https://api.rxscale.com/v1/management/skus/sku-123/telemedicine-provider-skus/mapping-123" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "is_active": false
  }'

{
  "uid": "mapping-123",
  "telemedicine_provider_uid": "provider-123",
  "sku_uid": "sku-123",
  "external_id": "partner-sku-42",
  "deactivated_at": 1711929600,
  "is_active": false,
  "telemedicine_provider": {
    "uid": "provider-123",
    "display_name": "Partner Clinic",
    "identifier": "partner-clinic"
  }
}

Fortsetzen mit "is_active": true. deactivated_at wird wieder null.

Eine SKU-Verknüpfung löschen

DELETE /v1/management/skus/{sku_uid}/telemedicine-provider-skus/{telemedicine_provider_sku_uid}

string

erforderlich

UID der SKU.

string

erforderlich

UID der Verknüpfung.

curl -X DELETE "https://api.rxscale.com/v1/management/skus/sku-123/telemedicine-provider-skus/mapping-123" \
  -H "X-API-Key: your-api-key-here"

Ein erfolgreiches Löschen liefert 204 mit leerem Body. Eine SKU, ein Anbieter oder eine Verknüpfung einer anderen Organisation wird mit 404 beantwortet, genau wie eine unbekannte UID.

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Telemedizin-Anbieter

Telemedizin-Anbieter

Telemedizin-Anbieter auflisten

Anbieter-Einstellungen abrufen

Anbieter-Einstellungen aktualisieren

SKU-Verknüpfungen

SKU-Verknüpfungen auflisten

Eine SKU-Verknüpfung abrufen

Eine SKU-Verknüpfung anlegen

Eine SKU-Verknüpfung aktualisieren

Eine SKU-Verknüpfung löschen

​Telemedizin-Anbieter

​Telemedizin-Anbieter auflisten

​Anbieter-Einstellungen abrufen

​Anbieter-Einstellungen aktualisieren

​SKU-Verknüpfungen

​SKU-Verknüpfungen auflisten

​Eine SKU-Verknüpfung abrufen

​Eine SKU-Verknüpfung anlegen

​Eine SKU-Verknüpfung aktualisieren

​Eine SKU-Verknüpfung löschen

Telemedizin-Anbieter

Telemedizin-Anbieter auflisten

Anbieter-Einstellungen abrufen

Anbieter-Einstellungen aktualisieren

SKU-Verknüpfungen

SKU-Verknüpfungen auflisten

Eine SKU-Verknüpfung abrufen

Eine SKU-Verknüpfung anlegen

Eine SKU-Verknüpfung aktualisieren

Eine SKU-Verknüpfung löschen