Retrieve a requisition.

get/api/v2/requisitions/{id}

Request

  • Base URL: https://app.spotdx.com
  • URL: https://app.spotdx.com/api/v2/requisitions/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The ID of the requisition to retrieve.

Response

requisition_idstring

The ID of the requisition.

barcodestring

The full barcode of the sample mailed to the lab. Must be globally unique.

account_numberstring

The account number submitted to the lab.

labstring

The name of the lab that will process the sample.

panelsstring[]

The panel codes of the test being performed on the sample. We'll create these with you during onboarding.

state_collectedstring

The two letter code of the state where the sample was collected.

status'created' | 'approved' | 'denied' | 'delivered' | 'received' | 'extra_quality_checks' | 'resulted' | 'rejected' | 'delivery_exception'
metadataobject nullable

An optional dictionary of key-value pairs stored with the requisition.

createdstring date-time
updatedstring date-time

Example response

{
  "requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
  "barcode": "19742938328",
  "account_number": "1234567890",
  "lab": "CRL",
  "panels": [
    "PANEL-123"
  ],
  "state_collected": "OH",
  "patient": {
    "first_name": "Alice",
    "last_name": "Smith",
    "email": "alice123@gmail.com",
    "phone": "1234567890",
    "sex": "F",
    "address": {
      "address": {
        "street1": "123 Main St",
        "street2": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105"
      }
    }
  },
  "tracking": {
    "tracking_number": "9400123456789999876500",
    "carrier": "usps"
  },
  "status": "resulted",
  "events": [
    {
      "event": "created",
      "date": "2020-01-01T00:00:00Z"
    },
    {
      "event": "approved",
      "date": "2020-01-01T00:00:00Z"
    },
    {
      "event": "delivered",
      "date": "2020-01-02T00:00:00Z"
    },
    {
      "event": "received",
      "date": "2020-01-03T00:00:00Z"
    },
    {
      "event": "extra_quality_checks",
      "date": "2020-01-04T00:00:00Z"
    },
    {
      "event": "resulted",
      "date": "2020-01-05T00:00:00Z"
    }
  ],
  "reports": [
    {
      "results": [
        {
          "result_type": "quantity",
          "name": "HDL Cholesterol",
          "time_collected": "2023-01-14T04:30:11.222Z",
          "result": 123,
          "unit_of_measure": "mg/dL",
          "range_minimum": 20,
          "range_maximum": 200,
          "comments": null
        },
        {
          "result_type": "quantity",
          "name": "Vitamin B12",
          "time_collected": "2023-01-14T04:30:11.222Z",
          "result": "<10",
          "unit_of_measure": "pg/mL",
          "range_minimum": 20,
          "range_maximum": 200,
          "comments": null
        },
        {
          "result_type": "reactivity",
          "name": "Chlamydia",
          "time_collected": "2023-01-14T04:30:11.222Z",
          "result": "negative",
          "unit_of_measure": null,
          "range_minimum": null,
          "range_maximum": null,
          "comments": null
        },
        {
          "result_type": "genotype",
          "name": "rs1234567",
          "time_collected": "2023-01-14T04:30:11.222Z",
          "result": "TT",
          "unit_of_measure": null,
          "range_minimum": null,
          "range_maximum": null,
          "comments": null
        }
      ],
      "pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
      "txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"
    }
  ],
  "attributes": {
    "crl_slip_id": "1234567890",
    "crl_tier3_account_number": "12345678"
  },
  "metadata": {
    "some_key": "some_value"
  },
  "created": "2020-01-01T00:00:00Z",
  "updated": "2020-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.