Get Results Metadata

Retrieve order result metadata via the Junction API. Requires authentication with your team API key.

GET /v3/order/{order_id}/result/metadata

cURL

curl --request GET \
     --url '{{BASE_URL}}/v3/order/<order_id>/result/metadata' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: YOUR_API_KEY'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.lab_tests.get_result_metadata("<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.getResultMetadata({ 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().getResultMetadata("<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.GetResultMetadata(context.TODO(), &junction.GetResultMetadataLabTestsRequest{
    OrderId: "<order_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

{
  "age": 19,
  "dob": "18/08/1993",
  "clia_number": "12331231",
  "patient": "Bob Smith",
  "provider": "Dr. Jack Smith",
  "laboratory": "Quest Diagnostics",
  "date_reported": "2020-01-01",
  "date_collected": "2022-02-02",
  "specimen_number": "123131",
  "date_received": "2022-01-01",
  "status": "final",
  "interpretation": "normal"
}

cURL

curl --request GET \
     --url '{{BASE_URL}}/v3/order/<order_id>/result/metadata' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: YOUR_API_KEY'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.lab_tests.get_result_metadata("<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.getResultMetadata({ 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().getResultMetadata("<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.GetResultMetadata(context.TODO(), &junction.GetResultMetadataLabTestsRequest{
    OrderId: "<order_id>",
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

{
  "age": 19,
  "dob": "18/08/1993",
  "clia_number": "12331231",
  "patient": "Bob Smith",
  "provider": "Dr. Jack Smith",
  "laboratory": "Quest Diagnostics",
  "date_reported": "2020-01-01",
  "date_collected": "2022-02-02",
  "specimen_number": "123131",
  "date_received": "2022-01-01",
  "status": "final",
  "interpretation": "normal"
}

Authorizations

x-vital-api-key · string · header · required

Vital Team API Key

Path Parameters

order_id · string<uuid> · required

Response

200

application/json

Successful Response

age · string · required

dob · string · required

patient · string · required

date_reported · string · required · deprecated

specimen_number · string · required

clia_# · string | null

provider · string | null

laboratory · string | null

date_collected · string | null · deprecated

date_received · string | null · deprecated

status · string · default: final

interpretation · string | null

patient_id · string | null

account_id · string | null