Products
There are two product types:
health-check— a regular product consisting of a list of pre-determined health check types. See i-screen.com.au/tests for available health checks.personalised-test— practitioners can combine multiple personalised-test products to create a personalised test. Note that practitioner discount rates do not apply for personalised tests. See personalised tests for available types.
note
Records returned from product endpoints are tailored to each practitioner to account for their discount rate and any products available exclusively to them.
warning
An additional sample collection fee of $15 AUD will be added to the invoice when an order consists only of personalised-test products (i.e. no health-check products on the same invoice).
Get a single product
Retrieves a product available to the current practitioner.
GET /products/:productId
URL Parameters
| Parameter | Description |
|---|---|
productId | The product's record ID |
curl "https://partner-staging.i-screen.com.au/v1/products/59770901cca022000fd1c4f2" \
-H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"
Response (health-check)
{
"_id": "61a456cf3d876c001109e083",
"instructions": [
"Your test kit and all instructions are posted directly to you, and there is no need to visit a collection centre.",
"Mail your sample back to the lab using the prepaid envelope and packaging."
],
"testTypes": [
"Fructose Malabsorption (Hydrogen increase over baseline by 90 minutes, Peak methane level at any point)"
],
"title": "SIBO - Fructose only",
"description": "If the small intestine becomes overgrown with bacteria it can lead to malabsorption of key nutrients and symptoms of irritable bowel syndrome.",
"price": 130,
"type": "health-check",
"testKit": true,
"requestForm": false,
"testTypeSchema": [
{
"observationTypes": [
"Hydrogen increase over baseline by 90 minutes",
"Peak methane level at any point"
],
"title": "Fructose Malabsorption"
}
]
}
Response (personalised-test)
{
"_id": "59770901cca022000fd1c4c4",
"observationTypes": [
"Total Cholesterol",
"LDL",
"HDL",
"Triglycerides",
"Non-HDL Cholesterol"
],
"title": "Cholesterol",
"price": 30,
"type": "personalised-test"
}
Get multiple products
Retrieves all products available to the current practitioner by type.
GET /products
note
There is no pagination on this endpoint.
Query Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
type | Yes | - | Product type: health-check or personalised-test |
curl "https://partner-staging.i-screen.com.au/v1/products?type=health-check" \
-H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"
Response (health-check)
[
{
"_id": "6029147072b9ad00100f9226",
"instructions": [
"Download and print your pathology form from your i-screen dashboard.",
"Take your form to one of our affiliated collection centres to have your sample taken."
],
"testTypes": [
"DHT Hormone (DHT)",
"Nutritional Markers (Zinc, Ferritin, Vitamin D)",
"Thyroid Function (TSH, FT4, FT3)"
],
"title": "Hair Loss Check (male)",
"description": "Accelerated hair loss can be due a number of reasons including genetic, stress, nutrition and hormonal factors.",
"price": 225,
"type": "health-check",
"testKit": false,
"requestForm": true,
"testTypeSchema": [
{
"observationTypes": ["DHT"],
"title": "DHT Hormone"
},
{
"observationTypes": ["Zinc", "Ferritin", "Vitamin D"],
"title": "Nutritional Markers"
},
{
"observationTypes": ["TSH", "FT4", "FT3"],
"title": "Thyroid Function"
}
]
}
]
Response (personalised-test)
[
{
"_id": "59770901cca022000fd1c4c4",
"observationTypes": [
"Total Cholesterol",
"LDL",
"HDL",
"Triglycerides",
"Non-HDL Cholesterol"
],
"title": "Cholesterol",
"price": 30,
"type": "personalised-test"
},
{
"_id": "59770901cca022000fd1c4d3",
"observationTypes": ["Vitamin D"],
"title": "Vitamin D",
"price": 38,
"type": "personalised-test"
}
]