Skip to content

AHDS Store API (1.0)

Animal Health Data Store - V1 API Documentation

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/animal-health/openapi/

Local Development

http://localhost:8083/

Animal

Operations

Update animal

Request

Partially updates an existing Animal. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

animalIdstringrequired

Animal unique identifier (UUID)

Bodyapplication/jsonrequired
breedobject

Animal breed, represented as a CodeableConcept-like structure.

codestring or null

Practice-specific animal code or chart number.

colourobject

Animal colour.

deathReasonstring or null

Free-text reason for death.

desexDatestring or null

Date the animal was desexed (spayed/neutered). No time component is required.

Example: "2025-01-01"
extensionsobject

Vendor- or practice-specific extension fields.

hasImportantNotesboolean

True if notes contain important or highlighted information.

isActiveboolean

Whether the animal record is active in the source system.

isDeadboolean

Whether the animal is deceased. Should be consistent with deathDate when present.

isEstimatedDateOfBirthboolean or null

True if the date of birth is estimated rather than exact.

isHostileboolean

Whether the animal is marked as hostile or aggressive.

microchipNumberstring or null

Microchip identifier.

namestring

Animal's name.

notesstring or null

General clinical or administrative notes about the animal.

ownerContactIdstring

Canonical identifier of the primary owner contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
rabiesNumberstring or null

Rabies vaccination certificate or tag number.

rabiesVaccinationDatestring or null

Date of last rabies vaccination.

Example: "2025-01-01"
referringClinicIdstring or null

Canonical identifier of the referring clinic.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetIdstring or null

Canonical identifier of the referring veterinarian.

Example: "123e4567-e89b-12d3-a456-426614174000"
residenceContactIdstring or null

Canonical identifier of the residence contact (if different from owner).

Example: "123e4567-e89b-12d3-a456-426614174000"
resuscitationStatusstring

Resuscitation preference for the animal.

Enum"full""do_not_resuscitate""unspecified"
sexobject
speciesobject

Animal species.

weightobject or null
herdIdstring

Optional herd identifier for production animals.

Example: "123e4567-e89b-12d3-a456-426614174000"
birthDatestring or null

Date of birth.

Example: "2025-01-01"
deathDatestring or null

Date of death (no time component).

Example: "2025-01-01"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "breed": {},
    "code": "string",
    "colour": {},
    "deathReason": "string",
    "desexDate": "2025-01-01",
    "extensions": {},
    "hasImportantNotes": true,
    "isActive": true,
    "isDead": true,
    "isEstimatedDateOfBirth": true,
    "isHostile": true,
    "microchipNumber": "string",
    "name": "string",
    "notes": "string",
    "ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
    "rabiesNumber": "string",
    "rabiesVaccinationDate": "2025-01-01",
    "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "referringVetId": "123e4567-e89b-12d3-a456-426614174000",
    "residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
    "resuscitationStatus": "full",
    "sex": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "species": {},
    "weight": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "herdId": "123e4567-e89b-12d3-a456-426614174000",
    "birthDate": "2025-01-01",
    "deathDate": "2025-01-01"
  }'

Responses

Animal updated successfully

Bodyapplication/json
animalIdstringrequired

Canonical unique identifier for the animal.

Example: "123e4567-e89b-12d3-a456-426614174000"
breedobjectrequired

Animal breed, represented as a CodeableConcept-like structure.

codestring or nullrequired

Practice-specific animal code or chart number.

colourobjectrequired

Animal colour.

createdAtstring(date-time)required

Timestamp when the animal record was created.

Example: "2025-01-01T00:00:00.000Z"
deathReasonstring or nullrequired

Free-text reason for death.

desexDatestring or null(date-time)required

Date the animal was desexed (spayed/neutered). No time component is required.

Example: "2025-01-01T00:00:00Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

hasImportantNotesbooleanrequired

True if notes contain important or highlighted information.

isActivebooleanrequired

Whether the animal record is active in the source system.

isDeadbooleanrequired

Whether the animal is deceased. Should be consistent with deathDate when present.

isEstimatedDateOfBirthboolean or nullrequired

True if the date of birth is estimated rather than exact.

isHostilebooleanrequired

Whether the animal is marked as hostile or aggressive.

microchipNumberstring or nullrequired

Microchip identifier.

namestringrequired

Animal's name.

notesstring or nullrequired

General clinical or administrative notes about the animal.

ownerContactIdstringrequired

Canonical identifier of the primary owner contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
rabiesNumberstring or nullrequired

Rabies vaccination certificate or tag number.

rabiesVaccinationDatestring or null(date-time)required

Date of last rabies vaccination.

Example: "2025-01-01T00:00:00Z"
referringClinicIdstring or nullrequired

Canonical identifier of the referring clinic.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetIdstring or nullrequired

Canonical identifier of the referring veterinarian.

Example: "123e4567-e89b-12d3-a456-426614174000"
residenceContactIdstring or nullrequired

Canonical identifier of the residence contact (if different from owner).

Example: "123e4567-e89b-12d3-a456-426614174000"
resuscitationStatusstringrequired

Resuscitation preference for the animal.

Enum"full""do_not_resuscitate""unspecified"
sexobjectrequired
sex.​codestringrequired

Code value

sex.​systemstringrequired

Code system URI

sex.​displaystring

Human-readable display

speciesobjectrequired

Animal species.

updatedAtstring(date-time)required

Timestamp when the animal record was last updated.

Example: "2025-01-01T00:00:00.000Z"
weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

herdIdstringrequired

Optional herd identifier for production animals.

Example: "123e4567-e89b-12d3-a456-426614174000"
birthDatestring or null(date-time)required

Date of birth.

Example: "2025-01-01T00:00:00Z"
deathDatestring or null(date-time)required

Date of death (no time component).

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "breed": {},
  "code": "string",
  "colour": {},
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deathReason": "string",
  "desexDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "hasImportantNotes": true,
  "isActive": true,
  "isDead": true,
  "isEstimatedDateOfBirth": true,
  "isHostile": true,
  "microchipNumber": "string",
  "name": "string",
  "notes": "string",
  "ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
  "rabiesNumber": "string",
  "rabiesVaccinationDate": "2025-01-01T00:00:00Z",
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetId": "123e4567-e89b-12d3-a456-426614174000",
  "residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
  "resuscitationStatus": "full",
  "sex": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "species": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "herdId": "123e4567-e89b-12d3-a456-426614174000",
  "birthDate": "2025-01-01T00:00:00Z",
  "deathDate": "2025-01-01T00:00:00Z"
}

Replace animal

Request

Fully replaces an existing Animal. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

animalIdstringrequired

Animal unique identifier (UUID)

Bodyapplication/jsonrequired
breedobjectrequired

Animal breed, represented as a CodeableConcept-like structure.

codestring or null

Practice-specific animal code or chart number.

colourobjectrequired

Animal colour.

deathReasonstring or null

Free-text reason for death.

desexDatestring or null

Date the animal was desexed (spayed/neutered). No time component is required.

Example: "2025-01-01"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

hasImportantNotesbooleanrequired

True if notes contain important or highlighted information.

isActivebooleanrequired

Whether the animal record is active in the source system.

isDeadbooleanrequired

Whether the animal is deceased. Should be consistent with deathDate when present.

isEstimatedDateOfBirthboolean or null

True if the date of birth is estimated rather than exact.

isHostilebooleanrequired

Whether the animal is marked as hostile or aggressive.

microchipNumberstring or null

Microchip identifier.

namestringrequired

Animal's name.

notesstring or null

General clinical or administrative notes about the animal.

ownerContactIdstringrequired

Canonical identifier of the primary owner contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
rabiesNumberstring or null

Rabies vaccination certificate or tag number.

rabiesVaccinationDatestring or null

Date of last rabies vaccination.

Example: "2025-01-01"
referringClinicIdstring or null

Canonical identifier of the referring clinic.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetIdstring or null

Canonical identifier of the referring veterinarian.

Example: "123e4567-e89b-12d3-a456-426614174000"
residenceContactIdstring or null

Canonical identifier of the residence contact (if different from owner).

Example: "123e4567-e89b-12d3-a456-426614174000"
resuscitationStatusstringrequired

Resuscitation preference for the animal.

Enum"full""do_not_resuscitate""unspecified"
sexobjectrequired
sex.​codestringrequired

Code value

sex.​systemstringrequired

Code system URI

sex.​displaystring

Human-readable display

speciesobjectrequired

Animal species.

weightobject or null
herdIdstringrequired

Optional herd identifier for production animals.

Example: "123e4567-e89b-12d3-a456-426614174000"
birthDatestring or null

Date of birth.

Example: "2025-01-01"
deathDatestring or null

Date of death (no time component).

Example: "2025-01-01"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "breed": {},
    "code": "string",
    "colour": {},
    "deathReason": "string",
    "desexDate": "2025-01-01",
    "extensions": {},
    "hasImportantNotes": true,
    "isActive": true,
    "isDead": true,
    "isEstimatedDateOfBirth": true,
    "isHostile": true,
    "microchipNumber": "string",
    "name": "string",
    "notes": "string",
    "ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
    "rabiesNumber": "string",
    "rabiesVaccinationDate": "2025-01-01",
    "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "referringVetId": "123e4567-e89b-12d3-a456-426614174000",
    "residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
    "resuscitationStatus": "full",
    "sex": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "species": {},
    "weight": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "herdId": "123e4567-e89b-12d3-a456-426614174000",
    "birthDate": "2025-01-01",
    "deathDate": "2025-01-01"
  }'

Responses

Animal replaced successfully

Bodyapplication/json
animalIdstringrequired

Canonical unique identifier for the animal.

Example: "123e4567-e89b-12d3-a456-426614174000"
breedobjectrequired

Animal breed, represented as a CodeableConcept-like structure.

codestring or nullrequired

Practice-specific animal code or chart number.

colourobjectrequired

Animal colour.

createdAtstring(date-time)required

Timestamp when the animal record was created.

Example: "2025-01-01T00:00:00.000Z"
deathReasonstring or nullrequired

Free-text reason for death.

desexDatestring or null(date-time)required

Date the animal was desexed (spayed/neutered). No time component is required.

Example: "2025-01-01T00:00:00Z"
extensionsobjectrequired

Vendor- or practice-specific extension fields.

hasImportantNotesbooleanrequired

True if notes contain important or highlighted information.

isActivebooleanrequired

Whether the animal record is active in the source system.

isDeadbooleanrequired

Whether the animal is deceased. Should be consistent with deathDate when present.

isEstimatedDateOfBirthboolean or nullrequired

True if the date of birth is estimated rather than exact.

isHostilebooleanrequired

Whether the animal is marked as hostile or aggressive.

microchipNumberstring or nullrequired

Microchip identifier.

namestringrequired

Animal's name.

notesstring or nullrequired

General clinical or administrative notes about the animal.

ownerContactIdstringrequired

Canonical identifier of the primary owner contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
rabiesNumberstring or nullrequired

Rabies vaccination certificate or tag number.

rabiesVaccinationDatestring or null(date-time)required

Date of last rabies vaccination.

Example: "2025-01-01T00:00:00Z"
referringClinicIdstring or nullrequired

Canonical identifier of the referring clinic.

Example: "123e4567-e89b-12d3-a456-426614174000"
referringVetIdstring or nullrequired

Canonical identifier of the referring veterinarian.

Example: "123e4567-e89b-12d3-a456-426614174000"
residenceContactIdstring or nullrequired

Canonical identifier of the residence contact (if different from owner).

Example: "123e4567-e89b-12d3-a456-426614174000"
resuscitationStatusstringrequired

Resuscitation preference for the animal.

Enum"full""do_not_resuscitate""unspecified"
sexobjectrequired
sex.​codestringrequired

Code value

sex.​systemstringrequired

Code system URI

sex.​displaystring

Human-readable display

speciesobjectrequired

Animal species.

updatedAtstring(date-time)required

Timestamp when the animal record was last updated.

Example: "2025-01-01T00:00:00.000Z"
weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

herdIdstringrequired

Optional herd identifier for production animals.

Example: "123e4567-e89b-12d3-a456-426614174000"
birthDatestring or null(date-time)required

Date of birth.

Example: "2025-01-01T00:00:00Z"
deathDatestring or null(date-time)required

Date of death (no time component).

Example: "2025-01-01T00:00:00Z"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "breed": {},
  "code": "string",
  "colour": {},
  "createdAt": "2025-01-01T00:00:00.000Z",
  "deathReason": "string",
  "desexDate": "2025-01-01T00:00:00Z",
  "extensions": {},
  "hasImportantNotes": true,
  "isActive": true,
  "isDead": true,
  "isEstimatedDateOfBirth": true,
  "isHostile": true,
  "microchipNumber": "string",
  "name": "string",
  "notes": "string",
  "ownerContactId": "123e4567-e89b-12d3-a456-426614174000",
  "rabiesNumber": "string",
  "rabiesVaccinationDate": "2025-01-01T00:00:00Z",
  "referringClinicId": "123e4567-e89b-12d3-a456-426614174000",
  "referringVetId": "123e4567-e89b-12d3-a456-426614174000",
  "residenceContactId": "123e4567-e89b-12d3-a456-426614174000",
  "resuscitationStatus": "full",
  "sex": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "species": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "herdId": "123e4567-e89b-12d3-a456-426614174000",
  "birthDate": "2025-01-01T00:00:00Z",
  "deathDate": "2025-01-01T00:00:00Z"
}

Delete animal

Request

Permanently deletes a Animal record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

animalIdstringrequired

Animal unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/animal/{animalId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Animal deleted successfully

Animal Colour

Operations

Breed

Operations

Health Status

Operations

Herd

Operations

Sex

Operations

Shelter Animal Booking

Operations

Species

Operations

Assessment

Operations

Consult

Operations

History

Operations

Physical Exam

Operations

Presentingproblem

Operations

Standardofcare

Operations

Therapeutic

Operations

Vaccination

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Integrated Diagnostic

Operations

Modality

Operations

Standard Diagnostic Lab Report

Operations

External Prescription

Operations

Prescription

Operations

Prescription Item

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Availability

Operations

Availability Slot

Operations

Booking

Operations

Billing Credit

Operations

Billing Line

Operations

Estimate

Operations

Insurance

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Payment

Operations

Paymentmethod

Operations

Plan

Operations

Price Adjustment

Operations

Receive Invoice

Operations

Taxrate

Operations

Barcode

Operations

Batch

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice Item

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

With Primary Inventory Location

Operations

Address

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Communication

Operations

Message

Operations

Template

Operations

User

Operations

Webhook

Operations

Webhook Event

Operations

Attachment

Operations

Country

Operations

Facility

Operations

File

Operations

File Upload

Operations

Location

Operations

Practitioner

Operations

Wellness Resource

Operations

Eventgroup

Operations

Operation

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Site Information

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Transaction

Operations