Organization patients

Fetch an organization patient

This endpoint is available to Group API Keys only.

Fetches the organization-level view of a patient (pet) by the organization patient’s ID. Returns all clinic patient records associated with this pet across every clinic in the organization.

An organization patient is a cross-clinic identity that links together the separate clinic patient records that exist when the same pet is seen at multiple clinic locations within the same organization. Use this endpoint to get a unified view of a pet across all locations.

GET

ext

organization-patients

{organization_patient_id}

Fetch an organization patient

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

import requests

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

{
  "clinic_patients": [
    {
      "data": [
        {
          "birth_day": 16,
          "birth_month": 6,
          "birth_year": 123,
          "clinic_id": 123,
          "custom_breed": "<string>",
          "id": 123,
          "is_alive": true,
          "is_deactivated": true,
          "is_legacy_deactivated": true,
          "is_surrendered": true,
          "name": "<string>",
          "organization_patient_id": 123,
          "pim_id": "<string>",
          "primary_breed": "AFFENPINSCHER",
          "secondary_breeds": [
            "AFFENPINSCHER"
          ],
          "sex": "MALE",
          "species": "CANINE",
          "weight": 123,
          "insurance": {
            "custom_provider_name": "<string>",
            "policy_number": "<string>",
            "provider_id": 123
          }
        }
      ],
      "next_page": "<string>",
      "has_more": false,
      "type": "list"
    }
  ],
  "primary_clinic_id": 123
}

Authorizations

Authorization

string

header

required

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

Path Parameters

organization_patient_id

integer

required

The ID of the organization patient to fetch

Response

200 - application/json

clinic_patients

ClinicPatientForOrganizationPatientListSchemaList · object[]

required

A list of all clinic patients that are associated with this organization patient.

Show child attributes

primary_clinic_id

integer

required

The ID of the primary clinic that this organization patient is associated with.

⌘I

Fetch an organization patient

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

import requests

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

{
  "clinic_patients": [
    {
      "data": [
        {
          "birth_day": 16,
          "birth_month": 6,
          "birth_year": 123,
          "clinic_id": 123,
          "custom_breed": "<string>",
          "id": 123,
          "is_alive": true,
          "is_deactivated": true,
          "is_legacy_deactivated": true,
          "is_surrendered": true,
          "name": "<string>",
          "organization_patient_id": 123,
          "pim_id": "<string>",
          "primary_breed": "AFFENPINSCHER",
          "secondary_breeds": [
            "AFFENPINSCHER"
          ],
          "sex": "MALE",
          "species": "CANINE",
          "weight": 123,
          "insurance": {
            "custom_provider_name": "<string>",
            "policy_number": "<string>",
            "provider_id": 123
          }
        }
      ],
      "next_page": "<string>",
      "has_more": false,
      "type": "list"
    }
  ],
  "primary_clinic_id": 123
}

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 an organization patient

Authorizations

Path Parameters

Response