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

Create health status

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or null

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or null
bodyConditionScoreobject or null

Body condition score (BCS).

capillaryRefillTimestring or null

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or null

Cervix cytology score.

cervixTonenumber or null

Cervix tone assessment (numeric scale).

consultIdstring or null

Identifier of the consult/visit associated with this health status.

Example: "123e4567-e89b-12d3-a456-426614174000"
dentalScoreobject or null

Dental score assessment.

extensionsobject

Vendor- or practice-specific extensions.

healthStatusIdstringrequired

Canonical identifier for this health status record.

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

Whether this health status record is currently active.

isPregnantboolean or null

Pregnancy status, if assessed.

leftOvaryobject or null

Findings for the left ovary.

mucousMembraneColorstring or null

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or null

Free-text clinical notes related to this health status.

painScoreobject or null

Pain score assessment.

pulseQualitystring or null

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstringrequired

Date and time when this health status was recorded.

Example: "2025-01-01T00:00:00.000Z"
respiratoryEffortstring or null

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or null
rightOvaryobject or null

Findings for the right ovary.

temperatureobject or null
uterineCystLocationstring or null

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or null

Uterine cytology score.

uterineEdemanumber or null

Uterine edema assessment (numeric scale).

uterineFluidstring or null

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or null

Uterine tone assessment (numeric scale).

weightobject or null
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/health-status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attitude": "bar",
    "bloodPressure": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "bodyConditionScore": {},
    "capillaryRefillTime": "lt_1_sec",
    "cervixCytologyScore": 0,
    "cervixTone": 0,
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "dentalScore": {},
    "extensions": {},
    "healthStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "heartRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "isActive": true,
    "isPregnant": true,
    "leftOvary": {},
    "mucousMembraneColor": "blue",
    "notes": "string",
    "painScore": {},
    "pulseQuality": "bounding",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "respiratoryEffort": "normal",
    "respiratoryRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "rightOvary": {},
    "temperature": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "uterineCystLocation": "body",
    "uterineCytologyScore": 0,
    "uterineEdema": 0,
    "uterineFluid": "positive",
    "uterineTone": 0,
    "weight": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Health Status created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or nullrequired

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or nullrequired
bloodPressure.​valuenumberrequired

Numeric value

bloodPressure.​unitstringrequired

Unit of measure

bloodPressure.​systemstring

Unit system URI

bodyConditionScoreobject or nullrequired

Body condition score (BCS).

capillaryRefillTimestring or nullrequired

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or nullrequired

Cervix cytology score.

cervixTonenumber or nullrequired

Cervix tone assessment (numeric scale).

consultIdstring or nullrequired

Identifier of the consult/visit associated with this health status.

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

Timestamp when this record was created in the source system.

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

Dental score assessment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

healthStatusIdstringrequired

Canonical identifier for this health status record.

Example: "123e4567-e89b-12d3-a456-426614174000"
heartRateobject or nullrequired
heartRate.​valuenumberrequired

Numeric value

heartRate.​unitstringrequired

Unit of measure

heartRate.​systemstring

Unit system URI

isActivebooleanrequired

Whether this health status record is currently active.

isPregnantboolean or nullrequired

Pregnancy status, if assessed.

leftOvaryobject or nullrequired

Findings for the left ovary.

mucousMembraneColorstring or nullrequired

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or nullrequired

Free-text clinical notes related to this health status.

painScoreobject or nullrequired

Pain score assessment.

pulseQualitystring or nullrequired

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstring(date-time)required

Date and time when this health status was recorded.

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

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or nullrequired
respiratoryRate.​valuenumberrequired

Numeric value

respiratoryRate.​unitstringrequired

Unit of measure

respiratoryRate.​systemstring

Unit system URI

rightOvaryobject or nullrequired

Findings for the right ovary.

temperatureobject or nullrequired
temperature.​valuenumberrequired

Numeric value

temperature.​unitstringrequired

Unit of measure

temperature.​systemstring

Unit system URI

updatedAtstring or null(date-time)required

Timestamp when this record was last updated in the source system.

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

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or nullrequired

Uterine cytology score.

uterineEdemanumber or nullrequired

Uterine edema assessment (numeric scale).

uterineFluidstring or nullrequired

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or nullrequired

Uterine tone assessment (numeric scale).

weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "attitude": "bar",
  "bloodPressure": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "bodyConditionScore": {},
  "capillaryRefillTime": "lt_1_sec",
  "cervixCytologyScore": 0,
  "cervixTone": 0,
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "dentalScore": {},
  "extensions": {},
  "healthStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "heartRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "isActive": true,
  "isPregnant": true,
  "leftOvary": {},
  "mucousMembraneColor": "blue",
  "notes": "string",
  "painScore": {},
  "pulseQuality": "bounding",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "respiratoryEffort": "normal",
  "respiratoryRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "rightOvary": {},
  "temperature": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "uterineCystLocation": "body",
  "uterineCytologyScore": 0,
  "uterineEdema": 0,
  "uterineFluid": "positive",
  "uterineTone": 0,
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  }
}

List health statuses

Request

Returns a paginated list of Health Statuses 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""cervixCytologyScore""cervixTone""notes""recordedAt""uterineCytologyScore""uterineEdema""uterineTone"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
animalIdstring

Identifier of the animal this health status belongs to.

Example: animalId=123e4567-e89b-12d3-a456-426614174000
attitudestring

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
capillaryRefillTimestring

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
consultIdstring

Identifier of the consult/visit associated with this health status.

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

Whether this health status record is currently active.

isPregnantboolean

Pregnancy status, if assessed.

mucousMembraneColorstring

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring

Free-text clinical notes related to this health status.

pulseQualitystring

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
respiratoryEffortstring

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
uterineCystLocationstring

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineFluidstring

Presence of uterine fluid.

Enum"positive""negative"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/health-status?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&attitude=bar&capillaryRefillTime=lt_1_sec&consultId=123e4567-e89b-12d3-a456-426614174000&isActive=true&isPregnant=true&mucousMembraneColor=blue&notes=string&pulseQuality=bounding&respiratoryEffort=normal&uterineCystLocation=body&uterineFluid=positive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Health Statuses

Get health status

Request

Returns a single Health Status by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

healthStatusIdstringrequired

Health Status unique identifier (UUID)

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

Responses

Health Status found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or nullrequired

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or nullrequired
bloodPressure.​valuenumberrequired

Numeric value

bloodPressure.​unitstringrequired

Unit of measure

bloodPressure.​systemstring

Unit system URI

bodyConditionScoreobject or nullrequired

Body condition score (BCS).

capillaryRefillTimestring or nullrequired

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or nullrequired

Cervix cytology score.

cervixTonenumber or nullrequired

Cervix tone assessment (numeric scale).

consultIdstring or nullrequired

Identifier of the consult/visit associated with this health status.

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

Timestamp when this record was created in the source system.

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

Dental score assessment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

healthStatusIdstringrequired

Canonical identifier for this health status record.

Example: "123e4567-e89b-12d3-a456-426614174000"
heartRateobject or nullrequired
heartRate.​valuenumberrequired

Numeric value

heartRate.​unitstringrequired

Unit of measure

heartRate.​systemstring

Unit system URI

isActivebooleanrequired

Whether this health status record is currently active.

isPregnantboolean or nullrequired

Pregnancy status, if assessed.

leftOvaryobject or nullrequired

Findings for the left ovary.

mucousMembraneColorstring or nullrequired

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or nullrequired

Free-text clinical notes related to this health status.

painScoreobject or nullrequired

Pain score assessment.

pulseQualitystring or nullrequired

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstring(date-time)required

Date and time when this health status was recorded.

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

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or nullrequired
respiratoryRate.​valuenumberrequired

Numeric value

respiratoryRate.​unitstringrequired

Unit of measure

respiratoryRate.​systemstring

Unit system URI

rightOvaryobject or nullrequired

Findings for the right ovary.

temperatureobject or nullrequired
temperature.​valuenumberrequired

Numeric value

temperature.​unitstringrequired

Unit of measure

temperature.​systemstring

Unit system URI

updatedAtstring or null(date-time)required

Timestamp when this record was last updated in the source system.

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

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or nullrequired

Uterine cytology score.

uterineEdemanumber or nullrequired

Uterine edema assessment (numeric scale).

uterineFluidstring or nullrequired

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or nullrequired

Uterine tone assessment (numeric scale).

weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "attitude": "bar",
  "bloodPressure": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "bodyConditionScore": {},
  "capillaryRefillTime": "lt_1_sec",
  "cervixCytologyScore": 0,
  "cervixTone": 0,
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "dentalScore": {},
  "extensions": {},
  "healthStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "heartRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "isActive": true,
  "isPregnant": true,
  "leftOvary": {},
  "mucousMembraneColor": "blue",
  "notes": "string",
  "painScore": {},
  "pulseQuality": "bounding",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "respiratoryEffort": "normal",
  "respiratoryRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "rightOvary": {},
  "temperature": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "uterineCystLocation": "body",
  "uterineCytologyScore": 0,
  "uterineEdema": 0,
  "uterineFluid": "positive",
  "uterineTone": 0,
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  }
}

Update health status

Request

Partially updates an existing Health Status. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

healthStatusIdstringrequired

Health Status unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or null

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or null
bodyConditionScoreobject or null

Body condition score (BCS).

capillaryRefillTimestring or null

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or null

Cervix cytology score.

cervixTonenumber or null

Cervix tone assessment (numeric scale).

consultIdstring or null

Identifier of the consult/visit associated with this health status.

Example: "123e4567-e89b-12d3-a456-426614174000"
dentalScoreobject or null

Dental score assessment.

extensionsobject

Vendor- or practice-specific extensions.

heartRateobject or null
isActiveboolean

Whether this health status record is currently active.

isPregnantboolean or null

Pregnancy status, if assessed.

leftOvaryobject or null

Findings for the left ovary.

mucousMembraneColorstring or null

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or null

Free-text clinical notes related to this health status.

painScoreobject or null

Pain score assessment.

pulseQualitystring or null

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstring

Date and time when this health status was recorded.

Example: "2025-01-01T00:00:00.000Z"
respiratoryEffortstring or null

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or null
rightOvaryobject or null

Findings for the right ovary.

temperatureobject or null
uterineCystLocationstring or null

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or null

Uterine cytology score.

uterineEdemanumber or null

Uterine edema assessment (numeric scale).

uterineFluidstring or null

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or null

Uterine tone assessment (numeric scale).

weightobject or null
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/health-status/{healthStatusId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attitude": "bar",
    "bloodPressure": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "bodyConditionScore": {},
    "capillaryRefillTime": "lt_1_sec",
    "cervixCytologyScore": 0,
    "cervixTone": 0,
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "dentalScore": {},
    "extensions": {},
    "heartRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "isActive": true,
    "isPregnant": true,
    "leftOvary": {},
    "mucousMembraneColor": "blue",
    "notes": "string",
    "painScore": {},
    "pulseQuality": "bounding",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "respiratoryEffort": "normal",
    "respiratoryRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "rightOvary": {},
    "temperature": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "uterineCystLocation": "body",
    "uterineCytologyScore": 0,
    "uterineEdema": 0,
    "uterineFluid": "positive",
    "uterineTone": 0,
    "weight": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Health Status updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or nullrequired

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or nullrequired
bloodPressure.​valuenumberrequired

Numeric value

bloodPressure.​unitstringrequired

Unit of measure

bloodPressure.​systemstring

Unit system URI

bodyConditionScoreobject or nullrequired

Body condition score (BCS).

capillaryRefillTimestring or nullrequired

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or nullrequired

Cervix cytology score.

cervixTonenumber or nullrequired

Cervix tone assessment (numeric scale).

consultIdstring or nullrequired

Identifier of the consult/visit associated with this health status.

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

Timestamp when this record was created in the source system.

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

Dental score assessment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

healthStatusIdstringrequired

Canonical identifier for this health status record.

Example: "123e4567-e89b-12d3-a456-426614174000"
heartRateobject or nullrequired
heartRate.​valuenumberrequired

Numeric value

heartRate.​unitstringrequired

Unit of measure

heartRate.​systemstring

Unit system URI

isActivebooleanrequired

Whether this health status record is currently active.

isPregnantboolean or nullrequired

Pregnancy status, if assessed.

leftOvaryobject or nullrequired

Findings for the left ovary.

mucousMembraneColorstring or nullrequired

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or nullrequired

Free-text clinical notes related to this health status.

painScoreobject or nullrequired

Pain score assessment.

pulseQualitystring or nullrequired

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstring(date-time)required

Date and time when this health status was recorded.

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

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or nullrequired
respiratoryRate.​valuenumberrequired

Numeric value

respiratoryRate.​unitstringrequired

Unit of measure

respiratoryRate.​systemstring

Unit system URI

rightOvaryobject or nullrequired

Findings for the right ovary.

temperatureobject or nullrequired
temperature.​valuenumberrequired

Numeric value

temperature.​unitstringrequired

Unit of measure

temperature.​systemstring

Unit system URI

updatedAtstring or null(date-time)required

Timestamp when this record was last updated in the source system.

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

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or nullrequired

Uterine cytology score.

uterineEdemanumber or nullrequired

Uterine edema assessment (numeric scale).

uterineFluidstring or nullrequired

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or nullrequired

Uterine tone assessment (numeric scale).

weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "attitude": "bar",
  "bloodPressure": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "bodyConditionScore": {},
  "capillaryRefillTime": "lt_1_sec",
  "cervixCytologyScore": 0,
  "cervixTone": 0,
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "dentalScore": {},
  "extensions": {},
  "healthStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "heartRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "isActive": true,
  "isPregnant": true,
  "leftOvary": {},
  "mucousMembraneColor": "blue",
  "notes": "string",
  "painScore": {},
  "pulseQuality": "bounding",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "respiratoryEffort": "normal",
  "respiratoryRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "rightOvary": {},
  "temperature": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "uterineCystLocation": "body",
  "uterineCytologyScore": 0,
  "uterineEdema": 0,
  "uterineFluid": "positive",
  "uterineTone": 0,
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  }
}

Replace health status

Request

Fully replaces an existing Health Status. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

healthStatusIdstringrequired

Health Status unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or null

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or null
bodyConditionScoreobject or null

Body condition score (BCS).

capillaryRefillTimestring or null

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or null

Cervix cytology score.

cervixTonenumber or null

Cervix tone assessment (numeric scale).

consultIdstring or null

Identifier of the consult/visit associated with this health status.

Example: "123e4567-e89b-12d3-a456-426614174000"
dentalScoreobject or null

Dental score assessment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

heartRateobject or null
isActivebooleanrequired

Whether this health status record is currently active.

isPregnantboolean or null

Pregnancy status, if assessed.

leftOvaryobject or null

Findings for the left ovary.

mucousMembraneColorstring or null

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or null

Free-text clinical notes related to this health status.

painScoreobject or null

Pain score assessment.

pulseQualitystring or null

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstringrequired

Date and time when this health status was recorded.

Example: "2025-01-01T00:00:00.000Z"
respiratoryEffortstring or null

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or null
rightOvaryobject or null

Findings for the right ovary.

temperatureobject or null
uterineCystLocationstring or null

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or null

Uterine cytology score.

uterineEdemanumber or null

Uterine edema assessment (numeric scale).

uterineFluidstring or null

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or null

Uterine tone assessment (numeric scale).

weightobject or null
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/health-status/{healthStatusId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attitude": "bar",
    "bloodPressure": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "bodyConditionScore": {},
    "capillaryRefillTime": "lt_1_sec",
    "cervixCytologyScore": 0,
    "cervixTone": 0,
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "dentalScore": {},
    "extensions": {},
    "heartRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "isActive": true,
    "isPregnant": true,
    "leftOvary": {},
    "mucousMembraneColor": "blue",
    "notes": "string",
    "painScore": {},
    "pulseQuality": "bounding",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "respiratoryEffort": "normal",
    "respiratoryRate": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "rightOvary": {},
    "temperature": {
      "value": 0,
      "unit": "string",
      "system": "string"
    },
    "uterineCystLocation": "body",
    "uterineCytologyScore": 0,
    "uterineEdema": 0,
    "uterineFluid": "positive",
    "uterineTone": 0,
    "weight": {
      "value": 0,
      "unit": "string",
      "system": "string"
    }
  }'

Responses

Health Status replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal this health status belongs to.

Example: "123e4567-e89b-12d3-a456-426614174000"
attitudestring or nullrequired

General attitude/mentation.

Enum"bar""qar""comatose""sleeping""vocalising""sedate"
bloodPressureobject or nullrequired
bloodPressure.​valuenumberrequired

Numeric value

bloodPressure.​unitstringrequired

Unit of measure

bloodPressure.​systemstring

Unit system URI

bodyConditionScoreobject or nullrequired

Body condition score (BCS).

capillaryRefillTimestring or nullrequired

Capillary refill time category.

Enum"lt_1_sec""between_1_and_2_sec""gt_2_sec"
cervixCytologyScorenumber or nullrequired

Cervix cytology score.

cervixTonenumber or nullrequired

Cervix tone assessment (numeric scale).

consultIdstring or nullrequired

Identifier of the consult/visit associated with this health status.

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

Timestamp when this record was created in the source system.

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

Dental score assessment.

extensionsobjectrequired

Vendor- or practice-specific extensions.

healthStatusIdstringrequired

Canonical identifier for this health status record.

Example: "123e4567-e89b-12d3-a456-426614174000"
heartRateobject or nullrequired
heartRate.​valuenumberrequired

Numeric value

heartRate.​unitstringrequired

Unit of measure

heartRate.​systemstring

Unit system URI

isActivebooleanrequired

Whether this health status record is currently active.

isPregnantboolean or nullrequired

Pregnancy status, if assessed.

leftOvaryobject or nullrequired

Findings for the left ovary.

mucousMembraneColorstring or nullrequired

Mucous membrane color/character.

Enum"blue""grey""white""pale""yellow""pigmented""tacky""pale_pink""pink""injected"
notesstring or nullrequired

Free-text clinical notes related to this health status.

painScoreobject or nullrequired

Pain score assessment.

pulseQualitystring or nullrequired

Pulse quality assessment.

Enum"bounding""normal""fair""difficult_to_palpate""weak""no_pulse_detected""dropped_pulse"
recordedAtstring(date-time)required

Date and time when this health status was recorded.

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

Respiratory effort assessment.

Enum"normal""laboured_breathing""shallow"
respiratoryRateobject or nullrequired
respiratoryRate.​valuenumberrequired

Numeric value

respiratoryRate.​unitstringrequired

Unit of measure

respiratoryRate.​systemstring

Unit system URI

rightOvaryobject or nullrequired

Findings for the right ovary.

temperatureobject or nullrequired
temperature.​valuenumberrequired

Numeric value

temperature.​unitstringrequired

Unit of measure

temperature.​systemstring

Unit system URI

updatedAtstring or null(date-time)required

Timestamp when this record was last updated in the source system.

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

Location of uterine cysts, if present.

Enum"body""left_horn""right_horn""negative"
uterineCytologyScorenumber or nullrequired

Uterine cytology score.

uterineEdemanumber or nullrequired

Uterine edema assessment (numeric scale).

uterineFluidstring or nullrequired

Presence of uterine fluid.

Enum"positive""negative"
uterineTonenumber or nullrequired

Uterine tone assessment (numeric scale).

weightobject or nullrequired
weight.​valuenumberrequired

Numeric value

weight.​unitstringrequired

Unit of measure

weight.​systemstring

Unit system URI

Response
application/json
{
  "animalId": "123e4567-e89b-12d3-a456-426614174000",
  "attitude": "bar",
  "bloodPressure": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "bodyConditionScore": {},
  "capillaryRefillTime": "lt_1_sec",
  "cervixCytologyScore": 0,
  "cervixTone": 0,
  "consultId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "dentalScore": {},
  "extensions": {},
  "healthStatusId": "123e4567-e89b-12d3-a456-426614174000",
  "heartRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "isActive": true,
  "isPregnant": true,
  "leftOvary": {},
  "mucousMembraneColor": "blue",
  "notes": "string",
  "painScore": {},
  "pulseQuality": "bounding",
  "recordedAt": "2025-01-01T00:00:00.000Z",
  "respiratoryEffort": "normal",
  "respiratoryRate": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "rightOvary": {},
  "temperature": {
    "value": 0,
    "unit": "string",
    "system": "string"
  },
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "uterineCystLocation": "body",
  "uterineCytologyScore": 0,
  "uterineEdema": 0,
  "uterineFluid": "positive",
  "uterineTone": 0,
  "weight": {
    "value": 0,
    "unit": "string",
    "system": "string"
  }
}

Delete health status

Request

Permanently deletes a Health Status record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

healthStatusIdstringrequired

Health Status unique identifier (UUID)

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

Responses

Health Status deleted successfully

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

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