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

Partially updates an existing Physical Exam. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobject
commentsstring

Free-text comments or findings from the physical exam.

consultIdstring

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstring

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

vetIdstring

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/physical-exam/{physicalExamId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "bodySystem": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "comments": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "examinedAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Physical Exam updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "bodySystem": { "code": "string", "system": "string", "display": "string" }, "comments": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "examinedAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "physicalExamId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Fully replaces an existing Physical Exam. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

vetIdstringrequired

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/physical-exam/{physicalExamId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "bodySystem": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "comments": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "examinedAt": "2025-01-01T00:00:00.000Z",
    "extensions": {},
    "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "vetId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Physical Exam replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal that this physical exam pertains to.

Example: "123e4567-e89b-12d3-a456-426614174000"
bodySystemobjectrequired
bodySystem.​codestringrequired

Code value

bodySystem.​systemstringrequired

Code system URI

bodySystem.​displaystring

Human-readable display

commentsstringrequired

Free-text comments or findings from the physical exam.

consultIdstringrequired

Identifier of the consult/visit associated with this physical exam.

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

Timestamp when the physical exam record was created.

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

Timestamp when the physical exam was performed or recorded.

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

Vendor- or practice-specific extensions.

historicalRecordIdstringrequired

Identifier linking this record to a historical record in the source system.

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

Whether this physical exam record is active.

physicalExamIdstringrequired

Canonical identifier for the physical exam record.

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

Timestamp when the physical exam record was last modified.

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

Identifier of the veterinarian who performed or recorded the exam.

Example: "123e4567-e89b-12d3-a456-426614174000"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "bodySystem": { "code": "string", "system": "string", "display": "string" }, "comments": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "examinedAt": "2025-01-01T00:00:00.000Z", "extensions": {}, "historicalRecordId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "physicalExamId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z", "vetId": "123e4567-e89b-12d3-a456-426614174000" }

Request

Permanently deletes a Physical Exam record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

physicalExamIdstringrequired

Physical Exam unique identifier (UUID)

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

Responses

Physical Exam 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
Operations
Operations
Operations
Operations
Operations
Operations