Care plans

Fetch a care plan

This endpoint is available to Group API Keys only.

Fetches a care plan template by its ID.

A care plan is a template for recurring veterinary care that can be offered to patients. Care plans come in two types:

Core Plans: A plan for some defined period of time that typically include a physical exam, vaccinations, and other routine care.
Add-ons: Optional plans purchased in addition to a core plan (e.g., 12 months of flea and tick prevention).

These are organization-level templates. To see which patients are enrolled in care plans, use the patient care plans endpoints.

GET

ext

care-plans

{care_plan_id}

Fetch a care plan

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

import requests

url = "https://connect.vetcove.com/ext/v2/care-plans/{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/care-plans/{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/care-plans/{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/care-plans/{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/care-plans/{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

{
  "code": "<string>",
  "default_duration_unit": "DAY",
  "default_duration_value": 1,
  "id": 123,
  "kind": "CORE",
  "max_age_unit": "DAY",
  "max_age_value": 1,
  "min_age_unit": "DAY",
  "min_age_value": 1,
  "name": "<string>",
  "next_plan_id": 123,
  "species": "CANINE",
  "status": "ACTIVE"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

care_plan_id

integer

required

The ID of the care plan to fetch

Response

200 - application/json

Care plans are the core resource for recurring care on Vetcove. A care plan can be one of the following types:

Core Plans: A plan for some defined period of time that typically include a physical exam, vaccinations, and other routine care.
Add-ons: Optional plans purchased in addition to a core plan (e.g., 12 months of flea and tick prevention).

code

string

required

The unique identifier (within a group) for this care plan.

default_duration_unit

required

The unit of the default duration

Available options:

DAY,

WEEK,

MONTH,

YEAR

default_duration_value

integer | null

required

The value for the default duration of the care plan. Typically, this will be 12 months.

Required range: x >= 0

integer

required

The unique identifier for the care plan

kind

required

The type of the care plan

Available options:

CORE,

ADD_ON,

SERVICE_PACKAGE

max_age_unit

required

The unit of the maximum age

Available options:

DAY,

WEEK,

MONTH,

YEAR

max_age_value

integer | null

required

The maximum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans

Required range: x >= 0

min_age_unit

required

The unit of the minimum age

Available options:

DAY,

WEEK,

MONTH,

YEAR

min_age_value

integer | null

required

The minimum age of the patient to be eligible for the care plan. Clinics can enroll a patient in any care plan, but this value will be used for client initiated enrollments and automatic renewals into new care plans

Required range: x >= 0

name

string

required

The name of the care plan

next_plan_id

integer | null

required

The ID of the next Care Plan this plan transitions to. Only applicable to Core plans. When a patient meets the age and eligibility requirements of the next plan, they will be automatically transitioned to that plan upon renewal.

species

required

The species this care plan is for

Available options:

CANINE,

FELINE,

EQUINE,

AVIAN,

BOVINE,

FERRET,

RABBIT,

RODENT,

REPTILE,

AMPHIBIAN,

FISH,

PORCINE,

CAPRINE,

SHEEP,

CAMELID,

RATITE,

MARSUPIAL,

MUSTELID,

CERVID,

PROCYONIDAE,

ERINACEIDAE,

MEPHITIDAE,

OTHER,

UNSPECIFIED

status

required

The status of the care plan

Available options:

ACTIVE,

INACTIVE

⌘I

Fetch a care plan

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

import requests

url = "https://connect.vetcove.com/ext/v2/care-plans/{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/care-plans/{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/care-plans/{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/care-plans/{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/care-plans/{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

{
  "code": "<string>",
  "default_duration_unit": "DAY",
  "default_duration_value": 1,
  "id": 123,
  "kind": "CORE",
  "max_age_unit": "DAY",
  "max_age_value": 1,
  "min_age_unit": "DAY",
  "min_age_value": 1,
  "name": "<string>",
  "next_plan_id": 123,
  "species": "CANINE",
  "status": "ACTIVE"
}

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 care plan

Authorizations

Path Parameters

Response