Skip to main content
POST
Add a medical record

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The animal's record ID (not its Pet ID).

Body

application/json

A name is needed too, unless a catalogue item gives one.

record_type
enum<string>
required
Available options:
vaccination,
treatment,
procedure,
test,
medication,
exam,
condition,
preventative
name
string

What it was: Rabies, Heartworm test. Taken from the catalogue item when you send one and no name.

performed_on
string<date> | null

The date it was done. Leave it out for something still to do.

due_on
string<date> | null

The date it is due. A record with a due_on and no performed_on is scheduled, and a task is made for it, assigned to whoever will do it.

notes
string | null
performed_by_person_id
string | null

Who did it, or will: a person on file. The person who made the key, unless you say.

performed_in_house
boolean | null

Done at your own clinic. A record done in house names no veterinary_practice_id.

veterinary_practice_id
string | null

Where it was done: an organization on file.

veterinarian_person_id
string | null

The vet: a person on file.

catalogue_item_id
string | null

An item from your medical catalogue, of the kind the record type takes: a diagnosis for a condition, a test for a test, a vaccine for a vaccination, a treatment for a treatment, a procedure for a procedure. The other record types take none.

result_status
enum<string> | null

A test's outcome. Refused on any other record type.

Available options:
pending,
normal,
abnormal,
positive,
negative,
inconclusive,
null
details
object

The record's own fields. For a vaccination, treatment, exam or procedure, and for any record made from a catalogue item, each key must be one of its fields, and each value that field's kind: text, a number, true or false, a YYYY-MM-DD date, an HH:MM time, or one of a list's options. A vaccination's fields include lot_number, product_expires_on, method and site; a procedure's include will_alter. Other records keep short text, numbers or true or false under keys of your own.

due_start_at
string<date-time> | null

The time it is booked for. Needs a due_on.

duration_minutes
integer | null

How long it is booked for, from 5 to 1,440 minutes. An hour when you give a start time and no length.

Required range: 5 <= x <= 1440
recurrence_interval
integer | null

Makes the record recur: how many units apart. Send it with recurrence_unit, and with a due_on or performed_on to count from.

Required range: x >= 1
recurrence_unit
enum<string> | null

Send it with recurrence_interval. A month or a year from the 31st lands on the last day of a shorter month.

Available options:
day,
week,
month,
year,
null
medication_id
string | null

A medication from your medications list.

refills_remaining
integer | null

Refills left. Null is not tracked, which is different from 0. Each recurrence uses one, and none is made at 0.

Required range: x >= 0
prescription_expires_on
string<date> | null

No recurrence is made due after this date.

Response

The record.

id
string
record_type
enum<string>
Available options:
vaccination,
treatment,
procedure,
test,
medication,
exam,
condition,
preventative
name
string
performed_on
string<date> | null
due_on
string<date> | null
notes
string | null
performed_by_person_id
string | null
recurrence_interval
integer | null

How many units apart a recurring record falls.

recurrence_unit
enum<string> | null
Available options:
day,
week,
month,
year,
null
series_id
string | null

The first record of a recurring series, shared by every record in it.

recurrence_ended_at
string<date-time> | null

When the series was stopped.

veterinary_practice_id
string | null
veterinarian_person_id
string | null
medication_id
string | null
refills_remaining
integer | null

Refills left. Null is not tracked, which is different from 0.

prescription_expires_on
string<date> | null
catalogue_item_id
string | null
result_status
enum<string> | null
Available options:
pending,
normal,
abnormal,
positive,
negative,
inconclusive,
null
details
object
performed_in_house
boolean
due_start_at
string<date-time> | null
duration_minutes
integer | null
task_id
string | null

The task made for it while it was scheduled.

created_at
string<date-time>
updated_at
string<date-time>
performed_by_name
string | null

In the list only.

veterinarian_name
string | null

In the list only.

veterinary_practice_name
string | null

In the list only.