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
Operations
Operations
Operations
Operations

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

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

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