API OVERVIEW

Pagination

Request IDs

Versioning

Rate Limits

CLINIC

Clinic

Retrieve a clinic

PATIENTS

Returns a redirect_url that enables access to a draft treatment plan. This endpoint optionally finds or creates a patient record to associate with the treatment plan. It supports dependent accounts and includes a user interface that allows practitioners to manually match patients and practitioners if automatic matching is unsuccessful. When a match is automatically found, the patient is preselected for the practitioner.

OAuth scopes required:

  • clinic:write - required for all requests to this endpoint.
  • patients:write - required if the request may result in patient creation.

Arguments

treatment_plan

object

Treatment plan information for dynamic link.

practitioner_id

string

Practitioner's id used to create the draft treatment_plan.

patient

object

Patient information used for creating a match with a Fullscript patient, or pre-filling information to create a new patient in Fullscript

id

string

Fullscript patient id.

external_id

string

Unique patient id to create a match with a fullscript 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.

send_welcome_email

string

Sends a welcome email upon successful patient creation and treatment plan creation. Defaults to true.

entrypoint

string

Specifies which page the redirect_url will open. Defaults to "catalog" if not specified.

  • catalog: Starts the user on the product catalog page (default).
  • labs: Starts the user on the labs page.
POST /api/clinic/dynamic_links/gateway/treatment_plans
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/dynamic_links/gateway/treatment_plans" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "treatment_plan": { "practitioner_id": "string" }, "patient": { "id": "string", "external_id": "string", "email": "string", "first_name": "string", "last_name": "string", "date_of_birth": "string", "gender": "string", "mobile_number": "string", "discount": "string", "send_welcome_email": "string" }, "entrypoint": "string" }'

Responses

Returns a redirect_url for a new treatment plan.

Arguments

No arguments

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

Responses

fyi
fyi

This endpoint does not support dependent accounts. If you are working with dependent accounts, use the Create a Draft Treatment Plan Link with Patient Matching UI endpoint instead.

Returns a redirect_url that enables access to a draft treatment plan. This endpoint optionally finds or creates a patient record to associate with the treatment plan.

OAuth scopes required:

  • clinic:write - required for all requests to this endpoint.
  • patients:write - required if the request may result in patient creation.

Arguments

treatment_plan

object

Required

Treatment plan information for dynamic link.

practitioner_id

string

Required

Practitioner's id used to create the draft treatment_plan.

patient

object

Find or create a 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.

send_welcome_email

string

Sends a welcome email upon successful patient creation and treatment plan creation. Defaults to true.

entrypoint

string

Specifies which page the redirect_url will open. Defaults to "catalog" if not specified.

  • catalog: (default) Starts the user on the product catalog page.
  • labs: Starts the user on the labs page.
POST /api/clinic/dynamic_links/treatment_plans
curl -X 'POST' "https://api-us-snd.fullscript.io/api/clinic/dynamic_links/treatment_plans" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX' \ -d $'{ "treatment_plan": { "practitioner_id": "string" }, "patient": { "email": "string", "first_name": "string", "last_name": "string", "date_of_birth": "string", "gender": "string", "mobile_number": "string", "discount": "string", "send_welcome_email": "string" }, "entrypoint": "string" }'

Responses

Returns a redirect_url for editing an existing treatment plan. The treatment plan provided must have a state of draft or active.

Arguments

id

string

Required

Unique ID for the Treatment Plan

entrypoint

string

Target treatment plan page to open with the redirect_url. Defaults to "catalog"

  • catalog: (default) Starts the user on the product catalog page.
  • labs: Starts the user on the labs page.
GET /api/clinic/dynamic_links/treatment_plans/{id}
curl "https://api-us-snd.fullscript.io/api/clinic/dynamic_links/treatment_plans/{id}" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXX'

Responses