Get treatment plan by ID
curl --request GET \
--url https://app.hipp.health/api/v1/treatment-plans/{planId}import requests
url = "https://app.hipp.health/api/v1/treatment-plans/{planId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.hipp.health/api/v1/treatment-plans/{planId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.hipp.health/api/v1/treatment-plans/{planId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.hipp.health/api/v1/treatment-plans/{planId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.hipp.health/api/v1/treatment-plans/{planId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hipp.health/api/v1/treatment-plans/{planId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"publicId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"patient": {
"publicId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"goals": [
"<string>"
],
"name": "<string>",
"practiceArea": "ABA"
}{
"message": "Validation Error",
"statusCode": 400,
"validationErrors": [
{
"code": "invalid_type",
"message": "Required",
"path": [
"email"
]
}
]
}{
"error": "An unexpected error occurred",
"statusCode": 500
}Treatment Plans
Get Treatment Plan By Id
Get a single treatment plan by planId including associated goals
GET
/
v1
/
treatment-plans
/
{planId}
Get treatment plan by ID
curl --request GET \
--url https://app.hipp.health/api/v1/treatment-plans/{planId}import requests
url = "https://app.hipp.health/api/v1/treatment-plans/{planId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.hipp.health/api/v1/treatment-plans/{planId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.hipp.health/api/v1/treatment-plans/{planId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.hipp.health/api/v1/treatment-plans/{planId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.hipp.health/api/v1/treatment-plans/{planId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hipp.health/api/v1/treatment-plans/{planId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"publicId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"patient": {
"publicId": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"goals": [
"<string>"
],
"name": "<string>",
"practiceArea": "ABA"
}{
"message": "Validation Error",
"statusCode": 400,
"validationErrors": [
{
"code": "invalid_type",
"message": "Required",
"path": [
"email"
]
}
]
}{
"error": "An unexpected error occurred",
"statusCode": 500
}Get Treatment Plan By Id
Retrieve a single treatment plan by its planId, including associated goals.Headers
Authorization: Bearer <your-api-key>
Path Parameters
planId(required): Treatment plan public identifier
Success Response (200)
{
"publicId": "tp_abc123def456",
"name": "Physical Therapy Treatment Plan",
"practiceArea": "Physical Therapy",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-20T14:45:00Z",
"patient": {
"publicId": "usr_patient123",
"firstName": "John",
"lastName": "Doe"
},
"goals": ["goal_123", "goal_456"]
}
Error Responses
400 - Validation Error
{
"error": "Validation error",
"details": [
{
"code": "invalid_string",
"message": "Invalid planId format",
"path": ["planId"]
}
]
}
500 - Internal Server Error
{
"error": "An unexpected error occurred"
}
Examples
cURL Example
# Get treatment plan by planId
curl -X GET "https://app.hipp.health/api/v1/treatment-plans/tp_abc123def456" \
-H "Authorization: Bearer your-api-key"
JavaScript Example
const getTreatmentPlanById = async (planId) => {
const response = await fetch(
`https://app.hipp.health/api/v1/treatment-plans/${planId}`,
{
method: "GET",
headers: {
Authorization: "Bearer your-api-key",
},
}
);
if (!response.ok) {
const error = await response.json();
throw new Error(error.error || "Failed to fetch treatment plan");
}
return response.json();
};
// Usage
try {
const treatmentPlan = await getTreatmentPlanById("tp_abc123def456");
console.log("Treatment Plan:", treatmentPlan);
console.log("Goals:", treatmentPlan.goals);
} catch (error) {
console.error("Error fetching treatment plan:", error.message);
}
Path Parameters
Response
Successful response
Show child attributes
Show child attributes
Clinical practice area of the treatment plan
Available options:
ABA, ACADEMY, DIR_FLOORTIME, FEEDING_THERAPY, NURSING, OCCUPATIONAL_THERAPY, PHYSICAL_THERAPY, SCHOOL_BASED_ABA, SPEECH_LANGUAGE_PATHOLOGY, FACILITY