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

Create diagnostic

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstring

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Free-text clinical details or specifics for the diagnostic request.

diagnosticIdstringrequired

Canonical identifier for this diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstring

Supplier or laboratory associated with this diagnostic request.

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

Veterinarian responsible for this diagnostic request.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic' \
  -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",
    "details": "string",
    "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "items": [
      {
        "class": "string",
        "code": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic created successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Timestamp when the diagnostic request was created.

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

Free-text clinical details or specifics for the diagnostic request.

diagnosticIdstringrequired

Canonical identifier for this diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstringrequired

Supplier or laboratory associated with this diagnostic request.

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

Timestamp when the diagnostic request was last updated.

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

Veterinarian responsible for this diagnostic request.

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",
  "details": "string",
  "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "items": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "string",
  "requestedAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

List diagnostics

Request

Returns a paginated list of Diagnostics 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""details""referenceNumber""requestedAt"
sortOrderstring

Sort order

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

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Free-text clinical details or specifics for the diagnostic request.

isActiveboolean

Whether the diagnostic request is currently active.

ownershipIdstring

Ownership or account context for this diagnostic request.

Example: ownershipId=123e4567-e89b-12d3-a456-426614174000
referenceNumberstring

External or practice-specific reference number for this diagnostic request.

statusstring

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstring

Supplier or laboratory associated with this diagnostic request.

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

Veterinarian responsible for this diagnostic request.

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

Responses

Paginated list of Diagnostics

Get diagnostic

Request

Returns a single Diagnostic by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticIdstringrequired

Diagnostic unique identifier (UUID)

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

Responses

Diagnostic found

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Timestamp when the diagnostic request was created.

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

Free-text clinical details or specifics for the diagnostic request.

diagnosticIdstringrequired

Canonical identifier for this diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstringrequired

Supplier or laboratory associated with this diagnostic request.

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

Timestamp when the diagnostic request was last updated.

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

Veterinarian responsible for this diagnostic request.

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",
  "details": "string",
  "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "items": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "string",
  "requestedAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Update diagnostic

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticIdstringrequired

Diagnostic unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Free-text clinical details or specifics for the diagnostic request.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)

List of individual diagnostic items/tests associated with this request.

ownershipIdstring

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstring

Supplier or laboratory associated with this diagnostic request.

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

Veterinarian responsible for this diagnostic request.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic/{diagnosticId}' \
  -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",
    "details": "string",
    "extensions": {},
    "isActive": true,
    "items": [
      {
        "class": "string",
        "code": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic updated successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Timestamp when the diagnostic request was created.

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

Free-text clinical details or specifics for the diagnostic request.

diagnosticIdstringrequired

Canonical identifier for this diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstringrequired

Supplier or laboratory associated with this diagnostic request.

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

Timestamp when the diagnostic request was last updated.

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

Veterinarian responsible for this diagnostic request.

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",
  "details": "string",
  "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "items": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "string",
  "requestedAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Replace diagnostic

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticIdstringrequired

Diagnostic unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Free-text clinical details or specifics for the diagnostic request.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstringrequired

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstringrequired

Supplier or laboratory associated with this diagnostic request.

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

Veterinarian responsible for this diagnostic request.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic/{diagnosticId}' \
  -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",
    "details": "string",
    "extensions": {},
    "isActive": true,
    "items": [
      {
        "class": "string",
        "code": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticDefinitionId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "productId": "123e4567-e89b-12d3-a456-426614174000",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic replaced successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostic is requested.

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

Consult/visit associated with this diagnostic request.

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

Owner/client contact associated with this diagnostic request.

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

Timestamp when the diagnostic request was created.

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

Free-text clinical details or specifics for the diagnostic request.

diagnosticIdstringrequired

Canonical identifier for this diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

itemsArray of objects(ItemDto)required

List of individual diagnostic items/tests associated with this request.

items[].​classstring

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

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.

items[].​namestring

Human-readable name of the diagnostic item.

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

Ownership or account context for this diagnostic request.

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

External or practice-specific reference number for this diagnostic request.

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., order time).

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

Status of the diagnostic request.

Enum"draft""requested""inProgress""completed""cancelled""failed""unknown"
supplierIdstringrequired

Supplier or laboratory associated with this diagnostic request.

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

Timestamp when the diagnostic request was last updated.

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

Veterinarian responsible for this diagnostic request.

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",
  "details": "string",
  "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "items": [
    { … }
  ],
  "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
  "referenceNumber": "string",
  "requestedAt": "2025-01-01T00:00:00.000Z",
  "status": "draft",
  "supplierId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "vetId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete diagnostic

Request

Permanently deletes a Diagnostic record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticIdstringrequired

Diagnostic unique identifier (UUID)

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

Responses

Diagnostic deleted successfully

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

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations