Skip to main content
GET
Fetch a patient lab

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patient_lab_id
integer
required

The ID of the patient lab to fetch

Response

200 - application/json

OK

clinic_id
integer
required

The ID of the clinic the patient lab belongs to.

clinic_patient_id
integer
required

The ID of the patient the patient lab belongs to.

code
string
required

The lab panel code (e.g., test code from the lab provider). Empty string if no code is available.

collected_at
string<date-time>
required

The date and time the lab was collected.

created
string<date-time>
required

The datetime this object was created.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

id
integer
required

The ID of the patient lab.

is_deleted
boolean
required

Whether this record is soft deleted or not.

is_pending
boolean
required

Whether the patient lab results are still pending.

modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

name
string
required

The display name of the patient lab.

results
ExternalLabResultSchema · object[]
required

The structured results of the patient lab test.

status
enum<string>
required

The status of the patient lab.

Available options:
PENDING,
COMPLETE,
ERROR,
IMPORTED
type
enum<string>
required

The type of patient lab. IN_CLINIC and EXTERNAL are ordered labs.

Available options:
IN_CLINIC,
EXTERNAL,
MANUAL,
IMPORTED
lab_provider_name
string | null

The name of the lab provider who provided this lab. Only available for integrated labs.

ordering_clinic_user_id
integer | null

The ID of the clinic user who ordered this lab, if available.

ordering_clinic_user_name
string | null

The display name of the clinic user who ordered this lab, if available.

reviewed_at
string<date-time> | null

The date and time the lab was completed.