Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rxscale.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Patients

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

​
Search Patient by Email

Find a patient by their email address. Returns the most recently created patient whose orders contain the given email. 
GET /v1/management/patients?email={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 CodeDescription
400Missing or invalid email parameter
404No patient found with the given email

​
Get Patient Profile

Retrieve a patient profile by UID. 
GET /v1/management/patients/{patient_uid}
​
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}
​
patient_uid
string
required
The patient UID
​
intent
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

CodeDescription
VALIDThe patient has a valid, recent submission for this intent
EXPIREDThe patient’s last submission has expired
NOT_FOUNDNo submission found for this intent