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

Create diagnostic request

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Canonical identifier for the diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstringrequired

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

Veterinarian responsible for the 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-request' \
  -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",
    "diagnosticItems": [
      {
        "code": "string",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticClass": "string",
        "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticRequestItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "diagnosticRequestId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "specifics": "string",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic Request created successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

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

When the diagnostic request was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Canonical identifier for the diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

When the diagnostic request was last updated.

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

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

List diagnostic requests

Request

Returns a paginated list of Diagnostic Requests 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""referenceNumber""requestedAt""specifics"
sortOrderstring

Sort order

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

Animal for which the diagnostics are 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 or client contact associated with the request.

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

Whether the diagnostic request is currently active.

ownershipIdstring

Ownership or billing entity associated with the request.

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

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

specificsstring

Free-text details or instructions for the diagnostic request.

statusstring

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstring

External laboratory or supplier handling the diagnostics.

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

Veterinarian responsible for the 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-request?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&isActive=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&referenceNumber=string&specifics=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 Diagnostic Requests

Get diagnostic request

Request

Returns a single Diagnostic Request by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticRequestIdstringrequired

Diagnostic Request unique identifier (UUID)

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

Responses

Diagnostic Request found

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

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

When the diagnostic request was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Canonical identifier for the diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

When the diagnostic request was last updated.

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

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

Update diagnostic request

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticRequestIdstringrequired

Diagnostic Request unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItemsArray of objects(DiagnosticItemDto)

List of individual diagnostics requested as part of this request.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Whether the diagnostic request is currently active.

ownershipIdstring

Ownership or billing entity associated with the request.

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

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

requestedAtstring

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstring

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstring

External laboratory or supplier handling the diagnostics.

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

Veterinarian responsible for the 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-request/{diagnosticRequestId}' \
  -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",
    "diagnosticItems": [
      {
        "code": "string",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticClass": "string",
        "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticRequestItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "specifics": "string",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic Request updated successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

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

When the diagnostic request was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Canonical identifier for the diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

When the diagnostic request was last updated.

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

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

Replace diagnostic request

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticRequestIdstringrequired

Diagnostic Request unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstringrequired

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

Veterinarian responsible for the 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-request/{diagnosticRequestId}' \
  -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",
    "diagnosticItems": [
      {
        "code": "string",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "diagnosticClass": "string",
        "diagnosticId": "123e4567-e89b-12d3-a456-426614174000",
        "diagnosticRequestItemId": "123e4567-e89b-12d3-a456-426614174000",
        "isActive": true,
        "name": "string",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      }
    ],
    "extensions": {},
    "isActive": true,
    "ownershipId": "123e4567-e89b-12d3-a456-426614174000",
    "referenceNumber": "string",
    "requestedAt": "2025-01-01T00:00:00.000Z",
    "specifics": "string",
    "status": "draft",
    "supplierId": "123e4567-e89b-12d3-a456-426614174000",
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Diagnostic Request replaced successfully

Bodyapplication/json
animalIdstringrequired

Animal for which the diagnostics are requested.

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

Consult/visit associated with this diagnostic request.

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

Owner or client contact associated with the request.

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

When the diagnostic request was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItemsArray of objects(DiagnosticItemDto)required

List of individual diagnostics requested as part of this request.

diagnosticItems[].​codestring

Practice or supplier-specific code for the diagnostic test.

diagnosticItems[].​createdAtstring

When this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
diagnosticItems[].​diagnosticClassstring

Category or class of the diagnostic test.

diagnosticItems[].​diagnosticIdstringrequired

Reference to the catalog diagnostic/test being requested.

Example: "123e4567-e89b-12d3-a456-426614174000"
diagnosticItems[].​diagnosticRequestItemIdstringrequired

Canonical identifier for this diagnostic request item.

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

Whether this diagnostic item is currently active.

diagnosticItems[].​namestring

Human-readable name of the diagnostic test.

diagnosticItems[].​updatedAtstring

When this diagnostic item was last updated.

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

Canonical identifier for the diagnostic request.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether the diagnostic request is currently active.

ownershipIdstringrequired

Ownership or billing entity associated with the request.

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

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

requestedAtstring(date-time)required

Business timestamp associated with the diagnostic request (e.g., when it was requested).

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

Free-text details or instructions for the diagnostic request.

statusstringrequired

Status of the diagnostic request.

Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
supplierIdstringrequired

External laboratory or supplier handling the diagnostics.

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

When the diagnostic request was last updated.

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

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

Delete diagnostic request

Request

Permanently deletes a Diagnostic Request record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticRequestIdstringrequired

Diagnostic Request unique identifier (UUID)

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

Responses

Diagnostic Request deleted successfully

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