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/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

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

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

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations