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

Request

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

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobject
cancellationReasonTextstring

Free-text explanation of the cancellation reason.

consultIdstring or null

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobject

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstringrequired

Scheduled start date and time of the appointment (with timezone).

Example: "2025-01-01T00:00:00.000Z"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentStatus": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReason": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReasonText": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "isActive": true,
    "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceIds": [
      "string"
    ],
    "startAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Appointment created successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

cancellationReason.​systemstringrequired

Code system URI

cancellationReason.​displaystring

Human-readable display

cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "appointmentId": "123e4567-e89b-12d3-a456-426614174000", "appointmentStatus": { "code": "string", "system": "string", "display": "string" }, "appointmentType": { "code": "string", "system": "string", "display": "string" }, "cancellationReason": { "code": "string", "system": "string", "display": "string" }, "cancellationReasonText": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "durationMinutes": 0, "extensions": {}, "isActive": true, "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceIds": [ "string" ], "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Returns a paginated list of Appointments 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""cancellationReasonText""description""durationMinutes""startAt"
sortOrderstring

Sort order

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

Identifier of the animal associated with the appointment.

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

Free-text explanation of the cancellation reason.

consultIdstring

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

Example: contactId=123e4567-e89b-12d3-a456-426614174000
descriptionstring

Free-text description or notes for the appointment.

isActiveboolean

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstring

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

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

Responses

Paginated list of Appointments

Request

Returns a single Appointment by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

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

Responses

Appointment found

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

cancellationReason.​systemstringrequired

Code system URI

cancellationReason.​displaystring

Human-readable display

cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "appointmentId": "123e4567-e89b-12d3-a456-426614174000", "appointmentStatus": { "code": "string", "system": "string", "display": "string" }, "appointmentType": { "code": "string", "system": "string", "display": "string" }, "cancellationReason": { "code": "string", "system": "string", "display": "string" }, "cancellationReasonText": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "durationMinutes": 0, "extensions": {}, "isActive": true, "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceIds": [ "string" ], "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Partially updates an existing Appointment. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstring

Identifier of the animal associated with the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobject
appointmentTypeobject
cancellationReasonobject
cancellationReasonTextstring

Free-text explanation of the cancellation reason.

consultIdstring or null

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Free-text description or notes for the appointment.

durationMinutesnumber

Duration of the appointment in whole minutes.

extensionsobject

Vendor- or practice-specific extension fields.

isActiveboolean

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstring

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of strings

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring

Scheduled start date and time of the appointment (with timezone).

Example: "2025-01-01T00:00:00.000Z"
curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment/{appointmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentStatus": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReason": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReasonText": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "isActive": true,
    "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceIds": [
      "string"
    ],
    "startAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Appointment updated successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

cancellationReason.​systemstringrequired

Code system URI

cancellationReason.​displaystring

Human-readable display

cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "appointmentId": "123e4567-e89b-12d3-a456-426614174000", "appointmentStatus": { "code": "string", "system": "string", "display": "string" }, "appointmentType": { "code": "string", "system": "string", "display": "string" }, "cancellationReason": { "code": "string", "system": "string", "display": "string" }, "cancellationReasonText": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "durationMinutes": 0, "extensions": {}, "isActive": true, "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceIds": [ "string" ], "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Fully replaces an existing Appointment. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

Bodyapplication/jsonrequired
animalIdstringrequired

Identifier of the animal associated with the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

cancellationReason.​systemstringrequired

Code system URI

cancellationReason.​displaystring

Human-readable display

cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

consultIdstring or null

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstringrequired

Scheduled start date and time of the appointment (with timezone).

Example: "2025-01-01T00:00:00.000Z"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/appointment/{appointmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "appointmentStatus": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "appointmentType": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReason": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "cancellationReasonText": "string",
    "consultId": "123e4567-e89b-12d3-a456-426614174000",
    "contactId": "123e4567-e89b-12d3-a456-426614174000",
    "description": "string",
    "durationMinutes": 0,
    "extensions": {},
    "isActive": true,
    "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000",
    "resourceIds": [
      "string"
    ],
    "startAt": "2025-01-01T00:00:00.000Z"
  }'

Responses

Appointment replaced successfully

Bodyapplication/json
animalIdstringrequired

Identifier of the animal associated with the appointment.

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

Canonical identifier for the appointment.

Example: "123e4567-e89b-12d3-a456-426614174000"
appointmentStatusobjectrequired
appointmentStatus.​codestringrequired

Code value

appointmentStatus.​systemstringrequired

Code system URI

appointmentStatus.​displaystring

Human-readable display

appointmentTypeobjectrequired
appointmentType.​codestringrequired

Code value

appointmentType.​systemstringrequired

Code system URI

appointmentType.​displaystring

Human-readable display

cancellationReasonobjectrequired
cancellationReason.​codestringrequired

Code value

cancellationReason.​systemstringrequired

Code system URI

cancellationReason.​displaystring

Human-readable display

cancellationReasonTextstringrequired

Free-text explanation of the cancellation reason.

consultIdstring or nullrequired

Identifier of the consult/visit record linked to this appointment.

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

Identifier of the primary contact (e.g., owner) for the appointment.

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

Timestamp when the appointment was created.

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

Free-text description or notes for the appointment.

durationMinutesnumberrequired

Duration of the appointment in whole minutes.

extensionsobjectrequired

Vendor- or practice-specific extension fields.

isActivebooleanrequired

Whether the appointment is currently active (not deleted/voided).

primaryResourceIdstringrequired

Identifier of the primary resource responsible for the appointment (e.g., veterinarian).

Example: "123e4567-e89b-12d3-a456-426614174000"
resourceIdsArray of stringsrequired

Identifiers of all resources allocated to this appointment (including the primary resource).

startAtstring(date-time)required

Scheduled start date and time of the appointment (with timezone).

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

Timestamp when the appointment was last modified.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "appointmentId": "123e4567-e89b-12d3-a456-426614174000", "appointmentStatus": { "code": "string", "system": "string", "display": "string" }, "appointmentType": { "code": "string", "system": "string", "display": "string" }, "cancellationReason": { "code": "string", "system": "string", "display": "string" }, "cancellationReasonText": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "description": "string", "durationMinutes": 0, "extensions": {}, "isActive": true, "primaryResourceId": "123e4567-e89b-12d3-a456-426614174000", "resourceIds": [ "string" ], "startAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" }

Request

Permanently deletes a Appointment record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

appointmentIdstringrequired

Appointment unique identifier (UUID)

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

Responses

Appointment 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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations