Patients

Search for patients by email address, view patient profiles, and check patient intent status.

Create or Resolve Patient

Create a patient profile for a shop customer, or return the existing profile if the shop_uid and shop_customer_id pair already exists. This is step 1 for Patient Pass issuance (POST /wallet-passes needs that shop-customer link) and the supported create flow for Scheduling.

POST /v1/management/patients

Required permission: patient:write

curl -X POST "https://api.rxscale.com/v1/management/patients" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "shop_uid": "shop_123",
    "shop_customer_id": "customer_456",
    "email": "max@example.com",
    "fields": [
      {
        "field": "first_name",
        "value": "Max",
        "source": "shop"
      },
      {
        "field": "allergy_notes",
        "value": "Penicillin",
        "source": "questionnaire"
      }
    ]
  }'

string

required

UID of the shop the customer belongs to

string

required

The shop’s identifier for the customer

string

Optional patient email stored on the shop-patient mapping and used for patient lookup/search.

array

Optional patient profile fields to set for the shop customer. Each entry is { "field": "<field_key>", "value": <value>, "source": "shop" | "questionnaire" | "user" }. source defaults to shop and must match the field’s configured source in Settings → Profile Fields. A mismatch or unknown field key returns 404.

{
  "patient_profile_uid": "pp-abc123"
}

Search Patient by Email

Find a patient by their email address. Returns the most recently created patient whose shop-patient email or order email matches the given email.

GET /v1/management/patients?email={email}

string

required

The email address to search for

Required permission: patient:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/patients?email=max@example.com" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "uid": "pp-abc123",
  "data": {
    "display_name": "Max Mustermann",
    "email": "max@example.com",
    "date_of_birth": "1990-01-15"
  }
}

Error Responses

Status Code	Description
`400`	Missing or invalid email parameter
`404`	No patient found with the given email

Get Patient Profile

Retrieve a patient profile by UID.

GET /v1/management/patients/{patient_uid}

string

required

The patient UID

Required permission: patient:read

Example Request

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

Response

{
  "uid": "pp-abc123",
  "data": {
    "display_name": "Max Mustermann",
    "email": "max@example.com",
    "date_of_birth": "1990-01-15"
  }
}

Check Patient Intent

Check the intent return code for a patient. Returns a code indicating when the last signed submission for this intent was made.

GET /v1/management/patients/{patient_uid}/intent/{intent}

string

required

The patient UID

string

required

The intent identifier

Required permission: patient:read

Example Request

curl -X GET "https://api.rxscale.com/v1/management/patients/pp-abc123/intent/consultation" \
  -H "X-API-Key: your-api-key-here"

Response

{
  "return_code": "VALID"
}

Return Code Values

Code	Description
`VALID`	The patient has a valid, recent submission for this intent
`EXPIRED`	The patient’s last submission has expired
`NOT_FOUND`	No submission found for this intent

Delete Patient Profile Field

Delete a patient’s value for a single profile field.

DELETE /v1/management/patients/{patient_uid}/patient-profile-fields/{field_key}

string

required

The patient UID

string

required

Key of the profile field to delete the patient’s value for

string

Source of the field (shop, questionnaire, or user). Must match the profile field’s configured source and the source used when writing the value via Create or Resolve Patient. Defaults to shop.

The field key is the same value you send in fields[].field when setting a value via Create or Resolve Patient — for example first_name. Pass the same source you used when writing the value. Deleting a value therefore uses exactly the identifier you used to set it; no separate lookup is needed. Required permission: patient_profile_field:delete

This is a hard delete. The field value is removed from the patient’s profile, not archived or soft-deleted. An internal audit log entry recording the deletion (naming the API key that performed it) is written as part of the same call — afterwards, that log entry is the only remaining record that the value ever existed.

Example Request

curl -X DELETE "https://api.rxscale.com/v1/management/patients/pp-abc123/patient-profile-fields/first_name?source=shop" \
  -H "X-API-Key: your-api-key-here"

Response (200 OK)

{
  "message": "Field deleted successfully"
}

Error Responses

Status Code	Description
`400`	Invalid `source` query parameter
`401`	Missing or invalid API key
`403`	Missing `patient_profile_field:delete` permission
`404`	Patient not found, belongs to another organisation, the shop does not define a field with this key and source, or the patient does not have a value set for it

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Patients

Patients

Create or Resolve Patient

Search Patient by Email

Example Request

Response

Error Responses

Get Patient Profile

Example Request

Response

Check Patient Intent

Example Request

Response

Return Code Values

Delete Patient Profile Field

Example Request

Response (200 OK)

Error Responses

​Patients

​Create or Resolve Patient

​Search Patient by Email

​Example Request

​Response

​Error Responses

​Get Patient Profile

​Example Request

​Response

​Check Patient Intent

​Example Request

​Response

​Return Code Values

​Delete Patient Profile Field

​Example Request

​Response (200 OK)

​Error Responses

Patients

Create or Resolve Patient

Search Patient by Email

Example Request

Response

Error Responses

Get Patient Profile

Example Request

Response

Check Patient Intent

Example Request

Response

Return Code Values

Delete Patient Profile Field

Example Request

Response (200 OK)

Error Responses