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

Request

Creates a new Prescription record. Prescription resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or null

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or null

Identifier of the animal's owner/contact.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Canonical identifier for the prescription.

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

Timestamp when the prescription was issued (may differ from createdAt).

Example: "2025-01-01T00:00:00.000Z"
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"
  }'

Responses

Prescription created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or nullrequired

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or nullrequired

Identifier of the animal's owner/contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the prescription record was created.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Canonical identifier for the prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the prescription record was last modified.

Example: "2025-01-01T00:00:00.000Z"
prescribedAtstring(date-time)required

Timestamp when the prescription was issued (may differ from createdAt).

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

Request

Returns a paginated list of Prescriptions 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""prescribedAt"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
animalIdstring

Identifier of the animal for which the prescription is written.

Example: animalId=123e4567-e89b-12d3-a456-426614174000
consultIdstring

Identifier of the consult/visit associated with this prescription.

Example: consultId=123e4567-e89b-12d3-a456-426614174000
contactIdstring

Identifier of the animal's owner/contact.

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

Whether the prescription is currently active and usable.

prescribingVetUserIdstring

Identifier of the veterinarian who prescribed the medication.

Example: prescribingVetUserId=123e4567-e89b-12d3-a456-426614174000
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>'

Responses

Paginated list of Prescriptions

Request

Returns a single Prescription by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

prescriptionIdstringrequired

Prescription unique identifier (UUID)

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

Responses

Prescription found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or nullrequired

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or nullrequired

Identifier of the animal's owner/contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the prescription record was created.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Canonical identifier for the prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the prescription record was last modified.

Example: "2025-01-01T00:00:00.000Z"
prescribedAtstring(date-time)required

Timestamp when the prescription was issued (may differ from createdAt).

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

Request

Partially updates an existing Prescription. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

prescriptionIdstringrequired

Prescription unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or null

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or null

Identifier of the animal's owner/contact.

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

Practice- or vendor-specific extension fields.

isActiveboolean

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)

List of items prescribed as part of this prescription.

prescribingVetUserIdstring

Identifier of the veterinarian who prescribed the medication.

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

Timestamp when the prescription was issued (may differ from createdAt).

Example: "2025-01-01T00:00:00.000Z"
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"
  }'

Responses

Prescription updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or nullrequired

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or nullrequired

Identifier of the animal's owner/contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the prescription record was created.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Canonical identifier for the prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the prescription record was last modified.

Example: "2025-01-01T00:00:00.000Z"
prescribedAtstring(date-time)required

Timestamp when the prescription was issued (may differ from createdAt).

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

Request

Fully replaces an existing Prescription. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

prescriptionIdstringrequired

Prescription unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or null

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or null

Identifier of the animal's owner/contact.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Timestamp when the prescription was issued (may differ from createdAt).

Example: "2025-01-01T00:00:00.000Z"
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"
  }'

Responses

Prescription replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal for which the prescription is written.

Example: "123e4567-e89b-12d3-a456-426614174000"
consultIdstring or nullrequired

Identifier of the consult/visit associated with this prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
contactIdstring or nullrequired

Identifier of the animal's owner/contact.

Example: "123e4567-e89b-12d3-a456-426614174000"
createdAtstring(date-time)required

Timestamp when the prescription record was created.

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

Practice- or vendor-specific extension fields.

isActivebooleanrequired

Whether the prescription is currently active and usable.

itemsArray of objects(ItemDto)required

List of items prescribed as part of this prescription.

items[].​classstring

Classification of the diagnostic item (e.g., lab, imaging).

items[].​codeobject
items[].​createdAtstring

Timestamp when this diagnostic item was created.

Example: "2025-01-01T00:00:00.000Z"
items[].​diagnosticDefinitionIdstring

Reference to the diagnostic definition/catalog entry.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​diagnosticItemIdstringrequired

Canonical identifier for this diagnostic item within the request.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​isActiveboolean

Whether this diagnostic item is currently active.

items[].​namestring

Human-readable name of the diagnostic item.

items[].​productIdstring

Linked billable product, if applicable.

Example: "123e4567-e89b-12d3-a456-426614174000"
items[].​updatedAtstring

Timestamp when this diagnostic item was last updated.

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

Identifier of the veterinarian who prescribed the medication.

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

Canonical identifier for the prescription.

Example: "123e4567-e89b-12d3-a456-426614174000"
updatedAtstring(date-time)required

Timestamp when the prescription record was last modified.

Example: "2025-01-01T00:00:00.000Z"
prescribedAtstring(date-time)required

Timestamp when the prescription was issued (may differ from createdAt).

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

Request

Permanently deletes a Prescription record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

prescriptionIdstringrequired

Prescription unique identifier (UUID)

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

Responses

Prescription 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