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

Create standard diagnostic lab report

Request

Creates a new Standard Diagnostic Lab Report record. Standard Diagnostic Lab Report resource in the Animal Health Data Store

Security
bearer
Path
siteIdnumberrequired

Site identifier

Bodyapplication/jsonrequired
accessionNumberstring

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)

Associated documents or images (e.g., PDF report, radiology images).

clientProvidedIdstring

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

encounterIdstring

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)

General notes about the lab report.

orderIdstring

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobject
reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)

Individual test results included in this lab report.

specimensArray of objects(SpecimenDto)

Specimens used for this lab report.

standardDiagnosticLabReportIdstringrequired

Canonical identifier for this standard diagnostic lab report.

Example: "123e4567-e89b-12d3-a456-426614174000"
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standard-diagnostic-lab-report' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accessionNumber": "string",
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attachments": [
      {
        "attachmentId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string",
        "type": "string",
        "url": "string"
      }
    ],
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "collectedAt": "2025-01-01T00:00:00.000Z",
    "conclusion": "string",
    "encounterId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "notes": [
      {
        "authorId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "text": "string"
      }
    ],
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "orderedAt": "2025-01-01T00:00:00.000Z",
    "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000",
    "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "receivedAt": "2025-01-01T00:00:00.000Z",
    "recommendations": "string",
    "reportCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "reportStatus": "registered",
    "reportedAt": "2025-01-01T00:00:00.000Z",
    "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "results": [
      {
        "interpretation": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "observedAt": "2025-01-01T00:00:00.000Z",
        "referenceRange": {},
        "resultId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "registered",
        "testCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueQuantity": {
          "value": 0,
          "unit": "string",
          "system": "string"
        },
        "valueString": "string"
      }
    ],
    "specimens": [
      {
        "bodySite": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
        "collectedAt": "2025-01-01T00:00:00.000Z",
        "collectionMethod": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "specimenId": "123e4567-e89b-12d3-a456-426614174000",
        "type": {
          "code": "string",
          "system": "string",
          "display": "string"
        }
      }
    ],
    "standardDiagnosticLabReportId": "123e4567-e89b-12d3-a456-426614174000"
  }'

Responses

Standard Diagnostic Lab Report created successfully

Bodyapplication/json
accessionNumberstringrequired

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)required

Associated documents or images (e.g., PDF report, radiology images).

attachments[].​attachmentIdstring

Identifier for the attachment resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachments[].​titlestring

Human-readable title for the attachment.

attachments[].​typestring

Type of attachment (e.g., 'pdf', 'image', 'dicom').

attachments[].​urlstring

Location where the attachment can be retrieved.

clientProvidedIdstringrequired

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

createdAtstring(date-time)required

Timestamp when this lab report record was created in the AHDS system.

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

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)required

General notes about the lab report.

notes[].​authorIdstring

Identifier of the user or system that authored the note.

Example: "123e4567-e89b-12d3-a456-426614174000"
notes[].​createdAtstring

When the note was created.

Example: "2025-01-01T00:00:00.000Z"
notes[].​textstringrequired

Note text.

orderIdstringrequired

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobjectrequired
reportCode.​codestringrequired

Code value

reportCode.​systemstringrequired

Code system URI

reportCode.​displaystring

Human-readable display

reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring(date-time)required

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)required

Individual test results included in this lab report.

results[].​interpretationobject
results[].​notestring

Free-text comments specific to this result.

results[].​observedAtstring

Date and time when the measurement or observation was made.

Example: "2025-01-01T00:00:00.000Z"
results[].​referenceRangeobject

Reference range for this test result.

results[].​resultIdstring

Identifier for this specific result within the report, if available.

Example: "123e4567-e89b-12d3-a456-426614174000"
results[].​statusstring

Status of this individual result.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
results[].​testCodeobject
results[].​valueCodeobject
results[].​valueQuantityobject
results[].​valueStringstring

Non-numeric result value (e.g., 'positive', 'negative', 'growth').

specimensArray of objects(SpecimenDto)required

Specimens used for this lab report.

specimens[].​bodySiteobject
specimens[].​clientProvidedIdstring

Client- or lab-supplied specimen identifier (e.g., tube barcode).

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​collectedAtstring

Date and time when this specimen was collected.

Example: "2025-01-01T00:00:00.000Z"
specimens[].​collectionMethodobject
specimens[].​notestring

Free-text notes about the specimen.

specimens[].​specimenIdstring

Identifier for the specimen record, if tracked.

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​typeobject
standardDiagnosticLabReportIdstringrequired

Canonical identifier for this standard diagnostic lab report.

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

Timestamp when this lab report record was last updated in the AHDS system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "accessionNumber": "string", "animalId": "123e4567-e89b-12d3-a456-426614174000", "attachments": [ { … } ], "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "collectedAt": "2025-01-01T00:00:00.000Z", "conclusion": "string", "createdAt": "2025-01-01T00:00:00.000Z", "encounterId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "notes": [ { … } ], "orderId": "123e4567-e89b-12d3-a456-426614174000", "orderedAt": "2025-01-01T00:00:00.000Z", "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000", "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000", "receivedAt": "2025-01-01T00:00:00.000Z", "recommendations": "string", "reportCode": { "code": "string", "system": "string", "display": "string" }, "reportStatus": "registered", "reportedAt": "2025-01-01T00:00:00.000Z", "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000", "results": [ { … } ], "specimens": [ { … } ], "standardDiagnosticLabReportId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

List standard diagnostic lab reports

Request

Returns a paginated list of Standard Diagnostic Lab Reports 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""accessionNumber""collectedAt""conclusion""orderedAt""receivedAt""recommendations""reportedAt"
sortOrderstring

Sort order

Default "asc"
Enum"asc""desc"
accessionNumberstring

Laboratory accession or case number assigned by the performing lab.

animalIdstring

Reference to the animal this lab report is associated with.

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

Optional client-supplied identifier used for idempotency or cross-system correlation.

Example: clientProvidedId=123e4567-e89b-12d3-a456-426614174000
conclusionstring

Overall textual conclusion or summary from the lab.

encounterIdstring

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

Example: encounterId=123e4567-e89b-12d3-a456-426614174000
orderIdstring

Reference to the associated diagnostic order, if tracked separately.

Example: orderId=123e4567-e89b-12d3-a456-426614174000
orderingVeterinarianIdstring

Reference to the veterinarian who ordered the diagnostic test(s).

Example: orderingVeterinarianId=123e4567-e89b-12d3-a456-426614174000
performingLabOrganizationIdstring

Reference to the external or internal laboratory organization that performed the tests.

Example: performingLabOrganizationId=123e4567-e89b-12d3-a456-426614174000
recommendationsstring

Recommendations or comments from the lab regarding follow-up or interpretation.

reportStatusstring

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
requestingClinicIdstring

Reference to the clinic or practice that requested the lab work.

Example: requestingClinicId=123e4567-e89b-12d3-a456-426614174000
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standard-diagnostic-lab-report?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&accessionNumber=string&animalId=123e4567-e89b-12d3-a456-426614174000&clientProvidedId=123e4567-e89b-12d3-a456-426614174000&conclusion=string&encounterId=123e4567-e89b-12d3-a456-426614174000&orderId=123e4567-e89b-12d3-a456-426614174000&orderingVeterinarianId=123e4567-e89b-12d3-a456-426614174000&performingLabOrganizationId=123e4567-e89b-12d3-a456-426614174000&recommendations=string&reportStatus=registered&requestingClinicId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Paginated list of Standard Diagnostic Lab Reports

Get standard diagnostic lab report

Request

Returns a single Standard Diagnostic Lab Report by its unique identifier.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardDiagnosticLabReportIdstringrequired

Standard Diagnostic Lab Report unique identifier (UUID)

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

Responses

Standard Diagnostic Lab Report found

Bodyapplication/json
accessionNumberstringrequired

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)required

Associated documents or images (e.g., PDF report, radiology images).

attachments[].​attachmentIdstring

Identifier for the attachment resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachments[].​titlestring

Human-readable title for the attachment.

attachments[].​typestring

Type of attachment (e.g., 'pdf', 'image', 'dicom').

attachments[].​urlstring

Location where the attachment can be retrieved.

clientProvidedIdstringrequired

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

createdAtstring(date-time)required

Timestamp when this lab report record was created in the AHDS system.

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

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)required

General notes about the lab report.

notes[].​authorIdstring

Identifier of the user or system that authored the note.

Example: "123e4567-e89b-12d3-a456-426614174000"
notes[].​createdAtstring

When the note was created.

Example: "2025-01-01T00:00:00.000Z"
notes[].​textstringrequired

Note text.

orderIdstringrequired

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobjectrequired
reportCode.​codestringrequired

Code value

reportCode.​systemstringrequired

Code system URI

reportCode.​displaystring

Human-readable display

reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring(date-time)required

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)required

Individual test results included in this lab report.

results[].​interpretationobject
results[].​notestring

Free-text comments specific to this result.

results[].​observedAtstring

Date and time when the measurement or observation was made.

Example: "2025-01-01T00:00:00.000Z"
results[].​referenceRangeobject

Reference range for this test result.

results[].​resultIdstring

Identifier for this specific result within the report, if available.

Example: "123e4567-e89b-12d3-a456-426614174000"
results[].​statusstring

Status of this individual result.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
results[].​testCodeobject
results[].​valueCodeobject
results[].​valueQuantityobject
results[].​valueStringstring

Non-numeric result value (e.g., 'positive', 'negative', 'growth').

specimensArray of objects(SpecimenDto)required

Specimens used for this lab report.

specimens[].​bodySiteobject
specimens[].​clientProvidedIdstring

Client- or lab-supplied specimen identifier (e.g., tube barcode).

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​collectedAtstring

Date and time when this specimen was collected.

Example: "2025-01-01T00:00:00.000Z"
specimens[].​collectionMethodobject
specimens[].​notestring

Free-text notes about the specimen.

specimens[].​specimenIdstring

Identifier for the specimen record, if tracked.

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​typeobject
standardDiagnosticLabReportIdstringrequired

Canonical identifier for this standard diagnostic lab report.

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

Timestamp when this lab report record was last updated in the AHDS system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "accessionNumber": "string", "animalId": "123e4567-e89b-12d3-a456-426614174000", "attachments": [ { … } ], "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "collectedAt": "2025-01-01T00:00:00.000Z", "conclusion": "string", "createdAt": "2025-01-01T00:00:00.000Z", "encounterId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "notes": [ { … } ], "orderId": "123e4567-e89b-12d3-a456-426614174000", "orderedAt": "2025-01-01T00:00:00.000Z", "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000", "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000", "receivedAt": "2025-01-01T00:00:00.000Z", "recommendations": "string", "reportCode": { "code": "string", "system": "string", "display": "string" }, "reportStatus": "registered", "reportedAt": "2025-01-01T00:00:00.000Z", "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000", "results": [ { … } ], "specimens": [ { … } ], "standardDiagnosticLabReportId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Update standard diagnostic lab report

Request

Partially updates an existing Standard Diagnostic Lab Report. Only provided fields will be updated.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardDiagnosticLabReportIdstringrequired

Standard Diagnostic Lab Report unique identifier (UUID)

Bodyapplication/jsonrequired
accessionNumberstring

Laboratory accession or case number assigned by the performing lab.

animalIdstring

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)

Associated documents or images (e.g., PDF report, radiology images).

clientProvidedIdstring

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

encounterIdstring

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)

General notes about the lab report.

orderIdstring

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobject
reportStatusstring

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)

Individual test results included in this lab report.

specimensArray of objects(SpecimenDto)

Specimens used for this lab report.

curl -i -X PATCH \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standard-diagnostic-lab-report/{standardDiagnosticLabReportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accessionNumber": "string",
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attachments": [
      {
        "attachmentId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string",
        "type": "string",
        "url": "string"
      }
    ],
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "collectedAt": "2025-01-01T00:00:00.000Z",
    "conclusion": "string",
    "encounterId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "notes": [
      {
        "authorId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "text": "string"
      }
    ],
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "orderedAt": "2025-01-01T00:00:00.000Z",
    "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000",
    "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "receivedAt": "2025-01-01T00:00:00.000Z",
    "recommendations": "string",
    "reportCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "reportStatus": "registered",
    "reportedAt": "2025-01-01T00:00:00.000Z",
    "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "results": [
      {
        "interpretation": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "observedAt": "2025-01-01T00:00:00.000Z",
        "referenceRange": {},
        "resultId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "registered",
        "testCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueQuantity": {
          "value": 0,
          "unit": "string",
          "system": "string"
        },
        "valueString": "string"
      }
    ],
    "specimens": [
      {
        "bodySite": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
        "collectedAt": "2025-01-01T00:00:00.000Z",
        "collectionMethod": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "specimenId": "123e4567-e89b-12d3-a456-426614174000",
        "type": {
          "code": "string",
          "system": "string",
          "display": "string"
        }
      }
    ]
  }'

Responses

Standard Diagnostic Lab Report updated successfully

Bodyapplication/json
accessionNumberstringrequired

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)required

Associated documents or images (e.g., PDF report, radiology images).

attachments[].​attachmentIdstring

Identifier for the attachment resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachments[].​titlestring

Human-readable title for the attachment.

attachments[].​typestring

Type of attachment (e.g., 'pdf', 'image', 'dicom').

attachments[].​urlstring

Location where the attachment can be retrieved.

clientProvidedIdstringrequired

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

createdAtstring(date-time)required

Timestamp when this lab report record was created in the AHDS system.

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

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)required

General notes about the lab report.

notes[].​authorIdstring

Identifier of the user or system that authored the note.

Example: "123e4567-e89b-12d3-a456-426614174000"
notes[].​createdAtstring

When the note was created.

Example: "2025-01-01T00:00:00.000Z"
notes[].​textstringrequired

Note text.

orderIdstringrequired

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobjectrequired
reportCode.​codestringrequired

Code value

reportCode.​systemstringrequired

Code system URI

reportCode.​displaystring

Human-readable display

reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring(date-time)required

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)required

Individual test results included in this lab report.

results[].​interpretationobject
results[].​notestring

Free-text comments specific to this result.

results[].​observedAtstring

Date and time when the measurement or observation was made.

Example: "2025-01-01T00:00:00.000Z"
results[].​referenceRangeobject

Reference range for this test result.

results[].​resultIdstring

Identifier for this specific result within the report, if available.

Example: "123e4567-e89b-12d3-a456-426614174000"
results[].​statusstring

Status of this individual result.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
results[].​testCodeobject
results[].​valueCodeobject
results[].​valueQuantityobject
results[].​valueStringstring

Non-numeric result value (e.g., 'positive', 'negative', 'growth').

specimensArray of objects(SpecimenDto)required

Specimens used for this lab report.

specimens[].​bodySiteobject
specimens[].​clientProvidedIdstring

Client- or lab-supplied specimen identifier (e.g., tube barcode).

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​collectedAtstring

Date and time when this specimen was collected.

Example: "2025-01-01T00:00:00.000Z"
specimens[].​collectionMethodobject
specimens[].​notestring

Free-text notes about the specimen.

specimens[].​specimenIdstring

Identifier for the specimen record, if tracked.

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​typeobject
standardDiagnosticLabReportIdstringrequired

Canonical identifier for this standard diagnostic lab report.

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

Timestamp when this lab report record was last updated in the AHDS system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "accessionNumber": "string", "animalId": "123e4567-e89b-12d3-a456-426614174000", "attachments": [ { … } ], "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "collectedAt": "2025-01-01T00:00:00.000Z", "conclusion": "string", "createdAt": "2025-01-01T00:00:00.000Z", "encounterId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "notes": [ { … } ], "orderId": "123e4567-e89b-12d3-a456-426614174000", "orderedAt": "2025-01-01T00:00:00.000Z", "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000", "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000", "receivedAt": "2025-01-01T00:00:00.000Z", "recommendations": "string", "reportCode": { "code": "string", "system": "string", "display": "string" }, "reportStatus": "registered", "reportedAt": "2025-01-01T00:00:00.000Z", "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000", "results": [ { … } ], "specimens": [ { … } ], "standardDiagnosticLabReportId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Replace standard diagnostic lab report

Request

Fully replaces an existing Standard Diagnostic Lab Report. All fields must be provided.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardDiagnosticLabReportIdstringrequired

Standard Diagnostic Lab Report unique identifier (UUID)

Bodyapplication/jsonrequired
accessionNumberstringrequired

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)required

Associated documents or images (e.g., PDF report, radiology images).

attachments[].​attachmentIdstring

Identifier for the attachment resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachments[].​titlestring

Human-readable title for the attachment.

attachments[].​typestring

Type of attachment (e.g., 'pdf', 'image', 'dicom').

attachments[].​urlstring

Location where the attachment can be retrieved.

clientProvidedIdstringrequired

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

encounterIdstringrequired

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)required

General notes about the lab report.

notes[].​authorIdstring

Identifier of the user or system that authored the note.

Example: "123e4567-e89b-12d3-a456-426614174000"
notes[].​createdAtstring

When the note was created.

Example: "2025-01-01T00:00:00.000Z"
notes[].​textstringrequired

Note text.

orderIdstringrequired

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobjectrequired
reportCode.​codestringrequired

Code value

reportCode.​systemstringrequired

Code system URI

reportCode.​displaystring

Human-readable display

reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstringrequired

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)required

Individual test results included in this lab report.

results[].​interpretationobject
results[].​notestring

Free-text comments specific to this result.

results[].​observedAtstring

Date and time when the measurement or observation was made.

Example: "2025-01-01T00:00:00.000Z"
results[].​referenceRangeobject

Reference range for this test result.

results[].​resultIdstring

Identifier for this specific result within the report, if available.

Example: "123e4567-e89b-12d3-a456-426614174000"
results[].​statusstring

Status of this individual result.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
results[].​testCodeobject
results[].​valueCodeobject
results[].​valueQuantityobject
results[].​valueStringstring

Non-numeric result value (e.g., 'positive', 'negative', 'growth').

specimensArray of objects(SpecimenDto)required

Specimens used for this lab report.

specimens[].​bodySiteobject
specimens[].​clientProvidedIdstring

Client- or lab-supplied specimen identifier (e.g., tube barcode).

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​collectedAtstring

Date and time when this specimen was collected.

Example: "2025-01-01T00:00:00.000Z"
specimens[].​collectionMethodobject
specimens[].​notestring

Free-text notes about the specimen.

specimens[].​specimenIdstring

Identifier for the specimen record, if tracked.

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​typeobject
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/standard-diagnostic-lab-report/{standardDiagnosticLabReportId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "accessionNumber": "string",
    "animalId": "123e4567-e89b-12d3-a456-426614174000",
    "attachments": [
      {
        "attachmentId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "string",
        "type": "string",
        "url": "string"
      }
    ],
    "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
    "collectedAt": "2025-01-01T00:00:00.000Z",
    "conclusion": "string",
    "encounterId": "123e4567-e89b-12d3-a456-426614174000",
    "extensions": {},
    "notes": [
      {
        "authorId": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "text": "string"
      }
    ],
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "orderedAt": "2025-01-01T00:00:00.000Z",
    "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000",
    "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000",
    "receivedAt": "2025-01-01T00:00:00.000Z",
    "recommendations": "string",
    "reportCode": {
      "code": "string",
      "system": "string",
      "display": "string"
    },
    "reportStatus": "registered",
    "reportedAt": "2025-01-01T00:00:00.000Z",
    "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000",
    "results": [
      {
        "interpretation": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "observedAt": "2025-01-01T00:00:00.000Z",
        "referenceRange": {},
        "resultId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "registered",
        "testCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueCode": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "valueQuantity": {
          "value": 0,
          "unit": "string",
          "system": "string"
        },
        "valueString": "string"
      }
    ],
    "specimens": [
      {
        "bodySite": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000",
        "collectedAt": "2025-01-01T00:00:00.000Z",
        "collectionMethod": {
          "code": "string",
          "system": "string",
          "display": "string"
        },
        "note": "string",
        "specimenId": "123e4567-e89b-12d3-a456-426614174000",
        "type": {
          "code": "string",
          "system": "string",
          "display": "string"
        }
      }
    ]
  }'

Responses

Standard Diagnostic Lab Report replaced successfully

Bodyapplication/json
accessionNumberstringrequired

Laboratory accession or case number assigned by the performing lab.

animalIdstringrequired

Reference to the animal this lab report is associated with.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachmentsArray of objects(AttachmentDto)required

Associated documents or images (e.g., PDF report, radiology images).

attachments[].​attachmentIdstring

Identifier for the attachment resource.

Example: "123e4567-e89b-12d3-a456-426614174000"
attachments[].​titlestring

Human-readable title for the attachment.

attachments[].​typestring

Type of attachment (e.g., 'pdf', 'image', 'dicom').

attachments[].​urlstring

Location where the attachment can be retrieved.

clientProvidedIdstringrequired

Optional client-supplied identifier used for idempotency or cross-system correlation.

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

Date and time when the specimen was collected.

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

Overall textual conclusion or summary from the lab.

createdAtstring(date-time)required

Timestamp when this lab report record was created in the AHDS system.

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

Reference to the clinical encounter or visit during which this lab report was ordered or reviewed.

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

Vendor- or practice-specific extensions.

notesArray of objects(NoteDto)required

General notes about the lab report.

notes[].​authorIdstring

Identifier of the user or system that authored the note.

Example: "123e4567-e89b-12d3-a456-426614174000"
notes[].​createdAtstring

When the note was created.

Example: "2025-01-01T00:00:00.000Z"
notes[].​textstringrequired

Note text.

orderIdstringrequired

Reference to the associated diagnostic order, if tracked separately.

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

Date and time when the lab tests were ordered.

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

Reference to the veterinarian who ordered the diagnostic test(s).

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

Reference to the external or internal laboratory organization that performed the tests.

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

Date and time when the specimen was received by the performing lab.

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

Recommendations or comments from the lab regarding follow-up or interpretation.

reportCodeobjectrequired
reportCode.​codestringrequired

Code value

reportCode.​systemstringrequired

Code system URI

reportCode.​displaystring

Human-readable display

reportStatusstringrequired

Overall status of the lab report.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
reportedAtstring(date-time)required

Date and time when the final (or current) report was issued.

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

Reference to the clinic or practice that requested the lab work.

Example: "123e4567-e89b-12d3-a456-426614174000"
resultsArray of objects(ResultDto)required

Individual test results included in this lab report.

results[].​interpretationobject
results[].​notestring

Free-text comments specific to this result.

results[].​observedAtstring

Date and time when the measurement or observation was made.

Example: "2025-01-01T00:00:00.000Z"
results[].​referenceRangeobject

Reference range for this test result.

results[].​resultIdstring

Identifier for this specific result within the report, if available.

Example: "123e4567-e89b-12d3-a456-426614174000"
results[].​statusstring

Status of this individual result.

Enum"registered""partial""final""corrected""cancelled""entered-in-error"
results[].​testCodeobject
results[].​valueCodeobject
results[].​valueQuantityobject
results[].​valueStringstring

Non-numeric result value (e.g., 'positive', 'negative', 'growth').

specimensArray of objects(SpecimenDto)required

Specimens used for this lab report.

specimens[].​bodySiteobject
specimens[].​clientProvidedIdstring

Client- or lab-supplied specimen identifier (e.g., tube barcode).

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​collectedAtstring

Date and time when this specimen was collected.

Example: "2025-01-01T00:00:00.000Z"
specimens[].​collectionMethodobject
specimens[].​notestring

Free-text notes about the specimen.

specimens[].​specimenIdstring

Identifier for the specimen record, if tracked.

Example: "123e4567-e89b-12d3-a456-426614174000"
specimens[].​typeobject
standardDiagnosticLabReportIdstringrequired

Canonical identifier for this standard diagnostic lab report.

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

Timestamp when this lab report record was last updated in the AHDS system.

Example: "2025-01-01T00:00:00.000Z"
Response
application/json
{ "accessionNumber": "string", "animalId": "123e4567-e89b-12d3-a456-426614174000", "attachments": [ { … } ], "clientProvidedId": "123e4567-e89b-12d3-a456-426614174000", "collectedAt": "2025-01-01T00:00:00.000Z", "conclusion": "string", "createdAt": "2025-01-01T00:00:00.000Z", "encounterId": "123e4567-e89b-12d3-a456-426614174000", "extensions": {}, "notes": [ { … } ], "orderId": "123e4567-e89b-12d3-a456-426614174000", "orderedAt": "2025-01-01T00:00:00.000Z", "orderingVeterinarianId": "123e4567-e89b-12d3-a456-426614174000", "performingLabOrganizationId": "123e4567-e89b-12d3-a456-426614174000", "receivedAt": "2025-01-01T00:00:00.000Z", "recommendations": "string", "reportCode": { "code": "string", "system": "string", "display": "string" }, "reportStatus": "registered", "reportedAt": "2025-01-01T00:00:00.000Z", "requestingClinicId": "123e4567-e89b-12d3-a456-426614174000", "results": [ { … } ], "specimens": [ { … } ], "standardDiagnosticLabReportId": "123e4567-e89b-12d3-a456-426614174000", "updatedAt": "2025-01-01T00:00:00.000Z" }

Delete standard diagnostic lab report

Request

Permanently deletes a Standard Diagnostic Lab Report record.

Security
bearer
Path
siteIdnumberrequired

Site identifier

standardDiagnosticLabReportIdstringrequired

Standard Diagnostic Lab Report unique identifier (UUID)

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

Responses

Standard Diagnostic Lab Report deleted successfully

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations