Delete health status

Animal
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Animal Colour
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Breed
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Health Status
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

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"

Example: "bar"

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"

Example: "lt_1_sec"

cervixCytologyScorenumber or null

Cervix cytology score.

Example: 1.23

cervixTonenumber or null

Cervix tone assessment (numeric scale).

Example: 1.23

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.

Example: true

isPregnantboolean or null

Pregnancy status, if assessed.

Example: true

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"

Example: "blue"

notesstring or null

Free-text clinical notes related to this health status.

Example: "Example description"

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"

Example: "bounding"

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"

Example: "normal"

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"

Example: "body"

uterineCytologyScorenumber or null

Uterine cytology score.

Example: 1.23

uterineEdemanumber or null

Uterine edema assessment (numeric scale).

Example: 1.23

uterineFluidstring or null

Presence of uterine fluid.

Enum"positive""negative"

Example: "positive"

uterineTonenumber or null

Uterine tone assessment (numeric scale).

Example: 1.23

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": 1.5,
      "unit": "km",
      "system": "http://unitsofmeasure.org"
    },
    "bodyConditionScore": {},
    "capillaryRefillTime": "lt_1_sec",
    "cervixCytologyScore": 1.23,
    "cervixTone": 1.23,
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "dentalScore": {},
    "extensions": {},
    "heartRate": {
      "value": 1.5,
      "unit": "km",
      "system": "http://unitsofmeasure.org"
    },
    "isActive": true,
    "isPregnant": true,
    "leftOvary": {},
    "mucousMembraneColor": "blue",
    "notes": "Example description",
    "painScore": {},
    "pulseQuality": "bounding",
    "recordedAt": "2025-01-01T00:00:00.000Z",
    "respiratoryEffort": "normal",
    "respiratoryRate": {
      "value": 1.5,
      "unit": "km",
      "system": "http://unitsofmeasure.org"
    },
    "rightOvary": {},
    "temperature": {
      "value": 1.5,
      "unit": "km",
      "system": "http://unitsofmeasure.org"
    },
    "uterineCystLocation": "body",
    "uterineCytologyScore": 1.23,
    "uterineEdema": 1.23,
    "uterineFluid": "positive",
    "uterineTone": 1.23,
    "weight": {
      "value": 1.5,
      "unit": "km",
      "system": "http://unitsofmeasure.org"
    }
  }'

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"

Example: "bar"

bloodPressureobject or nullrequired

bloodPressure.valuenumberrequired

Numeric value

Example: 1.5

bloodPressure.unitstringrequired

Unit of measure

Example: "km"

bloodPressure.systemstring

Unit system URI

Example: "http://unitsofmeasure.org"

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"

Example: "lt_1_sec"

cervixCytologyScorenumber or nullrequired

Cervix cytology score.

Example: 1.23

cervixTonenumber or nullrequired

Cervix tone assessment (numeric scale).

Example: 1.23

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

Example: 1.5

heartRate.unitstringrequired

Unit of measure

Example: "km"

heartRate.systemstring

Unit system URI

Example: "http://unitsofmeasure.org"

isActivebooleanrequired

Whether this health status record is currently active.

Example: true

isPregnantboolean or nullrequired

Pregnancy status, if assessed.

Example: true

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"

Example: "blue"

notesstring or nullrequired

Free-text clinical notes related to this health status.

Example: "Example description"

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"

Example: "bounding"

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"

Example: "normal"

respiratoryRateobject or nullrequired

respiratoryRate.valuenumberrequired

Numeric value

Example: 1.5

respiratoryRate.unitstringrequired

Unit of measure

Example: "km"

respiratoryRate.systemstring

Unit system URI

Example: "http://unitsofmeasure.org"

rightOvaryobject or nullrequired

Findings for the right ovary.

temperatureobject or nullrequired

temperature.valuenumberrequired

Numeric value

Example: 1.5

temperature.unitstringrequired

Unit of measure

Example: "km"

temperature.systemstring

Unit system URI

Example: "http://unitsofmeasure.org"

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"

Example: "body"

uterineCytologyScorenumber or nullrequired

Uterine cytology score.

Example: 1.23

uterineEdemanumber or nullrequired

Uterine edema assessment (numeric scale).

Example: 1.23

uterineFluidstring or nullrequired

Presence of uterine fluid.

Enum"positive""negative"

Example: "positive"

uterineTonenumber or nullrequired

Uterine tone assessment (numeric scale).

Example: 1.23

weightobject or nullrequired

weight.valuenumberrequired

Numeric value

Example: 1.5

weight.unitstringrequired

Unit of measure

Example: "km"

weight.systemstring

Unit system URI

Example: "http://unitsofmeasure.org"

Response

application/json

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