Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
Canonical identifier for the external prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-prescription
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-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/external-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": {},
"externalPrescriptionId": "123e4567-e89b-12d3-a456-426614174000",
"externalReference": "string",
"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",
"totalPrice": {},
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'External Prescription created successfully
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
Timestamp when the external prescription record was created.
Canonical identifier for the external prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
Timestamp when the external prescription record was last updated.
{ "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": {}, "externalPrescriptionId": "123e4567-e89b-12d3-a456-426614174000", "externalReference": "string", "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "totalPrice": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-prescription
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-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/external-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&externalReference=string&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/external-prescription/{externalPrescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- 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/external-prescription/{externalPrescriptionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'External Prescription found
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
Timestamp when the external prescription record was created.
Canonical identifier for the external prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
Timestamp when the external prescription record was last updated.
{ "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": {}, "externalPrescriptionId": "123e4567-e89b-12d3-a456-426614174000", "externalReference": "string", "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "totalPrice": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
Reference to the user (veterinarian) who prescribed the medication.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- 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/external-prescription/{externalPrescriptionId}' \
-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": {},
"externalReference": "string",
"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",
"totalPrice": {},
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'External Prescription updated successfully
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
Timestamp when the external prescription record was created.
Canonical identifier for the external prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
Timestamp when the external prescription record was last updated.
{ "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": {}, "externalPrescriptionId": "123e4567-e89b-12d3-a456-426614174000", "externalReference": "string", "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "totalPrice": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "prescribedAt": "2025-01-01T00:00:00.000Z" }
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- 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/external-prescription/{externalPrescriptionId}' \
-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": {},
"externalReference": "string",
"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",
"totalPrice": {},
"prescribedAt": "2025-01-01T00:00:00.000Z"
}'External Prescription replaced successfully
Reference to the animal for which the prescription was written.
Reference to the consult/visit associated with this prescription.
Reference to the client/owner contact associated with this prescription.
Timestamp when the external prescription record was created.
Canonical identifier for the external prescription.
External system reference or identifier for this prescription (e.g., pharmacy system ID).
List of externally prescribed items.
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.
Reference to the user (veterinarian) who prescribed the medication.
Timestamp when the external prescription record was last updated.
{ "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": {}, "externalPrescriptionId": "123e4567-e89b-12d3-a456-426614174000", "externalReference": "string", "items": [ { … } ], "prescribingVetUserId": "123e4567-e89b-12d3-a456-426614174000", "totalPrice": {}, "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/external-prescription/{externalPrescriptionId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/external-prescription/{externalPrescriptionId}
- 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/external-prescription/{externalPrescriptionId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'