Get requisition

cURL

curl --request GET \
  --url https://app.spotdx.com/api/v2/requisitions/{id} \
  --header 'Authorization: <api-key>'

{
  "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": "[email protected]",
    "phone": "1234567890",
    "sex": "F",
    "date_of_birth": "2023-12-25",
    "address": {
      "address": {
        "street1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105",
        "street2": "Apt 1"
      }
    }
  },
  "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": [
    {
      "report_id": "<string>",
      "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",
      "date_collected": "2023-11-07T05:31:56Z",
      "date_received": "2023-11-07T05:31:56Z",
      "date_resulted": "2023-11-07T05:31:56Z",
      "is_amendment": false
    }
  ],
  "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"
}

GET

api

requisitions

{id}

cURL

curl --request GET \
  --url https://app.spotdx.com/api/v2/requisitions/{id} \
  --header 'Authorization: <api-key>'

{
  "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": "[email protected]",
    "phone": "1234567890",
    "sex": "F",
    "date_of_birth": "2023-12-25",
    "address": {
      "address": {
        "street1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "country": "US",
        "zip": "94105",
        "street2": "Apt 1"
      }
    }
  },
  "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": [
    {
      "report_id": "<string>",
      "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",
      "date_collected": "2023-11-07T05:31:56Z",
      "date_received": "2023-11-07T05:31:56Z",
      "date_resulted": "2023-11-07T05:31:56Z",
      "is_amendment": false
    }
  ],
  "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"
}

Access to requisitioning is disabled by default. To enable it, talk to us and we’ll get you set up

Authorizations

Authorization

string

header

required

Token-based authentication with required prefix "Token"

Path Parameters

string<uuid>

required

The ID of the requisition to retrieve.

Response

requisition_id

string

The ID of the requisition.

Example:

"f0e5a607-5b52-4d7c-a3f2-c40772d41482"

barcode

string

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

Example:

"19742938328"

account_number

string

The account number submitted to the lab.

Example:

"1234567890"

lab

string

The name of the lab that will process the sample.

Example:

"CRL"

panels

string[]

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

Example:

["PANEL-123"]

state_collected

string

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

Example:

"OH"

patient

object

Show child attributes

patient.first_name

string

The first name of the patient.

Example:

"Alice"

patient.last_name

string

The last name of the patient to be created.

Example:

"Smith"

patient.email

string<email>

The email of the patient to be created.

Example:

"[email protected]"

patient.phone

string

Optional phone number of the patient.

Example:

"1234567890"

patient.sex

enum<string>

The biological sex of the patient to be created.

Available options:

M,

F

Example:

"F"

patient.date_of_birth

string<date>

The date of birth of the patient to be created.

patient.address

object

Show child attributes

patient.address.address

object

Show child attributes

patient.address.address.street1

string

required

Recipient's address.

Example:

"123 Main St"

patient.address.address.city

string

required

Recipient's city of residence.

Example:

"San Francisco"

patient.address.address.state

string

required

Recipient's state of residence.

Example:

"CA"

patient.address.address.country

enum<string>

required

Recipient's country of residence.

Available options:

US,

CA

Example:

"US"

patient.address.address.zip

string

required

Recipient's zip code.

Example:

"94105"

patient.address.address.street2

string | null

Second line of recipient's address.

Example:

"Apt 1"

tracking

object

Show child attributes

tracking.tracking_number

string | null

Example:

"9400123456789999876500"

tracking.carrier

enum<string> | null

Available options:

fedex,

ups,

usps

Example:

"usps"

status

enum<string>

Available options:

created,

approved,

denied,

delivered,

received,

extra_quality_checks,

resulted,

rejected,

delivery_exception

Example:

"resulted"

events

object[]

Show child attributes

events.event

enum<string>

Available options:

created,

approved,

denied,

delivered,

received,

extra_quality_checks,

resulted,

rejected,

delivery_exception

events.date

string<date-time>

Example:

"2020-01-01T00:00:00Z"

Example:

[
  {
    "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

(object | null)[]

Show child attributes

reports.report_id

string

reports.results

object[]

Option 1
Option 2
Option 3

Show child attributes

reports.results.result_type

enum<string>

Available options:

quantity

reports.results.name

string

The biomarker that was analyzed.

reports.results.time_collected

string<date-time>

reports.results.result

reports.results.unit_of_measure

string | null

reports.results.range_minimum

string

reports.results.range_maximum

number

Required range: x >= 0

reports.results.comments

string | null

Example:

[
  {
    "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
  }
]

reports.pdf

string<url> | null

A URL to the PDF report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf"

reports.txt

string<url> | null

A URL to the TXT report.

Example:

"https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"

reports.date_collected

string<date-time>

reports.date_received

string<date-time>

reports.date_resulted

string<date-time>

reports.is_amendment

boolean

Whether this report is an amendment to a previous report.

Example:

false

attributes

object

An optional set of values that can be passed through to specific labs.

Show child attributes

attributes.crl_slip_id

string | null

The slip ID to be passed through with the requisition if placing a requisition at CRL. Must be alphanumeric and maximum 10 characters.

Maximum string length: 10

Example:

"1234567890"

attributes.crl_tier3_account_number

string | null

The region ID to be passed through with the requisition if placing a requisition at CRL. Must be alphanumeric and exactly 8 characters.

Required string length: 8

Example:

"12345678"

Example:

{
  "crl_slip_id": "1234567890",
  "crl_tier3_account_number": "12345678"
}

metadata

object

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

Example:

{ "some_key": "some_value" }

created

string<date-time>

Example:

"2020-01-01T00:00:00Z"

updated

string<date-time>

Example:

"2020-01-01T00:00:00Z"

List requisitions Create patient

⌘I

Welcome

Basic Guides

Advanced Guides

Integrations

API Reference - Orders

API Reference - Kits

API Reference - Requisitions

API Reference - Registration

Get requisition

Authorizations

Path Parameters

Response