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

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

Create vaccination

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

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"
batchIdstring

Identifier or lot number of the vaccine batch used.

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

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

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

Free-text description of the vaccination or product.

extensionsobject

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestring

Planned date for the next administration/booster.

Example: "2025-01-01"
notesstring

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

salesResourceIdstring

Identifier linking this vaccination to a sales or billing resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
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"
doseUnitstring

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

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestring

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

manufacturerstring

Name of the vaccine manufacturer as recorded at administration time.

expiryDatestring

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

Example: "2025-01-01"
indicationobject
statusobject
herdGroupIdstring

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

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

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

seriesNumbernumber

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

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/vaccination' \
  -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": "string",
    "extensions": {},
    "isActive": true,
    "nextAdministrationDate": "2025-01-01",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "vaccinationId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000",
    "doseUnit": "string",
    "route": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "site": "string",
    "manufacturer": "string",
    "expiryDate": "2025-01-01",
    "indication": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "status": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "isBooster": true,
    "seriesNumber": 0
  }'

Responses

Vaccination created 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.

extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestring(date-time)required

Planned date for the next administration/booster.

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

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

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).

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestringrequired

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

manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

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

indication.​systemstringrequired

Code system URI

indication.​displaystring

Human-readable display

statusobjectrequired
status.​codestringrequired

Code value

status.​systemstringrequired

Code system URI

status.​displaystring

Human-readable display

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.

seriesNumbernumberrequired

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

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": "string",
  "extensions": {},
  "isActive": true,
  "nextAdministrationDate": "2025-01-01T00:00:00Z",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "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": "string",
  "route": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "site": "string",
  "manufacturer": "string",
  "expiryDate": "2025-01-01T00:00:00Z",
  "indication": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "status": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "isBooster": true,
  "seriesNumber": 0
}

List vaccinations

Request

Returns a paginated list of Vaccinations 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""administeredAt""description""nextAdministrationDate""notes""quantity""doseUnit""site""manufacturer"
sortOrderstring

Sort order

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

Identifier of the animal that received the vaccination.

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

Identifier or lot number of the vaccine batch used.

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

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

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

Free-text description of the vaccination or product.

isActiveboolean

Whether this vaccination record is currently active.

notesstring

Clinical notes related to this vaccination.

productIdstring

Identifier of the vaccine product used.

Example: productId=123e4567-e89b-12d3-a456-426614174000
salesResourceIdstring

Identifier linking this vaccination to a sales or billing resource.

Example: salesResourceId=123e4567-e89b-12d3-a456-426614174000
vetIdstring

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

Example: vetId=123e4567-e89b-12d3-a456-426614174000
doseUnitstring

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

sitestring

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

manufacturerstring

Name of the vaccine manufacturer as recorded at administration time.

herdGroupIdstring

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

Example: herdGroupId=123e4567-e89b-12d3-a456-426614174000
isBoosterboolean

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

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

Responses

Paginated list of Vaccinations

Get vaccination

Request

Returns a single Vaccination by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

vaccinationIdstringrequired

Vaccination unique identifier (UUID)

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

Responses

Vaccination found

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.

extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestring(date-time)required

Planned date for the next administration/booster.

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

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

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).

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestringrequired

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

manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

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

indication.​systemstringrequired

Code system URI

indication.​displaystring

Human-readable display

statusobjectrequired
status.​codestringrequired

Code value

status.​systemstringrequired

Code system URI

status.​displaystring

Human-readable display

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.

seriesNumbernumberrequired

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

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": "string",
  "extensions": {},
  "isActive": true,
  "nextAdministrationDate": "2025-01-01T00:00:00Z",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "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": "string",
  "route": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "site": "string",
  "manufacturer": "string",
  "expiryDate": "2025-01-01T00:00:00Z",
  "indication": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "status": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "isBooster": true,
  "seriesNumber": 0
}

Update vaccination

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

vaccinationIdstringrequired

Vaccination unique identifier (UUID)

Bodyapplication/jsonrequired
administeredAtstring

Date and time when the vaccination was administered.

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

Identifier of the animal that received the vaccination.

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

Identifier or lot number of the vaccine batch used.

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

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

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

Free-text description of the vaccination or product.

extensionsobject

Practice- or vendor-specific extensions.

isActiveboolean

Whether this vaccination record is currently active.

nextAdministrationDatestring

Planned date for the next administration/booster.

Example: "2025-01-01"
notesstring

Clinical notes related to this vaccination.

productIdstring

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

salesResourceIdstring

Identifier linking this vaccination to a sales or billing resource.

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

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

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

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

routeobject
sitestring

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

manufacturerstring

Name of the vaccine manufacturer as recorded at administration time.

expiryDatestring

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

Example: "2025-01-01"
indicationobject
statusobject
herdGroupIdstring

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

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

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

seriesNumbernumber

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

curl -i -X PATCH \
  '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": "string",
    "extensions": {},
    "isActive": true,
    "nextAdministrationDate": "2025-01-01",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000",
    "doseUnit": "string",
    "route": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "site": "string",
    "manufacturer": "string",
    "expiryDate": "2025-01-01",
    "indication": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "status": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "isBooster": true,
    "seriesNumber": 0
  }'

Responses

Vaccination updated 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.

extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestring(date-time)required

Planned date for the next administration/booster.

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

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

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).

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestringrequired

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

manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

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

indication.​systemstringrequired

Code system URI

indication.​displaystring

Human-readable display

statusobjectrequired
status.​codestringrequired

Code value

status.​systemstringrequired

Code system URI

status.​displaystring

Human-readable display

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.

seriesNumbernumberrequired

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

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": "string",
  "extensions": {},
  "isActive": true,
  "nextAdministrationDate": "2025-01-01T00:00:00Z",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "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": "string",
  "route": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "site": "string",
  "manufacturer": "string",
  "expiryDate": "2025-01-01T00:00:00Z",
  "indication": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "status": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "isBooster": true,
  "seriesNumber": 0
}

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.

extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestringrequired

Planned date for the next administration/booster.

Example: "2025-01-01"
notesstringrequired

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

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).

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestringrequired

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

manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

expiryDatestringrequired

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

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

Code value

indication.​systemstringrequired

Code system URI

indication.​displaystring

Human-readable display

statusobjectrequired
status.​codestringrequired

Code value

status.​systemstringrequired

Code system URI

status.​displaystring

Human-readable display

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.

seriesNumbernumberrequired

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

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": "string",
    "extensions": {},
    "isActive": true,
    "nextAdministrationDate": "2025-01-01",
    "notes": "string",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "quantity": 0,
    "salesResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000",
    "doseUnit": "string",
    "route": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "site": "string",
    "manufacturer": "string",
    "expiryDate": "2025-01-01",
    "indication": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "status": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "isBooster": true,
    "seriesNumber": 0
  }'

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.

extensionsobjectrequired

Practice- or vendor-specific extensions.

isActivebooleanrequired

Whether this vaccination record is currently active.

nextAdministrationDatestring(date-time)required

Planned date for the next administration/booster.

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

Clinical notes related to this vaccination.

productIdstringrequired

Identifier of the vaccine product used.

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

Quantity of vaccine administered, expressed in product units.

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).

routeobjectrequired
route.​codestringrequired

Code value

route.​systemstringrequired

Code system URI

route.​displaystring

Human-readable display

sitestringrequired

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

manufacturerstringrequired

Name of the vaccine manufacturer as recorded at administration time.

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

indication.​systemstringrequired

Code system URI

indication.​displaystring

Human-readable display

statusobjectrequired
status.​codestringrequired

Code value

status.​systemstringrequired

Code system URI

status.​displaystring

Human-readable display

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.

seriesNumbernumberrequired

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

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": "string",
  "extensions": {},
  "isActive": true,
  "nextAdministrationDate": "2025-01-01T00:00:00Z",
  "notes": "string",
  "productId": "123e4567-e89b-12d3-a456-426614174000",
  "quantity": 0,
  "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": "string",
  "route": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "site": "string",
  "manufacturer": "string",
  "expiryDate": "2025-01-01T00:00:00Z",
  "indication": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "status": {
    "code": "string",
    "system": "string",
    "display": "string"
  },
  "herdGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "isBooster": true,
  "seriesNumber": 0
}

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

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations