Skip to main content
POST
Complete 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).

recordId
string
required

The medical record's ID.

Body

application/json

Every field is optional. An empty body means done, today.

performed_on
string<date>

When it was done. Today when left out, or when it is not a YYYY-MM-DD date.

notes
string

Replaces the record's notes when sent.

details
object

What was found or given. Replaced whole when sent. 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.

result_status
enum<string> | null

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

Available options:
pending,
normal,
abnormal,
positive,
negative,
inconclusive,
null
performed_in_house
boolean

Done at your own clinic. When true, the practice and vet are cleared.

performed_by_person_id
string | null

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

veterinary_practice_id
string | null

Where it was done. Left out, the scheduled practice is kept; null clears it.

veterinarian_person_id
string | null

The vet. Left out, the scheduled vet is kept; null clears it.

Response

The record as completed, and the next one when one was made.

record
object
next
object | null

The next occurrence, or null.

stopped_because
enum<string> | null

Why a recurring record made no next one.

Available options:
no_refills,
prescription_expired,
null