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

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

Create physical exam

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobject
commentsstring

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstring

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Identifier of the veterinarian who performed or recorded the exam.

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

Responses

Physical Exam created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "bodySystem": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "comments": "string",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "examinedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "physicalExamId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

List physical exams

Request

Returns a paginated list of Physical Exams 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""comments""examinedAt"
sortOrderstring

Sort order

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

Identifier of the animal that this physical exam pertains to.

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

Free-text comments or findings from the physical exam.

consultIdstring

Identifier of the consult/visit associated with this physical exam.

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

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

vetIdstring

Identifier of the veterinarian who performed or recorded the exam.

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

Responses

Paginated list of Physical Exams

Get physical exam

Request

Returns a single Physical Exam by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

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

Responses

Physical Exam found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "bodySystem": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "comments": "string",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "examinedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "physicalExamId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Update physical exam

Request

Partially updates an existing Physical Exam. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobject
commentsstring

Free-text comments or findings from the physical exam.

consultIdstring

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstring

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

vetIdstring

Identifier of the veterinarian who performed or recorded the exam.

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

Responses

Physical Exam updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "bodySystem": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "comments": "string",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "examinedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "physicalExamId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace physical exam

Request

Fully replaces an existing Physical Exam. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

vetIdstringrequired

Identifier of the veterinarian who performed or recorded the exam.

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

Responses

Physical Exam replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "bodySystem": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "comments": "string",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "examinedAt": "2025-01-01T00:00:00.000Z",
  "extensions": {},
  "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "physicalExamId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete physical exam

Request

Permanently deletes a Physical Exam record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

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

Responses

Physical Exam deleted successfully

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