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

Fully replaces an existing Diagnostic Code. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticCodeIdstringrequired

Diagnostic Code unique identifier (UUID)

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

validFromDatestringrequired

Date from which this diagnostic code is considered valid.

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

Responses

Diagnostic Code replaced 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

Permanently deletes a Diagnostic Code record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

diagnosticCodeIdstringrequired

Diagnostic Code unique identifier (UUID)

curl -i -X DELETE \
  '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 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
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