Patient care plans

Create a patient care plan

Enrolls a clinic patient into a care plan by creating a new patient care plan with an initial status of CLIENT_CREATED. You must specify a core care plan and may optionally include add-on plans.

If the patient has a pending CLIENT_CREATED core plan that was never paid, it is automatically cancelled and removed — along with its enrollment invoice and any payment links for that invoice — before the new enrollment is created. A patient with any other in-progress or upcoming core plan cannot be enrolled again and the request is rejected.

The specified care plans must be active, match the patient’s species, and be available at the patient’s clinic. The start date must be in the future (relative to the clinic’s timezone).

POST

ext

patient-care-plans

Create a patient care plan

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clinic_client_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "is_billed_monthly": true,
  "should_renew": true,
  "start_date": "2023-12-25",
  "add_on_care_plan_ids": [
    123
  ],
  "next_plan_id": 123
}
'

import requests

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

payload = {
    "clinic_client_id": 123,
    "clinic_patient_id": 123,
    "core_plan_id": 123,
    "is_billed_monthly": True,
    "should_renew": True,
    "start_date": "2023-12-25",
    "add_on_care_plan_ids": [123],
    "next_plan_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clinic_client_id: 123,
    clinic_patient_id: 123,
    core_plan_id: 123,
    is_billed_monthly: true,
    should_renew: true,
    start_date: '2023-12-25',
    add_on_care_plan_ids: [123],
    next_plan_id: 123
  })
};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/', 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/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clinic_client_id' => 123,
    'clinic_patient_id' => 123,
    'core_plan_id' => 123,
    'is_billed_monthly' => true,
    'should_renew' => true,
    'start_date' => '2023-12-25',
    'add_on_care_plan_ids' => [
        123
    ],
    'next_plan_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/patient-care-plans/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}"

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

{
  "add_on_plans": [
    {
      "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,
      "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"
    }
  ],
  "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_id": 123,
  "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.

Body

application/json

Schema for creating a patient care plan via the external API.

clinic_client_id

integer

required

The clinic client ID who will be billed for these care plans

clinic_patient_id

integer

required

The clinic patient ID to enroll into care plans

core_plan_id

integer

required

The core Care Plan ID to enroll the patient into

is_billed_monthly

boolean

required

Whether billing is monthly (True) or upfront (False)

should_renew

boolean

required

Whether the plan should automatically renew at the end of term

start_date

string<date>

required

Start date for the enrollment

add_on_care_plan_ids

integer[]

Optional list of add-on Care Plan IDs to enroll alongside the core plan

next_plan_id

integer | null

Optional next core Care Plan ID for automatic renewal

Response

201 - application/json

Created

add_on_plans

ExternalPatientCarePlanSchema · object[]

required

Add-on patient care plans created alongside the core plan

Show child attributes

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_id

integer

required

The ID of the invoice created for the care plan enrollment

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

Create a patient care plan

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/patient-care-plans/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clinic_client_id": 123,
  "clinic_patient_id": 123,
  "core_plan_id": 123,
  "is_billed_monthly": true,
  "should_renew": true,
  "start_date": "2023-12-25",
  "add_on_care_plan_ids": [
    123
  ],
  "next_plan_id": 123
}
'

import requests

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

payload = {
    "clinic_client_id": 123,
    "clinic_patient_id": 123,
    "core_plan_id": 123,
    "is_billed_monthly": True,
    "should_renew": True,
    "start_date": "2023-12-25",
    "add_on_care_plan_ids": [123],
    "next_plan_id": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clinic_client_id: 123,
    clinic_patient_id: 123,
    core_plan_id: 123,
    is_billed_monthly: true,
    should_renew: true,
    start_date: '2023-12-25',
    add_on_care_plan_ids: [123],
    next_plan_id: 123
  })
};

fetch('https://connect.vetcove.com/ext/v2/patient-care-plans/', 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/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clinic_client_id' => 123,
    'clinic_patient_id' => 123,
    'core_plan_id' => 123,
    'is_billed_monthly' => true,
    'should_renew' => true,
    'start_date' => '2023-12-25',
    'add_on_care_plan_ids' => [
        123
    ],
    'next_plan_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/patient-care-plans/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clinic_client_id\": 123,\n  \"clinic_patient_id\": 123,\n  \"core_plan_id\": 123,\n  \"is_billed_monthly\": true,\n  \"should_renew\": true,\n  \"start_date\": \"2023-12-25\",\n  \"add_on_care_plan_ids\": [\n    123\n  ],\n  \"next_plan_id\": 123\n}"

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

{
  "add_on_plans": [
    {
      "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,
      "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"
    }
  ],
  "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_id": 123,
  "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

Create a patient care plan

Authorizations

Body

Response