Skip to main content

WCIA Lab Result Schema

Version 2.2.0 (Current)​

Lab Result Schema​

Legend​

Ln #  Schema
----  --------------------------------------
1.    {                                      
2.      "document_name": "string",           
3.      "document_schema_version": "string", 
4.      "document_origin": "string", 
5.      "lab_name": "string", 
6.      "lab_ubi_license": "string", 
7.      "lab_ccrs_license": "string", 
8.      "labresult_id": "string",            
9.      "sample": {                          
10.       "id": "string",  
11.       "sample_source_id": "string"  
12.     },                                   
13.     "coa": "string",
14.     "release_date": "2022-10-01",
15.     "amended_date": "2022-10-04",
16.     "expire_date": "2023-10-04",
17.     "status": "string",                  
18.     "is_medical": "bool",                  
19.     "metric_list": [                     
20.       {                                  
21.         "test_id": "string",             
22.         "test_type": "string",           
23.         "status": "nullable bool",       
24.         "metrics": [                     
25.           {                              
26.             "id": "string",              
27.             "name": "string",            
28.             "analyte_type": "string",    
29.             "qom": "string",             
30.             "uom": "string",             
31.             "status": "nullable bool"    
32.           }                              
33.         ]                                
34.       }                                  
35.     ],                                   
36.     "meta": {}                           
37.   }

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

Document Origin​

  • Field Name: document_origin
  • Type: string
  • Description:
    • A URL referencing the document's originating source.
  • Legend: Ln 4

Lab Name​

  • Field Name: lab_name
  • Type: string
  • Description:
    • The name of the laboratory submitting the result.
  • Legend: Ln 5

Lab UBI License​

  • Field Name: lab_ubi_license
  • Type: string
  • Description:
    • The UBI number of the laboratory submitting the result.
  • Legend: Ln 6

Lab CCRS License​

  • Field Name: lab_ccrs_license
  • Type: string
  • Description:
    • The WA State Traceability System: CCRS License number of the laboratory submitting the result.
  • Legend: Ln 7

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 8

Sample​

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

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 10

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 11

CoA​

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

Release Date​

  • Field Name: release_date
  • Type: string
  • Description:
    • An ISO8601 Date (e.g. 2022-09-05) representing the date a Lab released the results.
  • Legend: Ln 14

Amended Date​

  • Field Name: amended_date
  • Type: string|null
  • Description:
    • An ISO8601 Date (e.g. 2022-09-05) representing the date a Lab released Amended results.
  • Legend: Ln 15

Expire Date​

  • Field Name: expire_date
  • Type: string|null
  • Description:
    • An ISO8601 Date (e.g. 2022-09-05) representing the date a Lab CoA results expire.
  • Legend: Ln 16

Status​

  • Field Name: status
  • Type: string
  • Description:
  • Legend: Ln 17

Is Medical​

  • Field Name: is_medical
  • Type: bool
  • Description:
    • A boolean value of Zero for false and One for true, indicating whether the result is for medical use.
  • Legend: Ln 18

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 19

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 21

Metric -> Test Type​

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

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 23

Metric -> Metrics​

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

Metric -> Metrics -> id​

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

Metric -> Metrics -> Name​

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

Metric -> Metrics -> Analyte Type​

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

Metric -> Metrics -> QoM​

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

Metric -> Metrics -> UoM​

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

Metric -> Metrics -> Status​

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

Meta​

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

Resources​