API Reference - Requisitions
Get requisition
GET
/
api
/
v2
/
requisitions
/
{id}
Authorization
Path
curl --request GET \
--url https://app.spotdx.com/api/v2/requisitions/{id} \
--header 'Authorization: <authorization>'
{
"account_number": "1234567890",
"attributes": {
"crl_slip_id": "1234567890"
},
"barcode": "19742938328",
"created": "2020-01-01T00:00:00Z",
"events": [
{
"date": "2020-01-01T00:00:00Z",
"event": "created"
},
{
"date": "2020-01-01T00:00:00Z",
"event": "approved"
},
{
"date": "2020-01-02T00:00:00Z",
"event": "delivered"
},
{
"date": "2020-01-03T00:00:00Z",
"event": "received"
},
{
"date": "2020-01-04T00:00:00Z",
"event": "extra_quality_checks"
},
{
"date": "2020-01-05T00:00:00Z",
"event": "resulted"
}
],
"lab": "CRL",
"metadata": {
"some_key": "some_value"
},
"panels": [
"PANEL-123"
],
"patient": {
"address": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street1": "123 Main St",
"street2": "Apt 1",
"zip": "94105"
}
},
"date_of_birth": "string",
"email": "alice123@gmail.com",
"first_name": "Alice",
"last_name": "Smith",
"phone": "1234567890",
"sex": "F"
},
"reports": [
{
"date_collected": "string",
"date_received": "string",
"is_amendment": "boolean",
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"report_id": "string",
"results": [
{
"comments": null,
"name": "HDL Cholesterol",
"range_maximum": 200,
"range_minimum": 20,
"result": 123,
"result_type": "quantity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": "mg/dL"
},
{
"comments": null,
"name": "Vitamin B12",
"range_maximum": 200,
"range_minimum": 20,
"result": "<10",
"result_type": "quantity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": "pg/mL"
},
{
"comments": null,
"name": "Chlamydia",
"range_maximum": null,
"range_minimum": null,
"result": "negative",
"result_type": "reactivity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": null
},
{
"comments": null,
"name": "rs1234567",
"range_maximum": null,
"range_minimum": null,
"result": "TT",
"result_type": "genotype",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": null
}
],
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"
}
],
"requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
"state_collected": "OH",
"status": "resulted",
"tracking": {
"carrier": "usps",
"tracking_number": "9400123456789999876500"
},
"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
Authorizationheaderrequired
string
Token-based authentication with required prefix "Token"
Path Parameters
idrequired
string
The ID of the requisition to retrieve.
Response
200 - application/json
account_number
string
The account number submitted to the lab.
attributes
object | null
An optional set of values that can be passed through to specific labs.
barcode
string
The full barcode of the sample mailed to the lab. Must be globally unique.
created
string
events
object[]
lab
string
The name of the lab that will process the sample.
metadata
object | null
An optional dictionary of key-value pairs stored with the requisition.
panels
string[]
The panel codes of the test being performed on the sample. We'll create these with you during onboarding.
patient
object
reports
array
requisition_id
string
The ID of the requisition.
state_collected
string
The two letter code of the state where the sample was collected.
status
enum<string>
Available options:
created
, approved
, denied
, delivered
, received
, extra_quality_checks
, resulted
, rejected
, delivery_exception
tracking
object
updated
string
curl --request GET \
--url https://app.spotdx.com/api/v2/requisitions/{id} \
--header 'Authorization: <authorization>'
{
"account_number": "1234567890",
"attributes": {
"crl_slip_id": "1234567890"
},
"barcode": "19742938328",
"created": "2020-01-01T00:00:00Z",
"events": [
{
"date": "2020-01-01T00:00:00Z",
"event": "created"
},
{
"date": "2020-01-01T00:00:00Z",
"event": "approved"
},
{
"date": "2020-01-02T00:00:00Z",
"event": "delivered"
},
{
"date": "2020-01-03T00:00:00Z",
"event": "received"
},
{
"date": "2020-01-04T00:00:00Z",
"event": "extra_quality_checks"
},
{
"date": "2020-01-05T00:00:00Z",
"event": "resulted"
}
],
"lab": "CRL",
"metadata": {
"some_key": "some_value"
},
"panels": [
"PANEL-123"
],
"patient": {
"address": {
"address": {
"city": "San Francisco",
"country": "US",
"state": "CA",
"street1": "123 Main St",
"street2": "Apt 1",
"zip": "94105"
}
},
"date_of_birth": "string",
"email": "alice123@gmail.com",
"first_name": "Alice",
"last_name": "Smith",
"phone": "1234567890",
"sex": "F"
},
"reports": [
{
"date_collected": "string",
"date_received": "string",
"is_amendment": "boolean",
"pdf": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.pdf",
"report_id": "string",
"results": [
{
"comments": null,
"name": "HDL Cholesterol",
"range_maximum": 200,
"range_minimum": 20,
"result": 123,
"result_type": "quantity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": "mg/dL"
},
{
"comments": null,
"name": "Vitamin B12",
"range_maximum": 200,
"range_minimum": 20,
"result": "<10",
"result_type": "quantity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": "pg/mL"
},
{
"comments": null,
"name": "Chlamydia",
"range_maximum": null,
"range_minimum": null,
"result": "negative",
"result_type": "reactivity",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": null
},
{
"comments": null,
"name": "rs1234567",
"range_maximum": null,
"range_minimum": null,
"result": "TT",
"result_type": "genotype",
"time_collected": "2023-01-14T04:30:11.222Z",
"unit_of_measure": null
}
],
"txt": "https://app.spotkits.com/results/f0e5a607-5b52-4d7c-a3f2-c40772d41482.txt"
}
],
"requisition_id": "f0e5a607-5b52-4d7c-a3f2-c40772d41482",
"state_collected": "OH",
"status": "resulted",
"tracking": {
"carrier": "usps",
"tracking_number": "9400123456789999876500"
},
"updated": "2020-01-01T00:00:00Z"
}