Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
Overview
Languages
Servers
Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
Local Development
http://localhost:8083/
Bodyapplication/jsonrequired
Animal for which the diagnostics are requested.
Example: "123e4567-e89b-12d3-a456-426614174000"
Consult/visit associated with this diagnostic request.
Example: "123e4567-e89b-12d3-a456-426614174000"
Owner or client contact associated with the request.
Example: "123e4567-e89b-12d3-a456-426614174000"
List of individual diagnostics requested as part of this request.
When this diagnostic item was created.
Example: "2025-01-01T00:00:00.000Z"
Reference to the catalog diagnostic/test being requested.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for this diagnostic request item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Ownership or billing entity associated with the request.
Example: "123e4567-e89b-12d3-a456-426614174000"
External or practice-specific reference number for the diagnostic request.
Business timestamp associated with the diagnostic request (e.g., when it was requested).
Example: "2025-01-01T00:00:00.000Z"
Status of the diagnostic request.
Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
External laboratory or supplier handling the diagnostics.
Example: "123e4567-e89b-12d3-a456-426614174000"
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-request/{diagnosticRequestId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/diagnostic-request/{diagnosticRequestId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
}'Diagnostic Request replaced successfully
Animal for which the diagnostics are requested.
Example: "123e4567-e89b-12d3-a456-426614174000"
Consult/visit associated with this diagnostic request.
Example: "123e4567-e89b-12d3-a456-426614174000"
Owner or client contact associated with the request.
Example: "123e4567-e89b-12d3-a456-426614174000"
When the diagnostic request was created.
Example: "2025-01-01T00:00:00.000Z"
List of individual diagnostics requested as part of this request.
When this diagnostic item was created.
Example: "2025-01-01T00:00:00.000Z"
Reference to the catalog diagnostic/test being requested.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for this diagnostic request item.
Example: "123e4567-e89b-12d3-a456-426614174000"
Canonical identifier for the diagnostic request.
Example: "123e4567-e89b-12d3-a456-426614174000"
Ownership or billing entity associated with the request.
Example: "123e4567-e89b-12d3-a456-426614174000"
External or practice-specific reference number for the diagnostic request.
Business timestamp associated with the diagnostic request (e.g., when it was requested).
Example: "2025-01-01T00:00:00.000Z"
Status of the diagnostic request.
Enum"draft""requested""in-progress""completed""cancelled""entered-in-error""unknown"
External laboratory or supplier handling the diagnostics.
Example: "123e4567-e89b-12d3-a456-426614174000"
When the diagnostic request was last updated.
Example: "2025-01-01T00:00:00.000Z"
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" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-request/{diagnosticRequestId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/diagnostic-request/{diagnosticRequestId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'