Setting how Results are Presented in the Reportable Result Set
The uncertainty of each result is reportable as a 40-character string in the report request sample scheme analyte's uncertainty value, along with report request sample scheme analyte's formatted final value when a sample scheme analyte result is rounded for a certificate report (as part of the Roundingvalue method).
Refer to Appendix—Rounding and Formatting of Results and Calculating Uncertainty.
Result Rounding and Formatting
When certificate reports are generated, each sample scheme analyte's Numeric Final Value, Boolean Value, Date Time Value or Text Value, depending upon the result's data type, is used to generate the Formatted Final Value.
When a formatted final value is determined for an analyte that has a numeric final value, the related uncertainty is determined.
The determination of a formatted final value involves report units, rounding tables, and the result formatting details on the sample scheme analyte and scheme version analyte.
The following parameters are required for rounding to be implemented.
|
The result of the sample scheme analyte, either:
|
For a numeric result, the internal units of measure relate to the analytically measured value. |
|
The reportable unit, as defined on the report request sample scheme analyte:
|
The units in which the analytically measured value must be reported, and may differ to the internal units of measure, in which case, a unit conversion of the result must take place. |
|
The type of rounding applied, as defined on the scheme version analyte:
|
This is the rounding method applied to the results of the analyte (for example, no rounding, by rounding table, or by script). Note that the rounding method cannot be changed within the job, sample or report request. |
|
The report display mask to use, as defined on the scheme version analyte:
|
The mask used to generate the final formatted value for the analyte. Note that report masks cannot be changed within a job or report request. |
|
The reportable detection limits, as defined on the report request sample scheme analyte:
|
If a rounded numerical result is between the report lower and upper detection limits, then a string containing the rounded numerical result is displayed on the report. Otherwise a string containing the report lower detection limit or report upper detection limit is displayed in the report to indicate that the reported result has exceeded the reportable detection limits. |
|
The rounding table, as defined on the report request sample scheme analyte:
|
The rounding table used to apply rounding to the results of the analyte. |
An analyte can be configured to have a report unit, report detection limits and a rounding method type to set the default rounding method.
Refer to Maintaining Scheme Version Analytes to configure result formatting for an analyte.
The rounding method types can be:
- None- No rounding is used to generate a formatted final value for the analyte.
- Table- A rounding table is used to generate a formatted final value for the analyte, in which case, a rounding table must be assigned to the analyte.
- Mask- A display mask is used to generate a formatted final value for the analyte, in which case, a report display mask must be assigned to the analyte. Note that a report display mask cannot be used for analytes with a data type of boolean, image or document.
- Script- A script is used to generate a formatted final value for the analyte, in which case, a script must be assigned to the analyte, and a rounding table and display mask can be assigned to the analyte for use within the script.
Rounding by Table
When rounding by table, rounding tables have to be configured. Note that rounding of results by rounding table is configurable to apply particular logic.
ISO rounding is a method of rounding a number denoted by the International Standards Organisation (ISO). ISO rounding can be assigned to a rounding table so that any rounding of numbers using the table has the ISO rules applied.
Refer to the Configure ISO Rounding for a Rounding Table.
When a result is rounded, the rounding table can be configured such that is either the result is rounded before it is compared with report detection limits, or the result is compared with report detection limits before it is rounded.
Refer to the Configure Result Rounding to occur before the Result is Compared with DL for a Rounding Table.
Depending on which comparison method is used, if the pre-rounded or post-rounded result is outside of the report detection limits on the rounding table, then the lower or upper detection limit is displayed instead of the result.
Refer to the Configure the Lower and Upper Limit Strings for a Rounding Table.
The rounding table can have a report unit assigned to indicate whether it is applicable for a given analyte.
Refer to the Configure the Report Unit for a Rounding Table.
For the system to report a result in a unit that is different to the measurement unit, it is necessary to have both units configured in the system.
Refer to the Maintain Unit Conversions.
A rounding table applies rounding based upon a result's lower detection limit and a given ceiling. Therefore a rounding table is configured with intervals, such that, the system steps through each interval in the table to determine the applicable convert-to unit (if any, otherwise the result remains in the report units), report display mask and increment for rounding.
Refer to the Maintain Result Detection Limit and Ceiling Items for a Rounding Table.
Result formatting details for a master scheme version analyte includes defining the report unit code, report lower and upper detection limits, rounding method type, and then extra parameters depending upon the rounding method type. When the rounding method type is a) by table, then the rounding table code is required, b) by mask, then the report display mask is required, or c) by script, then the rounding script code is required, as is the rounding table code and report display mask in case the script wants to use them in its logic.
Changing the Default Rounding
The rounding method type is driven by the analyte. However, when a sample group is registered, a sample scheme analyte's report unit, report detection limits and rounding table default to those of the analyte. These details are updatable on the sample scheme analyte.
- Refer to Maintaining Scheme Version Analytes to configure result formatting for an analyte.
- Population of the CCSampleSchemeAnalyte DTO
- When Maintaining Sample Tests, specify the Rounding Table Code.
When a report request sample scheme analyte is created, the report unit, report detection limits and rounding table default to those on the sample scheme analyte.
The current report request interface does display report request sample schemes or report request sample scheme analytes. However, after sample schemes and sample scheme analytes are added to a report request, when a report request scheme or report request analyte is updated, the report unit, report detection limits and rounding table are pushed down to each related report request sample scheme and report request sample scheme analyte.
Configuring the Uncertainty Calculation
Uncertainty is the anticipated factor of uncertainty in a result, either due to random or systematic errors in measurement.
A sample scheme analyte's uncertainty is determined so that it can be displayed in tandem with the formatted final values in a report.
Uncertainty is determined either:
- By the use of a range table lookup
- As a fixed percentage value, as a fixed string
- By the user of a script that can utilise any of the previous options.
When uncertainty is calculated for a sample scheme analyte, the calculation uses details from the master scheme version analyte.
Refer to Maintaining Scheme Version Analytes to configure uncertainty details for an analyte.
Also refer to the Effect of Scheme Scope upon Calculating Uncertainty in Workbook and Effect of Scheme Scope upon Calculating Uncertainty in Certificate Reports.
- Maintaining Schemes
- Maintaining Versions of a Scheme
- Maintaining Scheme Version Analytes
- Maintaining Job Tests
- Maintaining Sample Tests
- Rounding and Formatting Results
- Maintaining Range Tables
- Maintaining System Table Codes
- Maintaining Report Requests
- Maintaining Jobs for a Report Request
- Maintaining Samples for a Report Request
- Maintaining Tests for a Report Request
- Reportability of Jobs, Samples and Tests
- Sequencing Jobs, Samples and Tests in the Reportable Result Set
- Generating Reports from Report Requests
- Appendix—Rounding and Formatting of Results and Calculating Uncertainty
