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/

Address

Operations

Animal

Operations

Animal Colour

Operations

Appointment

Operations

Appointment Status

Operations

Appointment Type

Operations

Assessment

Operations

Attachment

Operations

Availability

Operations

Availability Slot

Operations

Barcode

Operations

Batch

Operations

Billing Credit

Operations

Billing Line

Operations

Booking

Operations

Breed

Operations

Communication

Operations

Consult

Operations

Contact

Operations

Contact Association

Operations

Contact Detail

Operations

Country

Operations

Diagnostic

Operations

Diagnostic Code

Operations

Diagnostic Request

Operations

Diagnostic Result

Operations

Diagnostic Result Item

Operations

Estimate

Operations

Eventgroup

Operations

External Prescription

Operations

Facility

Operations

File

Operations

File Upload

Operations

Health Status

Operations

Herd

Operations

History

Operations

Insurance

Operations

Integrated Diagnostic

Operations

Inventory Message

Operations

Inventory Product

Operations

Inventory Requirement

Operations

Inventory Supplied Product

Operations

Invoice

Operations

Invoiceline

Operations

Ledger Account

Operations

Linked Payment

Operations

Location

Operations

Message

Operations

Modality

Operations

Operation

Operations

Payment

Operations

Paymentmethod

Operations

Physical Exam

Operations

Plan

Operations

Practitioner

Operations

Prescription

Operations

Prescription Item

Operations

Presentingproblem

Operations

Price Adjustment

Operations

Product

Operations

Product Minimum Stock

Operations

Product Pricing

Operations

Product Supplier

Operations

Productgroup

Operations

Purchaseorder

Operations

Purchaseorderitem

Operations

Receive Invoice

Operations

Receive Invoice Item

Operations

Requisition Form

Operations

Resource

Operations

Separation

Operations

Sex

Operations

Shelter Animal Booking

Operations

Site Information

Operations

Species

Operations

Standard Diagnostic Lab Report

Operations

Standardofcare

Operations

Create standardofcare

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
applicableSpeciesArray of objects(ApplicableSpecieDto)

Species for which this standard of care is applicable.

categorystring or null

High-level category or grouping for this standard of care.

descriptionstring or null

Detailed description of the standard of care.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

standardofcareIdstringrequired

Canonical identifier for the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
stepsArray of objects(StepDto)

Ordered steps or components that make up this standard of care.

versionstring or null

Version identifier for this standard of care definition.

curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "applicableSpecies": [
      {
        "code": "string",
        "display": "string",
        "system": "string"
      }
    ],
    "category": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "standardofcareId": "123e4567-e89b-12d3-a456-426614174000",
    "steps": [
      {
        "description": "string",
        "recommendedServices": [
          {
            "display": "string",
            "serviceId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "sequence": 0,
        "stepId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string"
      }
    ],
    "version": "string"
  }'

Responses

Standardofcare created successfully

Bodyapplication/json
applicableSpeciesArray of objects(ApplicableSpecieDto)required

Species for which this standard of care is applicable.

applicableSpecies[].​codestringrequired

Code representing the species.

applicableSpecies[].​displaystring or null

Human-readable species name.

applicableSpecies[].​systemstring or nullrequired

URI of the code system that defines the species code.

categorystring or nullrequired

High-level category or grouping for this standard of care.

createdAtstring(date-time)required

Timestamp when this standard of care was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstring or nullrequired

Detailed description of the standard of care.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

standardofcareIdstringrequired

Canonical identifier for the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
stepsArray of objects(StepDto)required

Ordered steps or components that make up this standard of care.

steps[].​descriptionstring or null

Detailed description of what should be done in this step.

steps[].​recommendedServicesArray of objects(RecommendedServiceDto)

Services, procedures, or products recommended in this step.

steps[].​sequencenumberrequired

Order of this step within the standard of care.

steps[].​stepIdstringrequired

Identifier for this step within the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
steps[].​titlestringrequired

Short title or label for this step.

updatedAtstring(date-time)required

Timestamp when this standard of care was last updated.

Example: "2025-01-01T00:00:00.000Z"
versionstring or nullrequired

Version identifier for this standard of care definition.

Response
application/json
{
  "applicableSpecies": [
    { … }
  ],
  "category": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "standardofcareId": "123e4567-e89b-12d3-a456-426614174000",
  "steps": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "version": "string"
}

List standardofcares

Request

Returns a paginated list of Standardofcares 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""category""description""name""version"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
categorystring

High-level category or grouping for this standard of care.

descriptionstring

Detailed description of the standard of care.

isActiveboolean

Indicates whether this standard of care is currently active and can be applied.

namestring

Human-readable name of the standard of care.

versionstring

Version identifier for this standard of care definition.

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&category=string&description=string&isActive=true&name=string&version=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Standardofcares

Get standardofcare

Request

Returns a single Standardofcare by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardofcareIdstringrequired

Standardofcare unique identifier (UUID)

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare/{standardofcareId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Standardofcare found

Bodyapplication/json
applicableSpeciesArray of objects(ApplicableSpecieDto)required

Species for which this standard of care is applicable.

applicableSpecies[].​codestringrequired

Code representing the species.

applicableSpecies[].​displaystring or null

Human-readable species name.

applicableSpecies[].​systemstring or nullrequired

URI of the code system that defines the species code.

categorystring or nullrequired

High-level category or grouping for this standard of care.

createdAtstring(date-time)required

Timestamp when this standard of care was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstring or nullrequired

Detailed description of the standard of care.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

standardofcareIdstringrequired

Canonical identifier for the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
stepsArray of objects(StepDto)required

Ordered steps or components that make up this standard of care.

steps[].​descriptionstring or null

Detailed description of what should be done in this step.

steps[].​recommendedServicesArray of objects(RecommendedServiceDto)

Services, procedures, or products recommended in this step.

steps[].​sequencenumberrequired

Order of this step within the standard of care.

steps[].​stepIdstringrequired

Identifier for this step within the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
steps[].​titlestringrequired

Short title or label for this step.

updatedAtstring(date-time)required

Timestamp when this standard of care was last updated.

Example: "2025-01-01T00:00:00.000Z"
versionstring or nullrequired

Version identifier for this standard of care definition.

Response
application/json
{
  "applicableSpecies": [
    { … }
  ],
  "category": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "standardofcareId": "123e4567-e89b-12d3-a456-426614174000",
  "steps": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "version": "string"
}

Update standardofcare

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardofcareIdstringrequired

Standardofcare unique identifier (UUID)

Bodyapplication/jsonrequired
applicableSpeciesArray of objects(ApplicableSpecieDto)

Species for which this standard of care is applicable.

categorystring or null

High-level category or grouping for this standard of care.

descriptionstring or null

Detailed description of the standard of care.

extensionsobject

Vendor- or practice-specific extensions.

isActiveboolean

Indicates whether this standard of care is currently active and can be applied.

namestring

Human-readable name of the standard of care.

stepsArray of objects(StepDto)

Ordered steps or components that make up this standard of care.

versionstring or null

Version identifier for this standard of care definition.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare/{standardofcareId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "applicableSpecies": [
      {
        "code": "string",
        "display": "string",
        "system": "string"
      }
    ],
    "category": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "steps": [
      {
        "description": "string",
        "recommendedServices": [
          {
            "display": "string",
            "serviceId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "sequence": 0,
        "stepId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string"
      }
    ],
    "version": "string"
  }'

Responses

Standardofcare updated successfully

Bodyapplication/json
applicableSpeciesArray of objects(ApplicableSpecieDto)required

Species for which this standard of care is applicable.

applicableSpecies[].​codestringrequired

Code representing the species.

applicableSpecies[].​displaystring or null

Human-readable species name.

applicableSpecies[].​systemstring or nullrequired

URI of the code system that defines the species code.

categorystring or nullrequired

High-level category or grouping for this standard of care.

createdAtstring(date-time)required

Timestamp when this standard of care was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstring or nullrequired

Detailed description of the standard of care.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

standardofcareIdstringrequired

Canonical identifier for the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
stepsArray of objects(StepDto)required

Ordered steps or components that make up this standard of care.

steps[].​descriptionstring or null

Detailed description of what should be done in this step.

steps[].​recommendedServicesArray of objects(RecommendedServiceDto)

Services, procedures, or products recommended in this step.

steps[].​sequencenumberrequired

Order of this step within the standard of care.

steps[].​stepIdstringrequired

Identifier for this step within the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
steps[].​titlestringrequired

Short title or label for this step.

updatedAtstring(date-time)required

Timestamp when this standard of care was last updated.

Example: "2025-01-01T00:00:00.000Z"
versionstring or nullrequired

Version identifier for this standard of care definition.

Response
application/json
{
  "applicableSpecies": [
    { … }
  ],
  "category": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "standardofcareId": "123e4567-e89b-12d3-a456-426614174000",
  "steps": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "version": "string"
}

Replace standardofcare

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardofcareIdstringrequired

Standardofcare unique identifier (UUID)

Bodyapplication/jsonrequired
applicableSpeciesArray of objects(ApplicableSpecieDto)required

Species for which this standard of care is applicable.

applicableSpecies[].​codestringrequired

Code representing the species.

applicableSpecies[].​displaystring or null

Human-readable species name.

applicableSpecies[].​systemstring or nullrequired

URI of the code system that defines the species code.

categorystring or null

High-level category or grouping for this standard of care.

descriptionstring or null

Detailed description of the standard of care.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

stepsArray of objects(StepDto)required

Ordered steps or components that make up this standard of care.

steps[].​descriptionstring or null

Detailed description of what should be done in this step.

steps[].​recommendedServicesArray of objects(RecommendedServiceDto)

Services, procedures, or products recommended in this step.

steps[].​sequencenumberrequired

Order of this step within the standard of care.

steps[].​stepIdstringrequired

Identifier for this step within the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
steps[].​titlestringrequired

Short title or label for this step.

versionstring or null

Version identifier for this standard of care definition.

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare/{standardofcareId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "applicableSpecies": [
      {
        "code": "string",
        "display": "string",
        "system": "string"
      }
    ],
    "category": "string",
    "description": "string",
    "extensions": {},
    "isActive": true,
    "name": "string",
    "steps": [
      {
        "description": "string",
        "recommendedServices": [
          {
            "display": "string",
            "serviceId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "sequence": 0,
        "stepId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string"
      }
    ],
    "version": "string"
  }'

Responses

Standardofcare replaced successfully

Bodyapplication/json
applicableSpeciesArray of objects(ApplicableSpecieDto)required

Species for which this standard of care is applicable.

applicableSpecies[].​codestringrequired

Code representing the species.

applicableSpecies[].​displaystring or null

Human-readable species name.

applicableSpecies[].​systemstring or nullrequired

URI of the code system that defines the species code.

categorystring or nullrequired

High-level category or grouping for this standard of care.

createdAtstring(date-time)required

Timestamp when this standard of care was created.

Example: "2025-01-01T00:00:00.000Z"
descriptionstring or nullrequired

Detailed description of the standard of care.

extensionsobjectrequired

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this standard of care is currently active and can be applied.

namestringrequired

Human-readable name of the standard of care.

standardofcareIdstringrequired

Canonical identifier for the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
stepsArray of objects(StepDto)required

Ordered steps or components that make up this standard of care.

steps[].​descriptionstring or null

Detailed description of what should be done in this step.

steps[].​recommendedServicesArray of objects(RecommendedServiceDto)

Services, procedures, or products recommended in this step.

steps[].​sequencenumberrequired

Order of this step within the standard of care.

steps[].​stepIdstringrequired

Identifier for this step within the standard of care.

Example: "123e4567-e89b-12d3-a456-426614174000"
steps[].​titlestringrequired

Short title or label for this step.

updatedAtstring(date-time)required

Timestamp when this standard of care was last updated.

Example: "2025-01-01T00:00:00.000Z"
versionstring or nullrequired

Version identifier for this standard of care definition.

Response
application/json
{
  "applicableSpecies": [
    { … }
  ],
  "category": "string",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "description": "string",
  "extensions": {},
  "isActive": true,
  "name": "string",
  "standardofcareId": "123e4567-e89b-12d3-a456-426614174000",
  "steps": [
    { … }
  ],
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "version": "string"
}

Delete standardofcare

Request

Permanently deletes a Standardofcare record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardofcareIdstringrequired

Standardofcare unique identifier (UUID)

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standardofcare/{standardofcareId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Standardofcare deleted successfully

Stock Adjustment

Operations

Stock Adjustment Item

Operations

Stock Transaction

Operations

Supplied

Operations

System Setting

Operations

Tag

Operations

Tagcategory

Operations

Tagname

Operations

Taxrate

Operations

Template

Operations

Therapeutic

Operations

Transaction

Operations

User

Operations

Vaccination

Operations

Webhook

Operations

Webhook Event

Operations

Wellness Resource

Operations

With Primary Inventory Location

Operations