Patients

7 endpoints in this category.

GET/patient/my-patients

Get My Patients

Get the list of patients assigned to the authenticated clinician with search and pagination.

Authentication:Required — Authorization: Bearer <token>

Query Parameters

NameTypeRequiredDescription
per_pageintegerNoResults per page
pageintegerNoPage number
search_by_namestringNoSearch by patient name

Response Fields

NameTypeRequiredDescription
dataPatient[]YesArray of patients
meta.last_pageintegerYesTotal number of pages

Error Codes

StatusMeaning
401Unauthorized

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/my-patients' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'
GET/patient/chart-details/:referralUuid

Get Chart Details

Get detailed chart information for a patient referral.

Authentication:Required — Authorization: Bearer <token>

Path Parameters

NameTypeRequiredDescription
referralUuidstringYesPatient referral UUID

Response Fields

NameTypeRequiredDescription
dataChartDetailYesChart detail object

Error Codes

StatusMeaning
404Referral not found

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/chart-details/:referralUuid' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'
GET/patient/general-summaryComing Soon

Get Patient Summary

Get a general summary of patient data with optional date range filtering.

Authentication:Required — Authorization: Bearer <token>

Query Parameters

NameTypeRequiredDescription
dateRangestringNoDate range filter

Response Fields

NameTypeRequiredDescription
dataobjectYesSummary data

Error Codes

StatusMeaning
401Unauthorized

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/general-summary' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'
POST/patient/get-scheduled-visits/:referralUuidComing Soon

Get Patient Scheduled Visits

Get scheduled visits for a specific patient referral, filterable by month and year.

Authentication:Required — Authorization: Bearer <token>

Path Parameters

NameTypeRequiredDescription
referralUuidstringYesPatient referral UUID

Request Body

NameTypeRequiredDescription
filter_monthstringNoMonth filter (01-12)
filter_yearstringNoYear filter (YYYY)

Response Fields

NameTypeRequiredDescription
dataScheduledVisit[]YesArray of scheduled visits

Error Codes

StatusMeaning
404Referral not found

Code Examples

curl -X POST 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/get-scheduled-visits/:referralUuid' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "filter_month": "your_filter_month",
  "filter_year": "your_filter_year"
}'
POST/patient/create

Create Patient

Create a new patient record.

Authentication:Required — Authorization: Bearer <token>

Request Body

NameTypeRequiredDescription
first_namestringYesPatient first name
last_namestringYesPatient last name
emailstringNoEmail address
phonestringNoPhone number
addressstringNoAddress

Response Fields

NameTypeRequiredDescription
uuidstringYesCreated patient UUID

Error Codes

StatusMeaning
422Validation error

Code Examples

curl -X POST 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/create' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "email": "your_email",
  "phone": "your_phone",
  "address": "your_address"
}'
PUT/patient/update/:uuid

Update Patient

Update an existing patient's information.

Authentication:Required — Authorization: Bearer <token>

Path Parameters

NameTypeRequiredDescription
uuidstringYesPatient UUID

Request Body

NameTypeRequiredDescription
first_namestringNoPatient first name
last_namestringNoPatient last name
emailstringNoEmail address
phonestringNoPhone number
addressstringNoAddress

Error Codes

StatusMeaning
404Patient not found
422Validation error

Code Examples

curl -X PUT 'https://visitnote-api-production.up.railway.app/api/therapist/v1/patient/update/:uuid' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "email": "your_email",
  "phone": "your_phone",
  "address": "your_address"
}'
GET/document/listComing Soon

Get Documents

Get the list of documents for the authenticated clinician.

Authentication:Required — Authorization: Bearer <token>

Response Fields

NameTypeRequiredDescription
dataDocument[]YesArray of documents

Error Codes

StatusMeaning
401Unauthorized

Code Examples

curl -X GET 'https://visitnote-api-production.up.railway.app/api/therapist/v1/document/list' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'