API docs by Redocly

Therapist Practice & Clients (1.0.0)

Download OpenAPI specification:

Practice info, client management, invitations, groups and email communications

apis

apis_therapist_organization_list

Creates or updates an Organization record, and retrieves organizations by therapist.

POST — If "id" is present in the body, performs a partial update on the existing organization. Otherwise creates a new organization record.

GET /{therapistUserId}/ — Returns all organizations associated with the given therapist_user_id. If no pk is provided, returns all active organizations. Returns 204 if no matching organizations are found.

Authorizations:
cookieAuthbasicAuthNone

Responses

Response samples

Content type
application/json
[
  • {
    }
]

apis_therapist_organization_create

Creates or updates an Organization record, and retrieves organizations by therapist.

POST — If "id" is present in the body, performs a partial update on the existing organization. Otherwise creates a new organization record.

GET /{therapistUserId}/ — Returns all organizations associated with the given therapist_user_id. If no pk is provided, returns all active organizations. Returns 204 if no matching organizations are found.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
name
string or null <= 255 characters
therapist_user_id
integer or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "therapist_user_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "therapist_user_id": 0
}

apis_therapist_organization_retrieve

Creates or updates an Organization record, and retrieves organizations by therapist.

POST — If "id" is present in the body, performs a partial update on the existing organization. Otherwise creates a new organization record.

GET /{therapistUserId}/ — Returns all organizations associated with the given therapist_user_id. If no pk is provided, returns all active organizations. Returns 204 if no matching organizations are found.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
integer

A unique integer value identifying this organization.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "therapist_user_id": 0
}

apis_user_therapist_practiceinfo_create

Creates or updates all sections of a therapist's practice profile in a single request. Requires "userId" in the request body. Processes four profile sections in sequence:

  • credentials: Professional licences/certifications. Items with a non-null "id" are updated; items with id=null are created.
  • theoreticalOrientation: Therapeutic modalities, each with nested "UserInterventionTech" entries which are also individually upserted.
  • populations: Patient population groups the therapist works with.
  • specialties: Clinical specialty areas.

Returns {"success": true} on completion.

Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
userloginname
string or null <= 255 characters
role
string or null <= 255 characters
firstName
string or null <= 255 characters
lastName
string or null <= 255 characters
emailid
string or null <email> <= 255 characters
gender
string or null <= 255 characters
phoneNumber
string or null <= 20 characters
dob
string or null <date>
image
required
string
timezone
string or null <= 155 characters
required
Array of objects (Address)
loginid
string or null <= 255 characters
orgid
integer or null
npi
string or null <= 128 characters
is_org_admin
boolean or null
Default: false

Responses

Request samples

Content type
{
  • "userloginname": "string",
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailid": "user@example.com",
  • "gender": "string",
  • "phoneNumber": "string",
  • "dob": "2019-08-24",
  • "image": "string",
  • "timezone": "string",
  • "address": [
    ],
  • "loginid": "string",
  • "orgid": 0,
  • "npi": "string",
  • "is_org_admin": false
}

Response samples

Content type
application/json
{
  • "userloginname": "string",
  • "role": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "emailid": "user@example.com",
  • "gender": "string",
  • "phoneNumber": "string",
  • "dob": "2019-08-24",
  • "image": "string",
  • "timezone": "string",
  • "address": [
    ],
  • "loginid": "string",
  • "orgid": 0,
  • "npi": "string",
  • "is_org_admin": false
}

apis_user_therapist_practiceinfo_user_retrieve

Retrieves the complete practice profile for a therapist by userId. Returns all four profile sections in a single response:

  • credentials: Professional licences and certifications.
  • theoreticalOrientation: Therapeutic modalities with nested intervention techniques.
  • Populations: Patient population groups the therapist works with.
  • Specialties: Clinical specialty areas.

Send the therapist userId as a URL path parameter.

Authorizations:
cookieAuthbasicAuthNone

Responses

apis_user_therapist_practiceinfo_user_retrieve_2

Retrieves the complete practice profile for a therapist by userId. Returns all four profile sections in a single response:

  • credentials: Professional licences and certifications.
  • theoreticalOrientation: Therapeutic modalities with nested intervention techniques.
  • Populations: Patient population groups the therapist works with.
  • Specialties: Clinical specialty areas.

Send the therapist userId as a URL path parameter.

Authorizations:
cookieAuthbasicAuthNone
path Parameters
id
required
string

Responses