Tests

Get a single test

Retrieves a test based on its ID.

GET /tests/:testId

URL Parameters

Parameter	Description
testId	The test's record ID

warning

The request form is generated asynchronously and may not be available immediately after a test is created. See the Webhooks section for more information. Not all tests/products generate request forms.

curl "https://partner-staging.i-screen.com.au/v1/tests/622460e7e173b40012c4b51e" \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "_id": "5ed4c245b5d8ea00107ae19c",
  "product": "Adrenal Stress Check",
  "testNumber": "00015672",
  "status": "results-available",
  "updatedAt": "2022-04-25T03:41:25.427Z",
  "createdAt": "2020-06-01T08:54:29.707Z",
  "requestForm": "https://iscreen.s3.ap-southeast-2.amazonaws.com/requestForms/...",
  "collectedDate": "2022-04-20T00:00:00.000Z",
  "resultsDueDate": "2022-04-22T00:00:00.000Z",
  "trackingNumber": "SHIP1234123123",
  "patientId": "624a51c9ca695bf5c7e4b1fc",
  "invoiceNumber": "INV005931",
  "orderNumber": "ORD067918",
  "attachments": [
    "https://iscreen-dev.s3.eu-west-1.amazonaws.com/attachments/..."
  ],
  "result": {
    "segments": [
      {
        "label": "Thyroid Function",
        "observations": [
          {
            "label": "TSH",
            "description": "Communicates with the thyroid gland to produce T3 and T4 which regulate metabolic functions.",
            "units": "mIU/L",
            "range": { "min": 0.5, "max": 4 },
            "sign": "<",
            "value": "5",
            "comment": "<p>Random comment...</p>"
          },
          {
            "label": "FT4",
            "units": "pmol/l",
            "range": { "min": 10, "max": 20 }
          }
        ],
        "comment": "<p>Your thyroid hormones are within the normal range...</p>"
      }
    ],
    "recommendations": [
      {
        "title": "Optimise your lifestyle",
        "category": "heart",
        "comment": "<p>Taking steps to improve your diet...</p>"
      }
    ],
    "comment": "<p>Congratulations on taking the Adrenal Stress Check!</p>",
    "doctor": {
      "firstName": "i-screen",
      "lastName": "",
      "qualifications": "",
      "avatar": "https://d1rhkdlqb7psvs.cloudfront.net/assets/img/doctors/i-screen.png",
      "title": ""
    },
    "availableDate": "2022-04-25T03:41:25.427Z",
    "retest": {
      "value": 3,
      "period": "months"
    }
  }
}

note

invoiceNumber is only present if the test was purchased via invoicing. orderNumber is only present if purchased via direct order. result.doctor is only present when a reviewing doctor has been assigned to the result. collectedDate is only present once the sample has been collected; it is not the same as result.availableDate (when results were released) or resultsDueDate (the estimated turnaround date) — use collectedDate if you need to plot results against when the sample was actually taken.

---

Get multiple tests

Retrieves multiple tests under the current practitioner.

GET /tests

Query Parameters

Parameter	Required	Default	Description
skip	No	0	Number of records to skip
limit	No	10	Max records to retrieve (max: 100)
testNumber	No	-	Filter by test number
patientId	No	-	Filter by patient ID
status	No	-	Filter by status: pending, collected, awaiting-practitioner, cancelled, results-available, expired

curl "https://partner-staging.i-screen.com.au/v1/tests?testNumber=00039352" \
  -H "Authorization: Bearer f3ee05b1e3d140a3b17456fb69d28cd9-5f6a46513aa48d0bf80a04c7d52c9805633070a7803d3bd4"

Response

{
  "total": 2,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "62680e5a183a67d280bf29eb",
      "product": "Male Hormone Check",
      "testNumber": "00040591",
      "status": "results-available",
      "createdAt": "2022-04-26T15:23:06.894Z",
      "updatedAt": "2022-04-26T15:23:06.894Z",
      "requestForm": "https://iscreen-dev.s3.eu-west-1.amazonaws.com/...",
      "patientId": "624a51c9ca695bf5c7e4b1fc",
      "invoiceNumber": "INV005923",
      "collectedDate": "2022-04-25T08:00:00.000Z",
      "summary": {
        "desirable": 12,
        "abnormal": 3
      }
    },
    {
      "_id": "62177f9ea3b2d6001130768e",
      "product": "Semen Check",
      "testNumber": "00039352",
      "status": "pending",
      "createdAt": "2022-02-24T12:52:46.372Z",
      "updatedAt": "2022-02-24T12:52:50.382Z",
      "requestForm": "https://iscreen.s3.ap-southeast-2.amazonaws.com/...",
      "patientId": "604705f9d1705600187a36d7",
      "orderNumber": "ORD067918"
    }
  ]
}

note

summary (with desirable and abnormal counts) is only present when the test status is results-available.