from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.update_on_site_collection_order_draw_completed("<order_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.updateOnSiteCollectionOrderDrawCompleted({ orderId: "<order_id>" });
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().updateOnSiteCollectionOrderDrawCompleted("<order_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.LabTests.UpdateOnSiteCollectionOrderDrawCompleted(context.TODO(), &junction.UpdateOnSiteCollectionOrderDrawCompletedLabTestsRequest{
OrderId: "<order_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"order": {
"id": "ea7eae96-2c25-404f-b043-bfc08584610d",
"team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a",
"user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f",
"patient_details": {
"dob": "2020-01-01",
"gender": "male"
},
"patient_address": {
"receiver_name": "John Doe",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"city": "San Francisco",
"state": "CA",
"zip": "91189",
"country": "United States",
"phone_number": "+1123456789"
},
"priority": false,
"health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f",
"details": {
"type": "testkit",
"data": {
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"shipment": {
"id": "d55210cc-3d9f-4115-8262-5013f700c7be",
"outbound_tracking_number": "<outbound_tracking_number>",
"outbound_tracking_url": "<outbound_tracking_url>",
"inbound_tracking_number": "<inbound_tracking_number>",
"inbound_tracking_url": "<inbound_tracking_url>",
"outbound_courier": "usps",
"inbound_courier": "usps",
"notes": "<notes>",
"created_at": "2020-01-01T00:00:00.000Z",
"updated_at": "2020-01-01T00:00:00.000Z"
},
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
},
"lab_test": {
"name": "Lipids Panel",
"description": "Cholesterol test",
"method": "testkit"
},
"sample_id": "123456789",
"notes": "This is a note",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"status": "collecting_sample",
"events": [
{
"id": 1,
"created_at": "2022-01-01T00:00:00Z",
"status": "received.on_site_collection.ordered"
},
{
"id": 2,
"created_at": "2022-01-02T00:00:00Z",
"status": "received.on_site_collection.requisition_created"
},
{
"id": 3,
"created_at": "2022-01-03T00:00:00Z",
"status": "collecting_sample.on_site_collection.draw_completed"
}
]
},
"status": "string",
"message": "string"
}
Orders
Update Order Draw Completed
Partially update order draw completed via the Junction API. Requires authentication with your team API key.
PATCH
/
v3
/
order
/
{order_id}
/
draw_completed
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.update_on_site_collection_order_draw_completed("<order_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.updateOnSiteCollectionOrderDrawCompleted({ orderId: "<order_id>" });
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().updateOnSiteCollectionOrderDrawCompleted("<order_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.LabTests.UpdateOnSiteCollectionOrderDrawCompleted(context.TODO(), &junction.UpdateOnSiteCollectionOrderDrawCompletedLabTestsRequest{
OrderId: "<order_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"order": {
"id": "ea7eae96-2c25-404f-b043-bfc08584610d",
"team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a",
"user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f",
"patient_details": {
"dob": "2020-01-01",
"gender": "male"
},
"patient_address": {
"receiver_name": "John Doe",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"city": "San Francisco",
"state": "CA",
"zip": "91189",
"country": "United States",
"phone_number": "+1123456789"
},
"priority": false,
"health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f",
"details": {
"type": "testkit",
"data": {
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"shipment": {
"id": "d55210cc-3d9f-4115-8262-5013f700c7be",
"outbound_tracking_number": "<outbound_tracking_number>",
"outbound_tracking_url": "<outbound_tracking_url>",
"inbound_tracking_number": "<inbound_tracking_number>",
"inbound_tracking_url": "<inbound_tracking_url>",
"outbound_courier": "usps",
"inbound_courier": "usps",
"notes": "<notes>",
"created_at": "2020-01-01T00:00:00.000Z",
"updated_at": "2020-01-01T00:00:00.000Z"
},
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
},
"lab_test": {
"name": "Lipids Panel",
"description": "Cholesterol test",
"method": "testkit"
},
"sample_id": "123456789",
"notes": "This is a note",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"status": "collecting_sample",
"events": [
{
"id": 1,
"created_at": "2022-01-01T00:00:00Z",
"status": "received.on_site_collection.ordered"
},
{
"id": 2,
"created_at": "2022-01-02T00:00:00Z",
"status": "received.on_site_collection.requisition_created"
},
{
"id": 3,
"created_at": "2022-01-03T00:00:00Z",
"status": "collecting_sample.on_site_collection.draw_completed"
}
]
},
"status": "string",
"message": "string"
}
This feature is in closed beta.Interested in this feature? Get in touch with your Customer Success Manager.
from junction import Junction
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.update_on_site_collection_order_draw_completed("<order_id>")
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.updateOnSiteCollectionOrderDrawCompleted({ orderId: "<order_id>" });
import com.junction.api.Junction;
import com.junction.api.core.Environment;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().updateOnSiteCollectionOrderDrawCompleted("<order_id>");
import (
"context"
junction "github.com/junction-api/junction-go"
"github.com/junction-api/junction-go/client"
"github.com/junction-api/junction-go/option"
)
c := client.NewClient(
option.WithApiKey("YOUR_API_KEY"),
option.WithBaseURL(junction.Environments.Sandbox),
)
response, err := c.LabTests.UpdateOnSiteCollectionOrderDrawCompleted(context.TODO(), &junction.UpdateOnSiteCollectionOrderDrawCompletedLabTestsRequest{
OrderId: "<order_id>",
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"order": {
"id": "ea7eae96-2c25-404f-b043-bfc08584610d",
"team_id": "c26a9cc7-cdff-4f23-a5f6-74d40088c16a",
"user_id": "63661a2b-2bb3-4125-bb1a-b590f64f057f",
"patient_details": {
"dob": "2020-01-01",
"gender": "male"
},
"patient_address": {
"receiver_name": "John Doe",
"first_line": "123 Main St.",
"second_line": "Apt. 208",
"city": "San Francisco",
"state": "CA",
"zip": "91189",
"country": "United States",
"phone_number": "+1123456789"
},
"priority": false,
"health_insurance_id": "33ec11aa-d8bf-4f46-950d-c9171be3c22f",
"details": {
"type": "testkit",
"data": {
"id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
"shipment": {
"id": "d55210cc-3d9f-4115-8262-5013f700c7be",
"outbound_tracking_number": "<outbound_tracking_number>",
"outbound_tracking_url": "<outbound_tracking_url>",
"inbound_tracking_number": "<inbound_tracking_number>",
"inbound_tracking_url": "<inbound_tracking_url>",
"outbound_courier": "usps",
"inbound_courier": "usps",
"notes": "<notes>",
"created_at": "2020-01-01T00:00:00.000Z",
"updated_at": "2020-01-01T00:00:00.000Z"
},
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z"
}
},
"lab_test": {
"name": "Lipids Panel",
"description": "Cholesterol test",
"method": "testkit"
},
"sample_id": "123456789",
"notes": "This is a note",
"created_at": "2020-01-01T00:00:00Z",
"updated_at": "2020-01-01T00:00:00Z",
"status": "collecting_sample",
"events": [
{
"id": 1,
"created_at": "2022-01-01T00:00:00Z",
"status": "received.on_site_collection.ordered"
},
{
"id": 2,
"created_at": "2022-01-02T00:00:00Z",
"status": "received.on_site_collection.requisition_created"
},
{
"id": 3,
"created_at": "2022-01-03T00:00:00Z",
"status": "collecting_sample.on_site_collection.draw_completed"
}
]
},
"status": "string",
"message": "string"
}
Authorizations
Vital Team API Key
Path Parameters
Your Order ID.
Response
Successful Response
Show child attributes
Show child attributes
Example:
{ "activate_by": "2020-01-01", "created_at": "2020-01-01T00:00:00Z", "details": { "data": { "created_at": "2020-01-01T00:00:00Z", "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", "shipment": { "created_at": "2020-01-01T00:00:00.000Z", "id": "d55210cc-3d9f-4115-8262-5013f700c7be", "inbound_courier": "usps", "inbound_tracking_number": "<inbound_tracking_number>", "inbound_tracking_url": "<inbound_tracking_url>", "notes": "<notes>", "outbound_courier": "usps", "outbound_tracking_number": "<outbound_tracking_number>", "outbound_tracking_url": "<outbound_tracking_url>", "updated_at": "2020-01-01T00:00:00.000Z" }, "updated_at": "2020-01-01T00:00:00Z" }, "type": "testkit" }, "events": [ { "created_at": "2022-01-01T00:00:00Z", "id": 1, "status": "received.testkit.ordered" }, { "created_at": "2022-01-02T00:00:00Z", "id": 2, "status": "received.testkit.requisition_created" }, { "created_at": "2022-01-03T00:00:00Z", "id": 3, "status": "collecting_sample.testkit.transit_customer" } ], "has_abn": false, "health_insurace_id": "d9495ed5-224b-40e4-806d-d7bf4f97b1e1", "id": "d451d5eb-7d03-41fc-8bd6-c3b6b96e3d04", "lab_test": { "description": "Cholesterol test", "method": "testkit", "name": "Lipids Panel" }, "last_event": { "created_at": "2022-01-03T00:00:00Z", "id": 3, "status": "collecting_sample.testkit.transit_customer" }, "notes": "This is a note", "order_transaction": { "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7", "orders": [ { "created_at": "2020-01-01T00:00:00Z", "id": "d55210cc-3d9f-4115-8262-5013f700c7be", "low_level_status": "transit_customer", "low_level_status_created_at": "2020-01-05T00:00:00Z", "origin": "initial", "updated_at": "2020-01-05T00:00:00Z" }, { "created_at": "2020-01-05T01:00:00Z", "id": "e66321dd-4e0g-5226-9373-6124g811d8cf", "low_level_status": "requisition_created", "low_level_status_created_at": "2020-01-05T01:00:00Z", "origin": "redraw", "updated_at": "2020-01-05T01:00:00Z" } ], "status": "active" }, "origin": "initial", "patient_address": { "city": "San Francisco", "country": "United States", "first_line": "123 Main St.", "phone_number": "+11234567890", "receiver_name": "John Doe", "second_line": "Apt. 208", "state": "CA", "zip": "91189" }, "patient_details": { "dob": "2020-01-01", "gender": "male" }, "requisition_form_url": "https://www.example.com", "sample_id": "123456789", "status": "collecting_sample", "team_id": "f4f37605-50a8-4d62-8274-86ab0689d686", "updated_at": "2020-01-01T00:00:00Z", "user_id": "819313d6-45ec-4fa3-91ee-0da04cb9812b" }
Was this page helpful?
⌘I