Skip to main content

WCIA Lab Result Schema

Version 1.1.0​

Lab Result Schema​

Table of Contents​

  • Legend
  • Fields Guide
  • Resources

Legend​

Ln #  Schema
----  --------------------------------------
1.    {                                      
2.      "document_name": "string",           
3.      "document_schema_version": "string", 
4.      "labresult_id": "string",            
5.      "sample": {                          
6.        "id": "string",  
7.        "sample_source_id": "string"  
8.      },                                   
9.      "coa": "string",                     
10.      "status": "string",                  
11.     "metric_list": [                     
12.       {                                  
13.         "test_id": "string",             
14.         "test_type": "string",           
15.         "status": "nullable bool",       
16.         "metrics": [                     
17.           {                              
18.             "id": "string",              
19.             "name": "string",            
20.             "analyte_type": "string",    
21.             "qom": "string",             
22.             "uom": "string",             
23.             "status": "nullable bool"    
24.           }                              
25.         ]                                
26.       }                                  
27.     ],                                   
28.     "meta": {}                           
29.   }

Fields Guide

Document Name​

  • Field Name: document_name
  • Type: string
  • Description:
    • The "title" of the document, always displaying "WCIA Lab Result Schema".
  • Legend: Ln 2

Document Schema Version​

  • Field Name: document_schema_version
  • Type: string
  • Description:
    • The version of WCIA Lab Result Shema used for the object.
  • Legend: Ln 3

Lab Result ID​

  • Field Name: labresult_id
  • Type: string
  • Description:
    • The Laboratory-assigned identifier, this is the ID used internally by the lab.
  • Legend: Ln 4

Sample​

  • Field Name: sample
  • Type: object
  • Description:
    • An object containing properties associated with the sample transfer.
  • Legend: Ln 5

Sample -> ID​

  • Field Name:id
  • Type: string
  • Description:
    • A property of the Sample object, ID is the identifier representing the inventory lot from which the sample was taken.
  • Legend: **Ln 6

Sample -> Sample Source ID​

  • Field Name:sample_source_id
  • Type: string
  • Description:
    • A property of the Sample object, sample_source_id is an identifier representing the source lot from which the sample was taken.
  • Legend: **Ln 7

CoA​

  • Field Name: coa
  • Type: string
  • Description:
    • A URL linking to the result's Certificate of Analysis (CoA).
  • Legend: Ln 8

Status​

  • Field Name: status
  • Type: string
  • Description: ddd
  • Legend: Ln 9

Metric List​

  • Field Name: metric_list
  • Type: array
  • Description:
  • An array of metrics. Metrics in this context are assays, or lab tests, intended to produce one or more analytes.
  • Legend: Ln 11

Metric -> Test ID​

  • Field Name: test_id
  • Type: string
  • Description:
    • A unique identifier used by labs to distinguish a metric / assay / test type.
  • Legend: Ln 13

Metric -> Test Type​

  • Field Name: test_type
  • Type: string
  • Description:
    • A name describing the metric / assay / test type.
  • Legend: Ln 14

Metric -> Status​

  • Field Name: status
  • Type: string
  • Description:
    • A pass|fail field indicating the overall pass or failure of a metric / assay / test.
  • Legend: Ln 15

Metric -> Metrics​

  • Field Name: metrics
  • Type: array
  • Description:
    • A list of metrics, or analytes, produced by a metric / assay / test.
  • Legend: Ln 16

Metric -> Metrics -> id​

  • Field Name: id
  • Type: string
  • Description:
    • A unique identifier, assigned by the lab, to distinguish an analyte from others.
  • Legend: Ln 18

Metric -> Metrics -> Name​

  • Field Name: name
  • Type: string
  • Description:
    • A name describing an analyte under review.
  • Legend: Ln 19

Metric -> Metrics -> Analyte Type​

  • Field Name: analyte_type
  • Type: string
  • Description:
    • A categorical description of an analyte.
  • Legend: Ln 20

Metric -> Metrics -> QoM​

  • Field Name: qom
  • Type: string
  • Description:
    • Quantity of Measure; the quantity, or amount, measured.
  • Legend: Ln 21

Metric -> Metrics -> UoM​

  • Field Name: uom
  • Type: string
  • Description:
    • Unit of Measure; the standardized unit used to gauge any physical property.
  • Legend: Ln 22

Metric -> Metrics -> Status​

  • Field Name: status
  • Type: string
  • Description:
    • A PASS/FAIL indicating an individual analyte's pass or failure status.
  • Legend: Ln 23

Meta​

  • Field Name: meta
  • Type: object
  • Description:
    • An object intended to include meta data regarding the Lab result object.
  • Legend: Ln 28

Resources​