Test Result APIs

You can manage infectious disease test results through the following APIs. (Note: do not use these APIs for PGx or other non-infectious disease test types.)

• Get a Test Result
• Get Test Results
• Create a Test Result

Get a Test Result

Use this API to get details about workflow test results for a sample.

HTTP Request

GET    /api/v3/workflow_sample_results/{Id}

Request Body

Response Body

{
    "workflowSampleResult": {
        "requisition": {
            "identifier": "a requisition identifier",
            "customAttributes": {
                 ...
                 },
            "testPanels": [
                "a test panel name",
                  ...
            ],
            "medications": [
                ...
                ],
            "diagnosis": [
                ...
                ],
            "sample": {
                "identifier": "some sample identifier",
                "collectionDate": "2023-10-01T00:00:00.000Z",
                ...
            },
            "providerAccount": {
                "name": "ABC Clinic",
                "number": "12345",
                ...
            },
            "patient": {
                "firstName": null,
                "lastName": null,
                ...              
            }
        },
        "testResults": [
            {
                "assayName": "an assay name",
                "targetName": "a target name"
                ...
                "infectiousDisease": {
                   "organism": "an organism name",
                   "ctValue": 20.0
                   ...
                   }
            }
        ]
    }
}

Response

Get Test Results

Use this API to get details about workflow results for a selected set of samples.

HTTP Request

GET  /v3/workflowSampleResults

Query Parameters

Response Body

This API returns an array of sample results, each of which follows the format documented above.

{
    "workflowSampleResult": [
        {
             "requisition": {
              ...
        },
        {
             "requisition": {
              ...
        }
       ...
}

Response

Create a Test Result

Use this API to upload test results for a compatible workflow type. A compatible workflow type must only contain the following activities:

1. batch-creation
2. qpcr-results
3. quality-checks

HTTP Request

POST /api/v3/test_panel_results/import

Request Body

{
  "organizationId": 1,
  "workflowType": "a_workflow_type",
  "sampleIdentifiers": [
    "sample_identifier_1"
  ],
  "fileContent": "the contents of the file matching the format configured in the workflow (CSV/TSV/etc)",
  "resourceLabel": "analysis"
}

"Well,Well Position,Sample Name,Target Name,Task,Reporter,Quencher,Crt,Crt Mean,Crt SD,Amp Score,Cq Conf,Amp Status,ROX Signal,Result
\nA01,A01,med1,blalMP,Something,123,123,10,21,123,111,444,Amp,123,Detected\n"<br>
		

Response