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

Request

Creates a new Presenting Problem Link record. Presenting Problem Link resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
consultIdstringrequired

Identifier of the consult associated with this link.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this link is currently active.

presentingProblemIdstringrequired

Identifier of the presenting problem associated with this link.

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

Unique identifier for this presenting problem link.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/presenting-problem-link' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "isActive": true,
    "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000",
    "presentingProblemLinkId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Presenting Problem Link created successfully

Bodyapplication/json
consultIdstringrequired

Identifier of the consult associated with this link.

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

Timestamp when this link was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this link is currently active.

presentingProblemIdstringrequired

Identifier of the presenting problem associated with this link.

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

Unique identifier for this presenting problem link.

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

Timestamp when this link was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000", "presentingProblemLinkId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of Presenting Problem Links 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"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
consultIdstring

Identifier of the consult associated with this link.

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

Indicates whether this link is currently active.

presentingProblemIdstring

Identifier of the presenting problem associated with this link.

Example: presentingProblemId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/presenting-problem-link?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&consultId=123e4567-e89b-12d3-a456-426614174000&isActive=true&presentingProblemId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Presenting Problem Links

Request

Returns a single Presenting Problem Link by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

presentingProblemLinkIdstringrequired

Presenting Problem Link unique identifier (UUID)

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

Responses

Presenting Problem Link found

Bodyapplication/json
consultIdstringrequired

Identifier of the consult associated with this link.

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

Timestamp when this link was created.

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

Vendor- or practice-specific extensions.

isActivebooleanrequired

Indicates whether this link is currently active.

presentingProblemIdstringrequired

Identifier of the presenting problem associated with this link.

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

Unique identifier for this presenting problem link.

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

Timestamp when this link was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "isActive": true, "presentingProblemId": "123e4567-e89b-12d3-a456-426614174000", "presentingProblemLinkId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }
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
Operations
Operations
Operations
Operations
Operations
Operations