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/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Create assessment

Request

Creates a new Assessment record. Assessment resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal this assessment is for.

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

Canonical unique identifier for the assessment.

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

Identifier of the consult/encounter this assessment is associated with.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstring

Free-text notes describing the assessment.

recordedAtstring

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
vetIdstring

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/assessment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "notes": "string",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Assessment created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this assessment is for.

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

Canonical unique identifier for the assessment.

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

Identifier of the consult/encounter this assessment is associated with.

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

Timestamp when the assessment record was created.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstringrequired

Free-text notes describing the assessment.

recordedAtstring(date-time)required

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
updatedAtstring(date-time)required

Timestamp when the assessment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "notes": "string",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

List assessments

Request

Returns a paginated list of Assessments for the specified site. Supports filtering and sorting.

Security
bearer
Path
siteIdnumberrequired

Site identifier

Query
pagenumber>= 0

Page number (0-indexed)

Default 0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
sortBystring

Field to sort by

Enum"createdAt""updatedAt""notes""recordedAt"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
animalIdstring

Identifier of the animal this assessment is for.

Example: animalId=123e4567-e89b-12d3-a456-426614174000
consultIdstring

Identifier of the consult/encounter this assessment is associated with.

Example: consultId=123e4567-e89b-12d3-a456-426614174000
isActiveboolean

Whether the assessment record is active.

notesstring

Free-text notes describing the assessment.

vetIdstring

Identifier of the veterinarian who performed or recorded the assessment.

Example: vetId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/assessment?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&consultId=123e4567-e89b-12d3-a456-426614174000&isActive=true&notes=string&vetId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Assessments

Get assessment

Request

Returns a single Assessment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

assessmentIdstringrequired

Assessment unique identifier (UUID)

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

Responses

Assessment found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this assessment is for.

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

Canonical unique identifier for the assessment.

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

Identifier of the consult/encounter this assessment is associated with.

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

Timestamp when the assessment record was created.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstringrequired

Free-text notes describing the assessment.

recordedAtstring(date-time)required

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
updatedAtstring(date-time)required

Timestamp when the assessment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "notes": "string",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Update assessment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

assessmentIdstringrequired

Assessment unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal this assessment is for.

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

Identifier of the consult/encounter this assessment is associated with.

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

Vendor- or practice-specific extension fields.

isActiveboolean

Whether the assessment record is active.

notesstring

Free-text notes describing the assessment.

recordedAtstring

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
vetIdstring

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/assessment/{assessmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "notes": "string",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Assessment updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this assessment is for.

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

Canonical unique identifier for the assessment.

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

Identifier of the consult/encounter this assessment is associated with.

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

Timestamp when the assessment record was created.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstringrequired

Free-text notes describing the assessment.

recordedAtstring(date-time)required

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
updatedAtstring(date-time)required

Timestamp when the assessment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "notes": "string",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace assessment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

assessmentIdstringrequired

Assessment unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal this assessment is for.

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

Identifier of the consult/encounter this assessment is associated with.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstringrequired

Free-text notes describing the assessment.

recordedAtstringrequired

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/assessment/{assessmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "notes": "string",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Assessment replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this assessment is for.

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

Canonical unique identifier for the assessment.

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

Identifier of the consult/encounter this assessment is associated with.

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

Timestamp when the assessment record was created.

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

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the assessment record is active.

notesstringrequired

Free-text notes describing the assessment.

recordedAtstring(date-time)required

Date and time when the assessment was recorded or took place.

Example: "2025-01-01T00:00:00.000Z"
updatedAtstring(date-time)required

Timestamp when the assessment record was last updated.

Example: "2025-01-01T00:00:00.000Z"
vetIdstringrequired

Identifier of the veterinarian who performed or recorded the assessment.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "isActive": true,
  "notes": "string",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete assessment

Request

Permanently deletes a Assessment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

assessmentIdstringrequired

Assessment unique identifier (UUID)

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

Responses

Assessment deleted successfully

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations