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

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

List appointments

Request

Returns a paginated list of Appointments 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""cancellationReasonText""description""durationMinutes""startAt"
sortOrderstring

Sort order

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

Identifier of the animal associated with the appointment.

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

Free-text explanation of the cancellation reason.

consultIdstring

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Free-text description or notes for the appointment.

isActiveboolean

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstring

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

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

Responses

Paginated list of Appointments

Get appointment

Request

Returns a single Appointment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

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

Responses

Appointment found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

Example: "12345"
appointmentStatus.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

Example: "12345"
appointmentType.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

Example: "12345"
cancellationReason.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

Example: "Patient cancelled due to illness"
consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

Example: "Annual checkup"
durationMinutesnumberrequired

Duration of the appointment in whole minutes.

Example: 30
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

Example: true
primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentStatus": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "appointmentType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "cancellationReason": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "cancellationReasonText": "Patient cancelled due to illness",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "Annual checkup",
  "durationMinutes": 30,
  "extensions": {},
  "isActive": true,
  "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceIds": [
    "string"
  ],
  "startAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

Update appointment

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal associated with the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobject
appointmentTypeobject
cancellationReasonobject
cancellationReasonTextstring

Free-text explanation of the cancellation reason.

Example: "Patient cancelled due to illness"
consultIdstring or null

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Free-text description or notes for the appointment.

Example: "Annual checkup"
durationMinutesnumber

Duration of the appointment in whole minutes.

Example: 30
extensionsobject

Vendor- or practice-specific extension fields.

isActiveboolean

Whether the appointment is currently active (not deleted/voided).

Example: true
primaryResourceIdstring

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of strings

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring

Scheduled start date and time of the appointment (with timezone).

Example: "2025-01-01T00:00:00.000Z"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment/{appointmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentStatus": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "appointmentType": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "cancellationReason": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "cancellationReasonText": "Patient cancelled due to illness",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Annual checkup",
    "durationMinutes": 30,
    "extensions": {},
    "isActive": true,
    "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceIds": [
      "string"
    ],
    "startAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Appointment updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

Example: "12345"
appointmentStatus.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

Example: "12345"
appointmentType.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

Example: "12345"
cancellationReason.​systemstringrequired

Code system URI

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

Human-readable display

Example: "Example Display Name"
cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

Example: "Patient cancelled due to illness"
consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

Example: "Annual checkup"
durationMinutesnumberrequired

Duration of the appointment in whole minutes.

Example: 30
extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

Example: true
primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
  "appointmentStatus": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "appointmentType": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "cancellationReason": {
    "code": "12345",
    "system": "http://example.com/codesystem",
    "display": "Example Display Name"
  },
  "cancellationReasonText": "Patient cancelled due to illness",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "Annual checkup",
  "durationMinutes": 30,
  "extensions": {},
  "isActive": true,
  "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceIds": [
    "string"
  ],
  "startAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z"
}

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