Fetch a patient note - Vetcove docs

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

GET

/

ext

/

v2

/

patient-notes

/

{patient_note_id}

/

Fetch a patient note

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

import requests

url = "https://connect.vetcove.com/ext/v2/patient-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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_patient_id": 123,
  "date": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "details": [
    {}
  ],
  "id": 123,
  "is_deleted": true,
  "is_internal": true,
  "is_locked": true,
  "kind": "GENERAL",
  "created_by_name": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

patient_note_id

integer

required

The ID of the patient note to fetch or delete

Response

200 - application/json

OK

Patient notes are used to record information about a patient that should appear on their timeline. Notes can be of different kinds (general, communication, documentation) and can be marked as internal (visible only to clinic staff) or external (visible to clients as well).

clinic_patient_id

integer

required

The ID of the clinic patient this note is associated with

date

string<date-time>

required

The date and time when the note was created

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

details

Details · object[] | null

required

Additional details about the note in JSON format

id

integer

required

The unique identifier for the patient note

is_deleted

boolean

required

Whether this record is soft deleted or not.

is_internal

boolean

required

Whether this note is internal or visible to clients

is_locked

boolean

required

Whether this note is locked and cannot be modified

kind

required

The kind of patient note

Available options:

GENERAL,

COMMUNICATION,

DOCUMENTATION

created_by_name

string | null

The full name of the user who created this note

⌘I

Fetch a patient note

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

import requests

url = "https://connect.vetcove.com/ext/v2/patient-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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-notes/{patient_note_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_patient_id": 123,
  "date": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "details": [
    {}
  ],
  "id": 123,
  "is_deleted": true,
  "is_internal": true,
  "is_locked": true,
  "kind": "GENERAL",
  "created_by_name": "<string>"
}