Referral Source

Referral source of a patient

ReferralSource

created_at
string <date-time>
id
string <int64>
object
notes
string or null
object
object
object or null
referrer_type
string or null
Enum: "Patient" "Contact"
subcategory
string or null
updated_at
string <date-time>
{}

List referral sources

get/referral_sources
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
created_at date-time
id int64
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Get referral source
get/patients/{patient_id}/referral_source
SecuritybasicAuth 
Request 
path Parameters
patient_id
required
string <int64> 
 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}
Update referral source
patch/patients/{patient_id}/referral_source
SecuritybasicAuth 
Request 
path Parameters
patient_id
required
string <int64> 
 
Request Body schema: application/json
notes
string or null
 
referral_source_type_id
string <int64> 
referral source type id


 
referrer_id
string <int64> 
 
subcategory
string or null
 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "notes": "string",
  • "referrer_id": "1",
  • "referral_source_type_id": "1",
  • "subcategory": "string"
}
Response samples 
application/json
{}