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

Get diagnostic result

Request

Returns a single Diagnostic Result by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultIdstringrequired

Diagnostic Result unique identifier (UUID)

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

Responses

Diagnostic Result found

Bodyapplication/json
animalIdstringrequired

Animal (patient) identifier.

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

Related consultation identifier.

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

Owner/client contact identifier, if applicable.

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

Timestamp when the diagnostic result was created.

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

Identifier of the originating diagnostic request/order.

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

Canonical identifier for the diagnostic result.

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

Vendor- or practice-specific extensions.

externalLinkstringrequired

External URL to full report or lab portal, if available.

Example: "https://example.com"
isActivebooleanrequired

Whether this diagnostic result is active/valid.

Example: true
itemsArray of objects(ItemDto)required

Individual diagnostic result items (e.g., analytes, findings).

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

Example: "example"
items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

Example: true
items[].​namestring

Human-readable name of the diagnostic item.

Example: "Example Name"
items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

High-level outcome or summary of the diagnostic result.

Example: "example"
ownershipIdstringrequired

Owning organization or practice identifier, if applicable.

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

External or human-readable reference number for this result.

Example: "example"
resultedAtstring(date-time)required

Date and time when the diagnostic result was finalized or recorded.

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

Free-text notes or specifics about the diagnostic result.

Example: "Example description"
supplierIdstringrequired

External laboratory or supplier identifier, if applicable.

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

Timestamp when the diagnostic result was last modified.

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

Veterinarian responsible for the diagnostic result.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "externalLink": "https://example.com",
  "isActive": true,
  "items": [
    { … }
  ],
  "outcome": "example",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "example",
  "resultedAt": "2025-01-01T00:00:00.000Z",
  "specifics": "Example description",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Update diagnostic result

Request

Partially updates an existing Diagnostic Result. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultIdstringrequired

Diagnostic Result unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Animal (patient) identifier.

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

Related consultation identifier.

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

Owner/client contact identifier, if applicable.

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

Identifier of the originating diagnostic request/order.

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

Vendor- or practice-specific extensions.

externalLinkstring

External URL to full report or lab portal, if available.

Example: "https://example.com"
isActiveboolean

Whether this diagnostic result is active/valid.

Example: true
itemsArray of objects(ItemDto)

Individual diagnostic result items (e.g., analytes, findings).

outcomestring

High-level outcome or summary of the diagnostic result.

Example: "example"
ownershipIdstring

Owning organization or practice identifier, if applicable.

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

External or human-readable reference number for this result.

Example: "example"
resultedAtstring

Date and time when the diagnostic result was finalized or recorded.

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

Free-text notes or specifics about the diagnostic result.

Example: "Example description"
supplierIdstring

External laboratory or supplier identifier, if applicable.

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

Veterinarian responsible for the diagnostic result.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result/{diagnosticResultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "externalLink": "https://example.com",
    "isActive": true,
    "items": [
      {
        "class": "example",
        "code": {
          "code": "12345",
          "system": "http://example.com/codesystem",
          "display": "Example Display Name"
        },
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "Example Name",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "outcome": "example",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "example",
    "resultedAt": "2025-01-01T00:00:00.000Z",
    "specifics": "Example description",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic Result updated successfully

Bodyapplication/json
animalIdstringrequired

Animal (patient) identifier.

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

Related consultation identifier.

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

Owner/client contact identifier, if applicable.

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

Timestamp when the diagnostic result was created.

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

Identifier of the originating diagnostic request/order.

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

Canonical identifier for the diagnostic result.

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

Vendor- or practice-specific extensions.

externalLinkstringrequired

External URL to full report or lab portal, if available.

Example: "https://example.com"
isActivebooleanrequired

Whether this diagnostic result is active/valid.

Example: true
itemsArray of objects(ItemDto)required

Individual diagnostic result items (e.g., analytes, findings).

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

Example: "example"
items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

Example: true
items[].​namestring

Human-readable name of the diagnostic item.

Example: "Example Name"
items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

High-level outcome or summary of the diagnostic result.

Example: "example"
ownershipIdstringrequired

Owning organization or practice identifier, if applicable.

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

External or human-readable reference number for this result.

Example: "example"
resultedAtstring(date-time)required

Date and time when the diagnostic result was finalized or recorded.

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

Free-text notes or specifics about the diagnostic result.

Example: "Example description"
supplierIdstringrequired

External laboratory or supplier identifier, if applicable.

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

Timestamp when the diagnostic result was last modified.

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

Veterinarian responsible for the diagnostic result.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "externalLink": "https://example.com",
  "isActive": true,
  "items": [
    { … }
  ],
  "outcome": "example",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "example",
  "resultedAt": "2025-01-01T00:00:00.000Z",
  "specifics": "Example description",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace diagnostic result

Request

Fully replaces an existing Diagnostic Result. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultIdstringrequired

Diagnostic Result unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Animal (patient) identifier.

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

Related consultation identifier.

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

Owner/client contact identifier, if applicable.

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

Identifier of the originating diagnostic request/order.

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

Vendor- or practice-specific extensions.

externalLinkstringrequired

External URL to full report or lab portal, if available.

Example: "https://example.com"
isActivebooleanrequired

Whether this diagnostic result is active/valid.

Example: true
itemsArray of objects(ItemDto)required

Individual diagnostic result items (e.g., analytes, findings).

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

Example: "example"
items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

Example: true
items[].​namestring

Human-readable name of the diagnostic item.

Example: "Example Name"
items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

High-level outcome or summary of the diagnostic result.

Example: "example"
ownershipIdstringrequired

Owning organization or practice identifier, if applicable.

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

External or human-readable reference number for this result.

Example: "example"
resultedAtstringrequired

Date and time when the diagnostic result was finalized or recorded.

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

Free-text notes or specifics about the diagnostic result.

Example: "Example description"
supplierIdstringrequired

External laboratory or supplier identifier, if applicable.

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

Veterinarian responsible for the diagnostic result.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result/{diagnosticResultId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "externalLink": "https://example.com",
    "isActive": true,
    "items": [
      {
        "class": "example",
        "code": {
          "code": "12345",
          "system": "http://example.com/codesystem",
          "display": "Example Display Name"
        },
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "Example Name",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "outcome": "example",
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "example",
    "resultedAt": "2025-01-01T00:00:00.000Z",
    "specifics": "Example description",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic Result replaced successfully

Bodyapplication/json
animalIdstringrequired

Animal (patient) identifier.

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

Related consultation identifier.

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

Owner/client contact identifier, if applicable.

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

Timestamp when the diagnostic result was created.

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

Identifier of the originating diagnostic request/order.

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

Canonical identifier for the diagnostic result.

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

Vendor- or practice-specific extensions.

externalLinkstringrequired

External URL to full report or lab portal, if available.

Example: "https://example.com"
isActivebooleanrequired

Whether this diagnostic result is active/valid.

Example: true
itemsArray of objects(ItemDto)required

Individual diagnostic result items (e.g., analytes, findings).

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

Example: "example"
items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

Example: true
items[].​namestring

Human-readable name of the diagnostic item.

Example: "Example Name"
items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

High-level outcome or summary of the diagnostic result.

Example: "example"
ownershipIdstringrequired

Owning organization or practice identifier, if applicable.

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

External or human-readable reference number for this result.

Example: "example"
resultedAtstring(date-time)required

Date and time when the diagnostic result was finalized or recorded.

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

Free-text notes or specifics about the diagnostic result.

Example: "Example description"
supplierIdstringrequired

External laboratory or supplier identifier, if applicable.

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

Timestamp when the diagnostic result was last modified.

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

Veterinarian responsible for the diagnostic result.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "externalLink": "https://example.com",
  "isActive": true,
  "items": [
    { … }
  ],
  "outcome": "example",
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "example",
  "resultedAt": "2025-01-01T00:00:00.000Z",
  "specifics": "Example description",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

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