Telemedicine Providers

A telemedicine provider is an external partner connected to your organisation to submit prescriptions on behalf of its own patients. Use these endpoints to see which providers are connected, to control what they may submit, and to link your SKUs to a provider.

Connecting a new provider, or changing its name, identifier, or API key, is done in the Admin Tool. These endpoints cover an existing provider’s settings and the SKU mappings that connect that provider to your catalog.

Read permission: telemedicine_provider:read
Write permission: telemedicine_provider:write

List Telemedicine Providers

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
}

Get Provider Settings

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
}

Update Provider Settings

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

allow_non_qes_signed_prescriptions is required. Enabling it lets this provider submit prescriptions that carry no qualified electronic signature (QES).

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 mappings

A SKU mapping connects one of your SKUs to a telemedicine provider and stores the identifier that provider uses for the SKU (external_id). is_active pauses and resumes that link:

true — the mapping is active. deactivated_at is null. The provider can resolve this SKU.
false — the mapping is paused. deactivated_at is the unix timestamp when it was paused. The row is kept, but the provider’s catalog and checkout no longer resolve this SKU.

Deleting a mapping removes the link. Pausing it does not. List and get include paused mappings so you can resume them.

List SKU mappings

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

string

required

UID of the SKU whose mappings you want.

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
}

Get a SKU mapping

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

string

required

UID of the SKU.

string

required

UID of the mapping.

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"

The response is one mapping object, with the same fields as each item in the list.

Create a SKU mapping

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

The SKU and the provider must both belong to your organisation. The new mapping is active.

string

required

UID of the SKU to link.

string

required

UID of the telemedicine provider.

string

The provider’s own identifier for this SKU. Omit it when the provider will send your SKU UID.

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

Update a SKU mapping

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

Send at least one of is_active or external_id.

string

required

UID of the SKU.

string

required

UID of the mapping.

boolean

false pauses the mapping. true resumes it.

string

Replacement for the provider’s own identifier for this SKU.

Pause:

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

Resume with "is_active": true. deactivated_at returns to null.

Delete a SKU mapping

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

string

required

UID of the SKU.

string

required

UID of the mapping.

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"

A successful delete returns 204 with an empty body. A SKU, provider, or mapping that belongs to another organisation is returned as 404, the same as an unknown uid.

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Telemedicine Providers

Telemedicine Providers

List Telemedicine Providers

Get Provider Settings

Update Provider Settings

SKU mappings

List SKU mappings

Get a SKU mapping

Create a SKU mapping

Update a SKU mapping

Delete a SKU mapping

​Telemedicine Providers

​List Telemedicine Providers

​Get Provider Settings

​Update Provider Settings

​SKU mappings

​List SKU mappings

​Get a SKU mapping

​Create a SKU mapping

​Update a SKU mapping

​Delete a SKU mapping

Telemedicine Providers

List Telemedicine Providers

Get Provider Settings

Update Provider Settings

SKU mappings

List SKU mappings

Get a SKU mapping

Create a SKU mapping

Update a SKU mapping

Delete a SKU mapping