Fetch a patient care plan

GET

ext

patient-care-plans

{patient_care_plan_id}

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/', 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://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "invoice_history": [
    {
      "billing_status": "IN_PROGRESS",
      "invoice_id": 123,
      "invoice_items": [
        {
          "amount": 123,
          "invoice_item_id": 123,
          "kind": "ENROLLMENT"
        }
      ]
    }
  ],
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patient_care_plan_id

integer

required

The ID of the patient care plan to fetch

Response

200 - application/json

care_plan_id

integer

required

The ID of the Care Plan this patient-specific plan is linked to

care_plan_kind

enum<string>

required

The type of the care plan

Available options:

CORE,

ADD_ON,

SERVICE_PACKAGE

care_plan_name

string

required

The name of the care plan this patient care plan is linked to

clinic_client_id

integer

required

The ID of the clinic client this patient care plan is associated with

clinic_id

integer

required

The ID of the clinic this patient care plan is associated with

clinic_patient_id

integer

required

The ID of the clinic patient this care plan is associated with

core_plan_id

integer | null

required

The ID of the core patient care plan this one is linked to, if this is an add-on plan

deactivated_at

string<date-time> | null

required

When this care plan was deactivated, if applicable

deactivated_by

string | null

required

The name of the user who deactivated the care plan, if applicable

end_date

string<date>

required

End date for the care plan (YYYY-MM-DD). This is non-inclusive, meaning a plan ending on 2/1/2026 would not be considered active/usable on 2/1/2026.

enrollment_fee

integer

required

The enrollment fee of the care plan

Required range: x >= 0

integer

required

The unique identifier for the patient care plan

invoice_history

ExternalPatientCarePlanInvoiceHistorySchema · object[]

required

The history of invoices for this patient care plan

Show child attributes

is_billed_monthly

boolean

required

Whether the care plan is billed monthly or upfront

monthly_cost

integer | null

required

The monthly cost of the care plan, in cents. Only applicable to monthly billed care plans.

Required range: x >= 0

next_payment_date

string<date> | null

required

The date of the next payment for the care plan, if applicable

next_plan_id

integer | null

required

The ID of the next care plan, if applicable

payment_method_id

integer | null

required

The ID of the payment method associated with this care plan

plan_cost

integer

required

The cost of the care plan

Required range: x >= 0

remaining_balance

integer

required

The remaining balance of the care plan, in cents

should_renew

boolean

required

Whether this care plan will automatically be renewed

start_date

string<date>

required

The start date of the care plan

status

required

The status of the patient care plan

Available options:

IMPORTED,

CLIENT_CREATED,

CLINIC_CREATED,

ACTIVE,

TERMINATED,

PAYMENT_FAILED,

SUSPENDED

⌘I

Fetch a patient care plan

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/', 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://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/patient-care-plans/{patient_care_plan_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "care_plan_id": 123,
  "care_plan_kind": "CORE",
  "care_plan_name": "<string>",
  "clinic_client_id": 123,
  "clinic_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "deactivated_at": "2023-11-07T05:31:56Z",
  "deactivated_by": "<string>",
  "end_date": "2023-12-25",
  "enrollment_fee": 1,
  "id": 123,
  "invoice_history": [
    {
      "billing_status": "IN_PROGRESS",
      "invoice_id": 123,
      "invoice_items": [
        {
          "amount": 123,
          "invoice_item_id": 123,
          "kind": "ENROLLMENT"
        }
      ]
    }
  ],
  "is_billed_monthly": true,
  "monthly_cost": 1,
  "next_payment_date": "2023-12-25",
  "next_plan_id": 123,
  "payment_method_id": 123,
  "plan_cost": 1,
  "remaining_balance": 123,
  "should_renew": true,
  "start_date": "2023-12-25",
  "status": "IMPORTED"
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Fetch a patient care plan

Authorizations

Path Parameters

Response