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

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

Replace vaccination

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

vaccinationIdstringrequired

Vaccination unique identifier (UUID)

Bodyapplication/jsonrequired
administeredAtstringrequired

Date and time when the vaccination was administered.

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

Identifier of the animal that received the vaccination.

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

Identifier or lot number of the vaccine batch used.

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

Identifier of the consultation/visit during which the vaccination was administered.

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

Free-text description of the vaccination or product.

Example: "Example description"
extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

Example: true
nextAdministrationDatestringrequired

Planned date for the next administration/booster.

Example: "2025-01-01"
notesstringrequired

Clinical notes related to this vaccination.

Example: "Example description"
productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

Example: 1.23
salesResourceIdstringrequired

Identifier linking this vaccination to a sales or billing resource.

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

Identifier of the veterinarian who administered or is responsible for the vaccination.

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

Unit of measure for the vaccine dose (e.g., mL, dose, IU).

Example: "example"
routeobjectrequired
route.​codestringrequired

Code value

Example: "12345"
route.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
route.​displaystring

Human-readable display

Example: "Example Display Name"
sitestringrequired

Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).

Example: "example"
manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

Example: "Example Name"
expiryDatestringrequired

Expiry date of the vaccine batch used at the time of administration.

Example: "2025-01-01"
indicationobjectrequired
indication.​codestringrequired

Code value

Example: "12345"
indication.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
indication.​displaystring

Human-readable display

Example: "Example Display Name"
statusobjectrequired
status.​codestringrequired

Code value

Example: "12345"
status.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
status.​displaystring

Human-readable display

Example: "Example Display Name"
herdGroupIdstringrequired

Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.

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

Indicates whether this vaccination is a booster dose in a series.

Example: true
seriesNumbernumberrequired

Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).

Example: 1.23
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination/{vaccinationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "administeredAt": "2025-01-01T00:00:00.000Z",
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "batchId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Example description",
    "extensions": {},
    "isActive": true,
    "nextAdministrationDate": "2025-01-01",
    "notes": "Example description",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 1.23,
    "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000",
    "doseUnit": "example",
    "route": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "site": "example",
    "manufacturer": "Example Name",
    "expiryDate": "2025-01-01",
    "indication": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "status": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "isBooster": true,
    "seriesNumber": 1.23
  }'

Responses

Vaccination replaced successfully

Bodyapplication/json
administeredAtstring(date-time)required

Date and time when the vaccination was administered.

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

Identifier of the animal that received the vaccination.

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

Identifier or lot number of the vaccine batch used.

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

Identifier of the consultation/visit during which the vaccination was administered.

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

Timestamp when the vaccination record was created.

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

Free-text description of the vaccination or product.

Example: "Example description"
extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

Example: true
nextAdministrationDatestring(date-time)required

Planned date for the next administration/booster.

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

Clinical notes related to this vaccination.

Example: "Example description"
productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

Example: 1.23
salesResourceIdstringrequired

Identifier linking this vaccination to a sales or billing resource.

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

Timestamp when the vaccination record was last updated.

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

Canonical identifier for this vaccination record.

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

Identifier of the veterinarian who administered or is responsible for the vaccination.

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

Unit of measure for the vaccine dose (e.g., mL, dose, IU).

Example: "example"
routeobjectrequired
route.​codestringrequired

Code value

Example: "12345"
route.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
route.​displaystring

Human-readable display

Example: "Example Display Name"
sitestringrequired

Anatomical site of vaccine administration (e.g., right forelimb, left hindlimb).

Example: "example"
manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

Example: "Example Name"
expiryDatestring(date-time)required

Expiry date of the vaccine batch used at the time of administration.

Example: "2025-01-01T00:00:00Z"
indicationobjectrequired
indication.​codestringrequired

Code value

Example: "12345"
indication.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
indication.​displaystring

Human-readable display

Example: "Example Display Name"
statusobjectrequired
status.​codestringrequired

Code value

Example: "12345"
status.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
status.​displaystring

Human-readable display

Example: "Example Display Name"
herdGroupIdstringrequired

Identifier of the herd, group, or lot of animals associated with this vaccination event, when applicable.

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

Indicates whether this vaccination is a booster dose in a series.

Example: true
seriesNumbernumberrequired

Position of this dose within a vaccination series (e.g., 1 for first dose, 2 for second dose).

Example: 1.23
Response
application/json
{
  "administeredAt": "2025-01-01T00:00:00.000Z",
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "batchId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "Example description",
  "extensions": {},
  "isActive": true,
  "nextAdministrationDate": "2025-01-01T00:00:00Z",
  "notes": "Example description",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 1.23,
  "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vaccinationId": "123e4567-e89b-12d3-a456-426614174000",
  "vetId": "123e4567-e89b-12d3-a456-426614174000",
  "doseUnit": "example",
  "route": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "site": "example",
  "manufacturer": "Example Name",
  "expiryDate": "2025-01-01T00:00:00Z",
  "indication": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "status": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "isBooster": true,
  "seriesNumber": 1.23
}

Delete vaccination

Request

Permanently deletes a Vaccination record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

vaccinationIdstringrequired

Vaccination unique identifier (UUID)

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

Responses

Vaccination deleted successfully

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