CLclinicos
Labs

Get labs for a specific appointment

Changed on
get/Labs/appointment/{appointmentId}

Request

Path parameters

appointmentIdstring required

The appointment ID

Response

List of lab orders for the appointment

idstring
patientIdstring
orderedByIdstring nullable
appointmentIdstring nullable
titlestring
testTypestring
statusstring
resultStatusstring
sourcestring
externalIdstring nullable
performingLabNamestring nullable

The laboratory behind the Greywind hub that actually ran this, and its id (ITE-552). Null when the order did not come through Greywind, or when the partner directory had not been mirrored when the result landed — the sync backfills the name in that case.

externalPartnerIdstring nullable
submissionUnconfirmedAtstring date-time nullable

Set when the submission's outcome was never confirmed with the laboratory (ITE-494) — the order may or may not be live there, and it must never be resubmitted on a guess.

submissionIssuestring nullable
sampleArrivedAtstring date-time nullable

When the laboratory confirmed the sample arrived (ITE-494). Null if they have not.

accessionNumberstring nullable
collectedAtstring date-time nullable
resultsReceivedAtstring date-time nullable
reviewedByIdstring nullable
reviewedAtstring date-time nullable
summarystring nullable
reportUrlstring nullable
reportFileIdstring nullable

PatientFile id of the stored report PDF, presigned on demand via GET labs/{id}/report-url (Business API). Wins over string? LabOrderDto.ReportUrl when both are set — older orders still carry an expired presigned URL there.

prioritystring
labPanelIdstring nullable
submissionGroupIdstring nullable

Groups sibling orders created by one external submission (ITE-493). Null for manual orders.

externalClinicIdstring nullable

The lab clinic ID the order was submitted under, which identifies the laboratory. Add-on tests must come from that lab's catalog. Null for manual orders and older Greywind orders.

manifestFileIdstring nullable

PatientFile id of the stored requisition manifest, when the order went to an external lab.

requiresPartnerActionboolean

True while the order still needs partner-hosted pages completed before it is really placed.

createdAtstring date-time
updatedAtstring date-time

Changes

  • f7ab358172d0Revision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

  • d58b40cfca93Revision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)