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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
diagnosticCodeIdstring

Canonical unique identifier for this diagnostic code record.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this diagnostic code is currently active and usable.

Example: true
isDiscountableboolean

Indicates whether discounts may be applied to this diagnostic code.

Example: true
priceobject

Price information for this diagnostic code, excluding tax.

validFromDatestring

Date from which this diagnostic code is considered valid.

Example: "2025-01-01"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/diagnostic-code' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": {
      "code": "12345",
      "system": "http://example.com/codesystem",
      "display": "Example Display Name"
    },
    "diagnosticCodeId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "isDiscountable": true,
    "price": {},
    "validFromDate": "2025-01-01"
  }'

Responses

Diagnostic Code created successfully

Bodyapplication/json
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
createdAtstring(date-time)required

Timestamp when this diagnostic code record was created.

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

Canonical unique identifier for this diagnostic code record.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this diagnostic code is currently active and usable.

Example: true
isDiscountablebooleanrequired

Indicates whether discounts may be applied to this diagnostic code.

Example: true
priceobjectrequired

Price information for this diagnostic code, excluding tax.

updatedAtstring(date-time)required

Timestamp when this diagnostic code record was last updated.

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

Date from which this diagnostic code is considered valid.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "code": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "createdAt": "2025-01-01T00:00:00.000Z", "diagnosticCodeId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "isActive": true, "isDiscountable": true, "price": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "validFromDate": "2025-01-01T00:00:00Z" }

Request

Returns a paginated list of Diagnostic Codes 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""validFromDate"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
isActiveboolean

Indicates whether this diagnostic code is currently active and usable.

isDiscountableboolean

Indicates whether discounts may be applied to this diagnostic code.

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

Responses

Paginated list of Diagnostic Codes

Request

Returns a single Diagnostic Code by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticCodeIdstringrequired

Diagnostic Code unique identifier (UUID)

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

Responses

Diagnostic Code found

Bodyapplication/json
codeobjectrequired
code.​codestringrequired

Code value

Example: "12345"
code.​systemstringrequired

Code system URI

Example: "http://example.com/codesystem"
code.​displaystring

Human-readable display

Example: "Example Display Name"
createdAtstring(date-time)required

Timestamp when this diagnostic code record was created.

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

Canonical unique identifier for this diagnostic code record.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this diagnostic code is currently active and usable.

Example: true
isDiscountablebooleanrequired

Indicates whether discounts may be applied to this diagnostic code.

Example: true
priceobjectrequired

Price information for this diagnostic code, excluding tax.

updatedAtstring(date-time)required

Timestamp when this diagnostic code record was last updated.

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

Date from which this diagnostic code is considered valid.

Example: "2025-01-01T00:00:00Z"
Response
application/json
{ "code": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" }, "createdAt": "2025-01-01T00:00:00.000Z", "diagnosticCodeId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "isActive": true, "isDiscountable": true, "price": {}, "updatedAt": "2025-01-01T00:00:00.000Z", "validFromDate": "2025-01-01T00:00:00Z" }
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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations