API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

PATIENTS

Patients

List all dependents

List all patients

Create a patient

Retrieve a patient

Update a patient

Search for patients

Patients

The patient object contains a record of all available patients that belong to a clinic. The API allows you to create and update patients. It also allows you to list all patients and find individual patients.

List all dependents

This resource allows you to retrieve all dependents linked to a guardian patient.

Arguments

patient_id

string

Required

The ID of the guardian patient to list dependents for.

GET /api/clinic/patients/{patient_id}/dependents
curl "https://api-us-snd.fullscript.io/api/clinic/patients/{patient_id}/dependents" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

List all patients

This resource allows you to list all of a clinic's patients.

Arguments

patient_type

string

The type of patient to filter by. Valid options are all, dependent, or guardian. If not provided, all patients will be returned.

GET /api/clinic/patients
curl "https://api-us-snd.fullscript.io/api/clinic/patients" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Create a patient

Creates a new patient

Arguments

email

string

Required

Unique Email for the Patient

first_name

string

Required

Patient's first name

last_name

string

Required

Patient's last name

date_of_birth

string

Patient's date of birth in the format yyyy-mm-dd

gender

string

Biological sex of the patient. Valid options are 'male', 'female', or 'x'.

mobile_number

string

Patient's mobile number in the format +12223334444

send_welcome_email

string

Sends a welcome email to the patient upon successful creation. Defaults to true.

discount

string

Patient discount level (in percentage). This discount does not include the clinic discount. Defaults to 0.

metadata

object

Metadata to be attached to the patient.

id

string

Your system's unique patient identifier.

POST /api/clinic/patients
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/patients" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "email": "string", "first_name": "string", "last_name": "string", "date_of_birth": "string", "gender": "string", "mobile_number": "string", "send_welcome_email": "string", "discount": "string", "metadata": { "id": "string" } }'

Responses

Retrieve a patient

Retrieves an existing patient. You need to supply the unique ID for the patient.

Arguments

id

string

Required

Unique ID for the Patient

GET /api/clinic/patients/{id}
curl "https://api-us-snd.fullscript.io/api/clinic/patients/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses

Update a patient

Updates a specific patient with the attributes that you pass in. Parameters not provided will remain unchanged.

Arguments

id

string

Required

Unique ID for the Patient

email

string

Unique Email for the Patient

first_name

string

Patient's first name

last_name

string

Patient's last name

date_of_birth

string

Patient's date of birth in the format yyyy-mm-dd

gender

string

Biological sex of the patient. Valid options are 'male', 'female', or 'x'.

mobile_number

string

Patient's mobile number in the format +12223334444

discount

string

Patient discount level (in percentage). This discount does not include the clinic discount. Defaults to 0.

metadata

object

Metadata to be attached to the patient.

id

string

Your system's unique patient identifier.

PATCH /api/clinic/patients/{id}
curl -X 'PATCH' "https://api-us-snd.fullscript.io/api/clinic/patients/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "email": "string", "first_name": "string", "last_name": "string", "date_of_birth": "string", "gender": "string", "mobile_number": "string", "discount": "string", "metadata": { "id": "string" } }'

Responses

Search for patients

This resource allows you to search for patients by first_name, last_name, or by email.

Arguments

query

string

Search for patients matching a query string.

patient_type

string

Filter by patient type. Valid options are all, dependent, or guardian. If not provided, patients with no dependents will be returned.

GET /api/clinic/search/patients
curl "https://api-us-snd.fullscript.io/api/clinic/search/patients" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses