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

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Create diagnostic result item

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
diagnosticResultIdstringrequired

Identifier of the parent diagnostic result this item belongs to.

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

Canonical identifier for this diagnostic result item.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstring

Free-text notes or comments about this result item.

observedAtstring

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobject
referenceRangeobject

Reference range for the result, if available.

valuestringrequired

Raw result value as provided by the source system.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result-item' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
    "diagnosticResultItemId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "notes": "string",
    "observedAt": "2025-01-01T00:00:00.000Z",
    "qualifier": "string",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceRange": {},
    "value": "string"
  }'

Responses

Diagnostic Result Item created successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this item was created.

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

Identifier of the parent diagnostic result this item belongs to.

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

Canonical identifier for this diagnostic result item.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstringrequired

Free-text notes or comments about this result item.

observedAtstring(date-time)required

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceRangeobjectrequired

Reference range for the result, if available.

updatedAtstring(date-time)required

Timestamp when this item was last updated.

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

Raw result value as provided by the source system.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultItemId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "notes": "string",
  "observedAt": "2025-01-01T00:00:00.000Z",
  "qualifier": "string",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceRange": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string"
}

List diagnostic result items

Request

Returns a paginated list of Diagnostic Result Items 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""name""notes""observedAt""qualifier""value"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
diagnosticResultIdstring

Identifier of the parent diagnostic result this item belongs to.

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

Whether this diagnostic result item is active.

namestring

Name of the diagnostic test component or analyte.

notesstring

Free-text notes or comments about this result item.

qualifierstring

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

valuestring

Raw result value as provided by the source system.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result-item?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&diagnosticResultId=123e4567-e89b-12d3-a456-426614174000&isActive=true&name=string&notes=string&qualifier=string&value=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Diagnostic Result Items

Get diagnostic result item

Request

Returns a single Diagnostic Result Item by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultItemIdstringrequired

Diagnostic Result Item unique identifier (UUID)

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

Responses

Diagnostic Result Item found

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this item was created.

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

Identifier of the parent diagnostic result this item belongs to.

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

Canonical identifier for this diagnostic result item.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstringrequired

Free-text notes or comments about this result item.

observedAtstring(date-time)required

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceRangeobjectrequired

Reference range for the result, if available.

updatedAtstring(date-time)required

Timestamp when this item was last updated.

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

Raw result value as provided by the source system.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultItemId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "notes": "string",
  "observedAt": "2025-01-01T00:00:00.000Z",
  "qualifier": "string",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceRange": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string"
}

Update diagnostic result item

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultItemIdstringrequired

Diagnostic Result Item unique identifier (UUID)

Bodyapplication/jsonrequired
diagnosticResultIdstring

Identifier of the parent diagnostic result this item belongs to.

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

Vendor- or practice-specific extensions.

isActiveboolean

Whether this diagnostic result item is active.

namestring

Name of the diagnostic test component or analyte.

notesstring

Free-text notes or comments about this result item.

observedAtstring

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobject
referenceRangeobject

Reference range for the result, if available.

valuestring

Raw result value as provided by the source system.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result-item/{diagnosticResultItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "notes": "string",
    "observedAt": "2025-01-01T00:00:00.000Z",
    "qualifier": "string",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceRange": {},
    "value": "string"
  }'

Responses

Diagnostic Result Item updated successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this item was created.

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

Identifier of the parent diagnostic result this item belongs to.

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

Canonical identifier for this diagnostic result item.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstringrequired

Free-text notes or comments about this result item.

observedAtstring(date-time)required

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceRangeobjectrequired

Reference range for the result, if available.

updatedAtstring(date-time)required

Timestamp when this item was last updated.

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

Raw result value as provided by the source system.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultItemId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "notes": "string",
  "observedAt": "2025-01-01T00:00:00.000Z",
  "qualifier": "string",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceRange": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string"
}

Replace diagnostic result item

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultItemIdstringrequired

Diagnostic Result Item unique identifier (UUID)

Bodyapplication/jsonrequired
diagnosticResultIdstringrequired

Identifier of the parent diagnostic result this item belongs to.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstringrequired

Free-text notes or comments about this result item.

observedAtstringrequired

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceRangeobjectrequired

Reference range for the result, if available.

valuestringrequired

Raw result value as provided by the source system.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-result-item/{diagnosticResultItemId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "notes": "string",
    "observedAt": "2025-01-01T00:00:00.000Z",
    "qualifier": "string",
    "quantity": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "referenceRange": {},
    "value": "string"
  }'

Responses

Diagnostic Result Item replaced successfully

Bodyapplication/json
createdAtstring(date-time)required

Timestamp when this item was created.

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

Identifier of the parent diagnostic result this item belongs to.

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

Canonical identifier for this diagnostic result item.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Whether this diagnostic result item is active.

namestringrequired

Name of the diagnostic test component or analyte.

notesstringrequired

Free-text notes or comments about this result item.

observedAtstring(date-time)required

Timestamp when the measurement or observation was made, if known.

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

Qualifier for the result (e.g., '<', '>', 'trace', 'positive').

quantityobjectrequired
quantity.​valuenumberrequired

Numeric value

quantity.​unitstringrequired

Unit of measure

quantity.​systemstring

Unit system URI

referenceRangeobjectrequired

Reference range for the result, if available.

updatedAtstring(date-time)required

Timestamp when this item was last updated.

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

Raw result value as provided by the source system.

Response
application/json
{
  "createdAt": "2025-01-01T00:00:00.000Z",
  "diagnosticResultId": "123e4567-e89b-12d3-a456-426614174000",
  "diagnosticResultItemId": "123e4567-e89b-12d3-a456-426614174000",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "notes": "string",
  "observedAt": "2025-01-01T00:00:00.000Z",
  "qualifier": "string",
  "quantity": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "referenceRange": {},
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "value": "string"
}

Delete diagnostic result item

Request

Permanently deletes a Diagnostic Result Item record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticResultItemIdstringrequired

Diagnostic Result Item unique identifier (UUID)

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

Responses

Diagnostic Result Item deleted successfully

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