Lab Result

A lab result contains the results for a lab order.

The lab result model

Properties

Name
id
Type
string
Description
Unique identifier for the lab result.
Name
object
Type
string
Description
Always 'lab_result'.
Name
patient
Type
string
Description
Patient this lab result is for.
Name
order
Type
string
Description
Lab order this result is associated with.
Name
dosage
Type
string
Description
Code of the lab result.
Name
sig
Type
string
Description
Name of the lab result.
Name
test_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the lab test was conducted.
Name
results_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the lab results were generated.
Name
vendor
Type
string
Description
Vendor who conducted the lab tests.
Name
ordered_by
Type
string
Description
Provider who ordered the lab tests.
Name
observations
Type
array of string
Description
List of lab result observations.
Name
signers
Type
array of objects
Description
Signing history of the lab result.
Name
created_by
Type
string
Description
Creator of the medication.
Name
created_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the medication was created.

Response

{
    "id": "lres_2UxtAULYUrX7GVsTKePy",
    "object": "lab_result",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "order": "X984OHJ",
    "code": "9090",
    "name": "CBC",
    "test_at": 1653798303000,
    "results_at": 1653798303000,
    "vendor": "Quest",
    "ordered_by": "user_xeDpGyt67wTor93qKtS7",

    "observations": ["lobs_GD9pGyt67wTor93qKtS7"],

    "signers": [
        {
            "status": "signedByProvider",
            "signed_by": "user_xeDpGyt67wTor93qKtS7",
            "signed_at": 1653798303000
        }
    ],

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

GET/v2/lab_results/:id

Retrieve a lab result

Retrieves the specified lab result.

Response

{
   "id": "lres_2UxtAULYUrX7GVsTKePy",
   "object": "lab_result",
   "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

   "order": "X984OHJ",
   "code": "9090",
   "name": "CBC",
   "test_at": 1653798303000,
   "results_at": 1653798303000,
   "vendor": "Quest",
   "ordered_by": "user_xeDpGyt67wTor93qKtS7",

   "observations": ["lobs_GD9pGyt67wTor93qKtS7"],

   "signers": [
       {
           "status": "signedByProvider",
           "signed_by": "user_xeDpGyt67wTor93qKtS7",
           "signed_at": 1653798303000
       }
   ],

   "created_by": "user_xeDpGyt67wTor93qKtS7",
   "created_at": 1653798303000,
   "last_updated_at": 1653798303000
}

POST/v2/lab_results/:id

Update a lab result

Updates the specified lab results object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Name
signed_by
Type
string
Description
Who the lab result is signed by.

Optional attributes

Response


{
    "id": "lres_2UxtAULYUrX7GVsTKePy",
    "object": "lab_result",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "order": "X984OHJ",
    "code": "9090",
    "name": "CBC",
    "test_at": 1653798303000,
    "results_at": 1653798303000,
    "vendor": "Quest",
    "ordered_by": "user_xeDpGyt67wTor93qKtS7",

    "observations": ["lobs_GD9pGyt67wTor93qKtS7"],

    "signers": [
        {
            "status": "signedByProvider",
            "signed_by": "user_xeDpGyt67wTor93qKtS7",
            "signed_at": 1653798303000
        },
        {
            "status": "signedByProvider",
            "signed_by": "user_OpeDpGyt67wTor93qKJ8",
            "signed_at": 1653798303000
        }
    ],

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}

GET/v2/lab_results

List all lab results

Returns a list of all lab results.

Response

{
  "object": "list",
  "data": [
    {
        "id": "lres_2UxtAULYUrX7GVsTKePy",
        "object": "lab_result",
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

        "order": "X984OHJ",
        "code": "9090",
        "name": "CBC",
        "test_at": 1653798303000,
        "results_at": 1653798303000,
        "vendor": "Quest",
        "ordered_by": "user_xeDpGyt67wTor93qKtS7",

        "observations": ["lobs_GD9pGyt67wTor93qKtS7"],

        "signers": [
            {
                "status": "signedByProvider",
                "signed_by": "user_xeDpGyt67wTor93qKtS7",
                "signed_at": 1653798303000
            }
        ],

        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": 1653798303000,
        "last_updated_at": 1653798303000
    },
  ]
}