Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
Canonical identifier for the prescription.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription' \
-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",
"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"
}
],
"prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000",
"prescriptionId": "123e4567-e89b-12d3-a456-426614174000",
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'Prescription created successfully
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
Timestamp when the prescription record was created.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
Canonical identifier for the prescription.
Timestamp when the prescription record was last modified.
{ "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", "extensions": {}, "isActive": true, "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "prescriptionId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription?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&prescribingVetUserId=123e4567-e89b-12d3-a456-426614174000' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Prescription found
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
Timestamp when the prescription record was created.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
Canonical identifier for the prescription.
Timestamp when the prescription record was last modified.
{ "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", "extensions": {}, "isActive": true, "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "prescriptionId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
Identifier of the veterinarian who prescribed the medication.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}' \
-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",
"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"
}
],
"prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000",
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'Prescription updated successfully
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
Timestamp when the prescription record was created.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
Canonical identifier for the prescription.
Timestamp when the prescription record was last modified.
{ "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", "extensions": {}, "isActive": true, "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "prescriptionId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- 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/prescription/{prescriptionId}' \
-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",
"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"
}
],
"prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000",
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'Prescription replaced successfully
Identifier of the animal for which the prescription is written.
Identifier of the consult/visit associated with this prescription.
Identifier of the animal's owner/contact.
Timestamp when the prescription record was created.
List of items prescribed as part of this prescription.
Timestamp when this diagnostic item was created.
Reference to the diagnostic definition/catalog entry.
Canonical identifier for this diagnostic item within the request.
Linked billable product, if applicable.
Identifier of the veterinarian who prescribed the medication.
Canonical identifier for the prescription.
Timestamp when the prescription record was last modified.
{ "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", "extensions": {}, "isActive": true, "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "prescriptionId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/prescription/{prescriptionId}
- 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/prescription/{prescriptionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'