order

Register Testkit

Changed on
post/v3/order/testkit/register

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v3/order/testkit/register
  • Auth
    API key in header x-vital-api-key

Request body

user_idstring uuid nullable

The user ID of the patient. If it differs from the user currently associated with the unregistered testkit order, the order is rebound to this user at registration time. The user must exist on the same team as the order. If omitted, the order's existing user is kept.

sample_idstring required

Response

Successful Response

statusstring required
messagestring required

Example response

{
  "order": {
    "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": "dcf589c2-b4c7-4733-9308-f22d2c076fca",
    "id": "613342c2-ada0-44ca-ba24-90d7643d80ee",
    "lab_test": {
      "description": "Cholesterol test",
      "method": "testkit",
      "name": "Lipids Panel",
      "updated_at": "2020-01-01T00:00:00Z"
    },
    "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": "d2d6d231-f767-470a-bac3-9acba41c38d0",
    "updated_at": "2020-01-01T00:00:00Z",
    "user_id": "30e37a5c-34a8-4bc4-b840-ecf4821f4c32"
  }
}

Changes

    • info

      response property order/lab_test/markers/anyOf[subschema #1]/items/price deprecated

    • info

      response property order/lab_test/price deprecated

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      response property order/lab_test/markers/anyOf[subschema #1]/items/common_tat_days deprecated

    • info

      response property order/lab_test/markers/anyOf[subschema #1]/items/worst_case_tat_days deprecated