Telehealth Public APIs
  1. General APIs
Telehealth Public APIs
  • Introduction
  • SSO Login
    • Generate SSO token
      POST
    • SSO Login
      GET
  • General APIs
    • Create Patient
      POST
    • Upload Patient File
      POST
    • Submit Patient's Form Response
      POST
    • Lab readings
      POST
    • Assign Service to Patient
      POST
    • Create Patient's Chart Note
      POST
    • Get Provider's Appointment Slots
      POST
    • Provider Sign Up
      POST
    • GraphQL Get Patient(s)
      POST
  1. General APIs

Assign Service to Patient

POST
/api/service/v1/patient/treatment-plan/store
To assign a service to the patient.
Path Variables: None
Query Parameters: None
Body Parameters:
FieldTypeDescription
patient_idstringRequired. ID of a patient.
servicestringRequired. Name of Service. Must be in "Hair Loss", "Hormone Optimization", "Skin Care" or "ED"
Example Request:
{

"patient_id": {{patient_id}},
"service": {{service}}
}
Example Success Response:
Status: 200
{

"message": "Patient service updated successfully"
}
Example Failure Response:
Status: 400 or 403 or 500
{

"error_message": "Request Failed. {{error_message}}"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params text/plain
Example
Example:{ "patient_id": {{patient_id}}, "service": {{service}} }

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/service/v1/patient/treatment-plan/store' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"patient_id": {{patient_id}},
	"service": {{service}}
}'

Responses

🟢200Assign Service to Patient
application/json
Body

Example
{
    "message": "Patient service updated successfully"
}
Modified at 2024-10-16 09:02:01
Previous
Lab readings
Next
Create Patient's Chart Note
Built with