Maintaining Scheme Version Analytes

Overview

A scheme version analyte (SVA) is a component of an analytical preparation or analytical scheme, and is a property to be determined from the test. A scheme version analyte may be referred to as an Analyte.

Analytes are defined as preparation WEIGHT, preparation VOLUME, preparation other, or analytical with or without correction applied. An analytical result can be text, date, Boolean, file, numeric, calculated, or matrix.

Analytes may alter between scheme versions. An analyte must be created for each property or measurement within a scheme in order to be processed, reported and included as part of a job on an invoice.

Note: Analytes are not stand-alone records. They are always created as part of a scheme, and are specific to an individual version of a scheme. Any schemes subsequently created from a scheme inherit the analytes from the original.
Where the analytes from a Save As operation are not all required, it may be more efficient to create a new scheme rather than attempt to add or remove analytes (the ability to do so is also dependent upon the scope from which the original was created).

Process

Scheme version analytes are managed using the CCSCHMVERANA—Scheme Version Analyte application, which is accessed from within the Scheme Versions » Analytes tab in the CCSCHMVER—Scheme Version application.

Maintain scheme version analytes

Scheme version analytes are scoped by their parent scheme. Analytes cannot be shared across schemes or across scheme versions.

An analyte's Analyte Code and Analyte Type are mandatory.

If the CODEVALIDATION_CHARACTERLIST_01 application preference is defined and contains a list of visible ASCII characters, then an analyte code must only contain characters from this list. If this preference is not defined, then an analyte code must only contain characters from the ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789 string. The Scope for this preference is usually set at laboratory level.

Scheme version analytes are scoped by their parent scheme version.

For each scheme version analyte, an analyte code is the only mandatory field, however it is recommended that each analyte be added in its entirety to ensure accurate application in analysis.

Refer to the section below on Enabling Org-scope Schemes for Use in the Laboratory regarding which enabled-scope scheme version analyte DTO properties are editable.

A scheme version analyte's Analyte Code cannot be updated.

Scheme version analytes cannot be deleted where:

The scheme version analyte is linked to by another entity
The scheme has organisation scope but it is enabled for use by a laboratory. Refer to Making Org-scope and Lab-scope Schemes Ready for Registration.

Analyte Sequence within a Scheme Version

The sequence of analytes within a scheme version is the order in which are added to a sample when analytes are not individually added to the sample.

Analytical Type

A scheme version analytes Analyte Type denotes the intended use of the analyte.

The analyte type can be:

Preparation Weight—Records the analysis weight of a sample for a scheme, which is disseminated into related analytes in the scheme, in linked schemes and is used for raw-to-final result calculations.
Only one preparation weight analyte data type can be defined per scheme version.
Preparation weight analyte types are only visible in the weight/volume mode within workbook.
Preparation Volume—Records the analysis volume of a samples for a scheme, which is disseminated into to related sample scheme analytes in the scheme, in linked schemes and used for raw-to-final result calculations.
Only one preparation volume analyte type can be defined per scheme version.
Preparation volume analyte types are only visible in the weight/volume mode within workbook.
Preparation Other—Records parameter information/results for an analytical preparation or analytical-type scheme.
These types of analytes are typically not reported, and may not impact on QC and workflow status.
Preparation other analytes can be visible in both the weight/volume and raw and final modes within workbook. This is useful to allow results or values to be entered in the weight/volume modes, but also review (as display only) within the raw and final modes. Examples where preparation other analytes could be used is where beaker/crucible/test-tube identifiers need to be visible across these different modes.
Analytical—Records an analytical result for an analytical preparation or analytical-type scheme.
Analytical analyte types are only visible in the raw and final modes within workbook.

If the Scheme Type is Analytical Preparation or Analytical then preparation weight and preparation volume-type analytes are created automatically when the first scheme version is created. This is to ensure the efficient configuration of schemes for raw-to-final calculations. If these types of analytes are removed, they can be manually added again as required.

Data Type

A scheme version analyte's Data Type denotes the type result entered for the analyte.

An analyte data type can be:

Numeric Only—A numeric value is expected, and only Numeric Result values are allowed and stored.
Numeric—A numeric value is expected, however, depending on permissions, a string value can be entered. Either a Numeric Result or String Result is stored.
Text—A text string is expected, and a String Result is stored.
Boolean—0 or 1 is expected, and a Boolean Result is stored.
Date—a date string is expected (for example, 01/12/2014); a Date Result is stored.
Datetime—A date-time string is expected (for example, 01/12/2014 14:15:11), and a DateTime Result is stored.
Image—An image upload is expected. The Image Result points to the EFS file containing the image.
Document—A document upload is expected. The Document Result points to the EFS file containing the document.

Sub-Analytes

Sub-analytes are analytes with a parent analyte and are typically added to a sample when the parent analyte is added (this is a manual, and not automatic, process), and can be hidden or shown on a workbook next to the parent analyte

Where an analyte's Parent Analyte Code is set, then the analyte is a sub-analyte of that parent analyte.

When searching for scheme version analytes to when maintaining scheme limit specifications, maintaining standard specifications, maintaining product specifications to add multiple analytical limits for a specification, the analyte search criteria includes whether the analyte is a sub-analyte or not.

Sub-analytes do not appear in the scheme-analyte grid in the workbook open screen.

Price Type and Price Code

A scheme's Price Type is selected when the scheme is created. The type of pricing can be:

Scheme-Based
Sample-Based
Unit-Based
Analyte-Based.

For a scheme with a Price Type of Scheme-Based, Sample-Based or Unit-Based, the Price Code is at the scheme level and can only be selected from price codes that have the same Price Type, and if left empty, then the scheme cannot be invoiced.

For a scheme with a Price Type of Analyte-Based, the Price Code is at the analyte level and can only be selected from price codes that have the same Price Type, and if left empty, then the analyte cannot be invoiced.

When the Create Analyte Price Codes grid flow is selected on the Analytes tab of the CCSCHMVER—Scheme Version Detail screen::

Where a price code exists that has a Price Type of Analyte-Based and the same Scope and Code as the analyte, then the price code is linked to the analyte.
Where a price code exists that has a Price Type of Analyte-Based and the same Code as the analyte but not the same Scope, then the analyte is not linked to the price code due to the different scope.
Where a price code does not exist that has a Price Type of Analyte-Based and the same Scope and Code as the analyte, then a price code with a Price Type of Analyte-Based and the same Scope, Code, Name and Description as the analyte is automatically created with the price code's isSystemGenerated flag is set to true, and the price code is associated with the analyte.

Automatic Registration

When a scheme is located for adding to a sample, then any analyte that has Mandatory Profile selected, including sub-analytes, is added to the sample when the scheme is added using the Add Scheme with Mandatory Analytes or Add Entire Scheme flow.

Internal Units

A scheme version analyte's Unit Code is the internal assessment unit.

If a result undergoes assessment by a specification, that is:

then the specification is assessed against the limits associated with the scheme code, analyte code and the internal unit.

When a result is reported, the result is converted from the internal unit to the report unit as specified for the analyte in the report request.

Holding and Warning Times

Holding and warning times are used to determine sample scheme expiry.

The sample scheme analyte's Holding Time defaults to the scheme version analyte's Holding Time and is used to determine a sample scheme analyte's Expiry Date.

The scheme version analyte's Warning Time is used to determine the sample scheme analyte's Warning Date from the sample scheme analyte's Expiry Date and is used to determine a sample scheme analyte's Warning Date.

Inclusion in Paperwork and Labels

Scheme version analytes can be flagged to be included on a worksheet.

A report request sample scheme analyte's Reportable flag for paperwork and label report requests is inherited from the sample scheme analyte's Include on Worksheet, which, in turn, is inherited from the scheme version analyte's Reportable flag.

Applying Raw-to-Final Correction

A scheme version analyte can have a correction factor applied so that when a numeric raw result is received during a workbook session, then the numeric final result can be determined using the correction. Note that, if a numeric final value is entered for a sample scheme analyte, then the numeric raw value is determined by applying the reverse correction.

For this correction to occur, the scheme's Correction Applied must be selected, the scheme version analyte's Analyte Type must be Analytical, and the scheme version analyte's Apply Correction Factor flag must be selected.

A scheme that is flagged to have Correction Applied can be opened in a workbook using a Data Mode of Weight/Volume mode to allow results to be entered for a preparation weight or preparation volume-type analyte, which then allow for raw-to-final result calculations.

Workbook Settings

If the workbook is displayed in normal mode, the scheme version analyte's Data Column Header is used instead of the analyte code to identify the columns containing test results for this analyte, and the Default Data Entry Column Width sets the initial column width.

A scheme version analyte's Display Mask denotes how the data for a related sample scheme analyte is displayed in a workbook cell.

A Result Selection List of valid results can be defined for a scheme version analyte, Use First List Value As Default can be selected, as it can be specified whether a result must come Only From List.

Spreadsheet Formula

A scheme version analyte can have a Spreadsheet Formula that is inherited into sample scheme analytes which is then used to determine the sample scheme analyte's Numeric Final Result from the formula.

Refer to Appendix—Workbook Formulas and Function.

Averaging Readings

Where a scheme version analyte's Auto Average Reading flag is selected, during a workbook session in which a final numeric result reading is entered for a sample scheme analyte associated with the analyte, then the final numeric result of each active sample scheme analyte reading is averaged automatically to determine the final numeric result.

Cascade Engine Settings

A scheme version analyte's Workflow Active flag determines whether the analyte is considered when cascading sample scheme analyte Workflow Status to sample scheme and job scheme analyte.

A scheme version analyte can also be configured to Allow a Null Result so that a related sample scheme analyte that does not have a result is not considered, as long as there is another sibling sample scheme analyte that has a Workflow Status of Analysed, Released or Completed.

Some analytes do not always have to have a result, for example, a weight average where WT1, WT2, WT3, WT4 and WT_AVG analytes exist, but all four weights do not have to be captured if you are happy with the first three results. In this case, WT2, WT3 and WT4 would be configured to allow a null result to not hold up completion.

Given that the scheme version analyte allows a null result and a sample scheme analyte has a null result, when another sample scheme analyte in the same sample scheme, that does not have allow null result set, has its Workflow Status changed to something other than Not Started or Repeat, and Workflow Status Cascade, then the sample scheme analyte's Workflow Status is treated as though it is Completed. Note that if it did have a result then the actual Workflow Status of the sample scheme analyte is taken into account.

For example, if one of the sample scheme analytes is left with a null result but at least one sample scheme analyte in the same sample scheme has a Workflow Status of Complete, then the sample scheme can have its Workflow Status set to Completed.

Detection Limit Assessment

Internal Lower Detection Limit

A scheme version analyte can have an Internal Lower DL and have the Internal Lower DL Critical flag set, as required.

To configure lower analysis for the situation in which, when a result is entered for the sample scheme analyte and the result is below the sample scheme analyte's critical lower detection limit, then select a Lower Template Sample Code so that all schemes and analytes in the template sample can be manually registered by the user to cater for the lower analysis.

When a sample scheme analyte is created, the sample scheme analyte's Internal Lower DL value and Internal Lower DL Critical flag default from the scheme version analyte.

Internal Upper Detection Limit

A scheme version analyte can have an Internal Upper DL and have the Internal Upper DL Critical flag set, as required.

To configure upper analysis for the situation in which, when a result is entered for the sample scheme analyte and the result is above the sample scheme analyte's critical upper detection limit, then select a Upper Template Sample Code so that all schemes and analytes in the template sample can be manually registered by the user to cater for the upper analysis.

When a sample scheme analyte is created, the sample scheme analyte's Internal Upper DL value and Internal Upper DL Critical flag default from the scheme version analyte.

If a detection limit is exceeded and the detection limit is critical, then the sample scheme analyte's Workflow Status is set to Check.

QC Assessment

A scheme version analyte's QC Active flag denotes whether a related sample scheme analyte's Numeric Final Result is passed through QC assessment.

Given that the scheme version analyte is active for QC assessment, when a result is received for a related sample scheme analyte, then, depending on the sample's Primary Analytical Type and Secondary Analytical Type, the result undergoes various QC assessments:

The QC statuses set from these QC assessments are then rolled up to set the sample scheme analyte's Composite QC Status.

Composite QC Cascade

If a scheme version analyte is inactive for QC assessment, when a result is received for a related sample scheme analyte, then the result does not undergo any QC assessments and all of the QC statuses are set to Not Required, in which case, the sample scheme analyte's Composite QC Status is rolled up to Passed.

If a scheme version analyte is active for QC assessment, in workbook, when a result is assessed to set the sample scheme analyte's Composite QC Status to one of the failure statuses, the cell is highlighted to show that some action is required. This action may be to ignore the composite QC failure, or request a repeat of the sample scheme analyte using a newly prepared sample aliquot.

If a scheme version analyte's Saved to QC History flag is selected, when a result is received that sets the sample scheme analyte Precision Status or Standard Status to something other than not required, then the QC results are written to QC history.

It only makes sense to have QC results written to QC history if the analyte is configured to be assessed for QC.

Scheme or Surrogate Limit Assessment

Default scheme limit assessment configuration involves defining the scheme's Limit Specification Code, and configuring specification limits for the scheme version analyte unit within that specification, after which these limits are then applied to a numeric final value associated with the scheme version analyte unit, to set the sample scheme analyte's Scheme Limit Status for the numeric final value. Refer to Maintaining Schemes to configure a limit specification for an analytical preparation or analytical scheme.

However, it is possible to set surrogate limits on an analyte, which are then used instead, to set the sample scheme analyte's Scheme Limit Status for the numeric final value.

To configure non-critical surrogate limits, select Surrogate Result Critical as NOT CRITICAL, and specify the Surrogate Target Value, Surrogate Recovery Lower Limit and Surrogate Recovery Upper Limit, so that, when a sample scheme analyte receives a numeric final value, and surrogate limit assessment is performed, then the sample scheme analyte's Limit Status is set to Not Required, and Recovery is set to the sample scheme analyte's Numeric Final Value / specification analytical limits's Internal Target Value x 100, for the matching Scheme Code, Scheme Version, Analyte Code and Internal Unit Code.

To configure a critical surrogate upper limit, select Surrogate Result Critical as UPPER LIMIT CRITICAL, and specify the Surrogate Target Value, Surrogate Recovery Lower Limit and Surrogate Recovery Upper Limit, so that, when a sample scheme analyte receives a numeric final value, and surrogate limit assessment is performed, then the sample scheme analyte's Limit Status is set by assessing the SSA Numeric Final Value against the scheme version analyte's Surrogate Recovery Upper Limit, and Recovery is set to the sample scheme analyte's Numeric Final Value / specification analytical limit's Internal Target Value x 100, for the matching Scheme Code, Scheme Version, Analyte Code and Internal Unit Code.

To configure a critical surrogate lower limit, select Surrogate Result Critical as LOWER LIMIT CRITICAL, and specify the Surrogate Target Value, Surrogate Recovery Lower Limit and Surrogate Recovery Upper Limit, so that, when a sample scheme analyte receives a numeric final value, and surrogate limit assessment is performed, then the sample scheme analyte's Limit Status is set by assessing the SSA Numeric Final Value against the scheme version analyte's Surrogate Recovery Lower Limit, and Recovery is set to SSA's Numeric Final Value / specification analytical limit's Internal Target Value x 100, for the matching Scheme Code, Scheme Version, Analyte Code and Internal Unit Code.

To configure a critical surrogate upper and lower limit, select Surrogate Result Critical as UPPER AND LOWER LIMIT CRITICAL, and specify the Surrogate Target Value, Surrogate Recovery Lower Limit and Surrogate Recovery Upper Limit, so that, when a sample scheme analyte receives a numeric final value, and surrogate limit assessment is performed, then the sample scheme analyte's Limit Status is set by assessing the sample scheme analyte's Numeric Final Value against the scheme version analyte's Surrogate Recovery Upper Limit and Surrogate Recovery Lower Limit, and Recovery is set to the sample scheme analyte's Numeric Final Value / specification analytical limit's Internal Target Value x 100, for the matching Scheme Code, Scheme Version, Analyte Code and Internal Unit Code.

Precision Assessment

As a prerequisite, an analyte's QC Active must be selected for any QC assessment to occur. QC assessment includes precision assessment.

Default precision assessment configuration involves defining the expected boundary limits for an analyte. Warning and failure limits are calculated and then applied to a numeric final value associated with the analyte, to provide precision status information for the numeric final value.

The statistical detection limit is empirically, or statistically derived from all contributing factors to the detection limit (instrument, method, interferences), and actually represents the lower level at which a result can be expressed with some, or a designated, degree of confidence.

The limiting repeatability is effectively the limit of repeatability and indicates the best possible precision that can be expected under the current collection of circumstances (instrument, method, interference).

These two parameters, for the duplicate or replicate QC sample, are fed into the CCLAS default precision assessment algorithm, the outcome of which is warning and failure limits over a range of possible measurement values.

The limits are bound by curves which are asymptotic about the statistical detection limit and then the limiting repeatability.

To apply any other type of precision assessment algorithm, which would be required only where an unsupported approach was a mandatory, a custom script can be used, which is applied after the default precision assessment and can potentially override the precision status information for a numeric final value.

To configure default precision assessment, specify the Rep Statistical Detection Limit and Rep Limiting Repeatability, and the Dup Statistical Detection Limit and Dup Limiting Repeatability.

When a sample scheme analyte receives a numeric final value, default precision assessment is applied by the system:

If the sample's Primary Analytical Type and Secondary Analytical Type is something other than Duplicate or Replicate, then precision assessment sets the sample scheme analyte's Precision Status to Not Required.
If the related scheme version analyte's Analyte Type is not Analytical, then precision assessment sets the sample scheme analyte's Precision Status to Not Required.
If the related scheme version analyte's QC Active check box is cleared, then precision assessment sets the sample scheme analyte's Precision Status to Not Required.
For duplicate assessment, that is, where the sample's Primary Analytical Type or Secondary Analytical Type is Duplicate, the related scheme version analyte's Analyte Type is Analytical and the QC Active is selected, then precision assessment passes the result through the default precision assessment using the scheme version analyte's Dup Statistical Detection Limit and Dup Limiting Repeatability to set the sample scheme analyte's Precision Status.
For replicate assessment, that is, where the sample's Primary Analytical Type or Secondary Analytical Type is Replicate, the related scheme version analyte's Analyte Type is Analytical and the QC Active is selected, then precision assessment passes the result through the default precision assessment using the scheme version analyte's Rep Statistical Detection Limit and Rep Limiting Repeatability to set the sample scheme analyte's Precision Status.

To configure custom precision assessment that occurs AFTER default precision assessment, which may overwrite the sample scheme analyte's Precision Status, specify the Precision Script.

For custom duplicate assessment, enter the Dup Statistical Detection Limit and Dup Limiting Repeatability since the default precision assessment is applied always, even if any further script-based assessment occurs, and enter the Reproducibility and Reproducibility Range Table Code, as per the script logic.

For custom replicate assessment, enter the Rep Statistical Detection Limit and Rep Limiting Repeatability since the default precision assessment is applied always, even if any further script-based assessment occurs, and enter the Repeatability and Repeatability Range Table Code, as per the script logic.

Automatic Release and Validation

Scheme analyte results can be defined to be automatically released after analysis, or automatically validated after either manual or automatic release.

Automatic release makes the scheme analyte available for further processing immediately after analysis, without requiring workflow input in the CCWKOP—Open Workbook application.

Automatic validation also makes the scheme analyte available for further processing immediately when the scheme is opened in workbook.

A scheme version analyte's Auto Release and Auto Validate flags allow for automatic release and validation after a sample scheme analyte achieves a Workflow Status of Analysed and there are no QC status failures.

Reporting

A scheme version analyte can be flagged to be reportable, and have report details.

To be included in a reporting result set, a report request scheme analyte must be Reportable.

A report request scheme analyte's Reportable flag is inherited from the job scheme analyte's Reportable flag, which, in turn, is inherited from the interim sample scheme analyte's Reportable flag when adding a group of samples to a job, which, in turn, is inherited from the scheme version analyte's Reportable flag.

A report request scheme analyte's Report Name and Report Description are inherited from the job scheme analyte's Report Name and Report Description, which, in turn, is inherited from the interim sample scheme analyte's Report Name and Report Description when adding a group of samples to a job, which, in turn, is inherited from the scheme version analyte's Report Name and Report Description.

A report request scheme analyte's Report Sequence can be used by the report template to order analytes output to the report.

A report request scheme analyte's Report Sequence is inherited from the job scheme analyte's Report Sequence, which, in turn, is inherited from the interim sample scheme analyte's Report Sequence when adding a group of samples to a job, which, in turn, is inherited from the scheme version analyte's Report Sequence.

Rounding of Results

The numeric, date, date and time and text result values are rounded and formatted so that better analysis of the report results is possible.

The following parameters are required for rounding to be implemented:

RoundingMethodType

and

NumericFinalValue, InternalUnit, ReportUnit, RepLowerDetLimit, RepUpperDetLimit and, RoundingTable or ReportDisplayMask, or
TextValue, or
BooleanValue and RoundingTable or ReportDisplayMask, or
DateValue and DateTimeValue.

When analyte results are processed for rounding and formatting, the detection limits are rounded before being used in the rounding function. Any internal units are converted to the reporting unit prior to the actual rounding and formatting of the analytical result.

A scheme version analyte's Accredited flag can be used in report templates.

A scheme version analyte's Allow Report of Non-validated Data flag determines whether non-validated data can be included on a preliminary report.

A scheme version analyte's Report Unit Code is the reported unit. Numeric final results are converted from the internal units to the report units.

A scheme version analyte's Report Lower DL and Report Upper DL are the reportable detection limits.

To configure no rounding to generate the formatted final value a scheme version analyte's Rounding Method Type can be set to None. By default, no rounding is used to generate a formatted final value for the analyte.

To configure rounding using a rounding table to generate the formatted final value, a scheme version analyte's Rounding Method Type can be set to Table, and a Rounding Table Code selected. By default, rounding using a rounding table is used to generate a formatted final value for the analyte.

To configure rounding using a mask to generate the formatted final value, a scheme version analyte's Rounding Method Type can be set to Mask, and a Report Display Mask entered (using the same format as the Display Mask used for workbook. By default, rounding using a display mask is used to generate a formatted final value for the analyte. A report display mask cannot be used for analytes with a Data Type of Boolean, Image or Document.

To configure rounding using a script to generate the formatted final value, a scheme version analyte's Rounding Method Type can be set to Script, a Rounding Table Code selected, and, for use in the script, also a Report Display Mask can be entered and a Rounding Script Code selected. By default, rounding using a script is used to generate a formatted final value for the analyte.

These rounding details set the default rounding details for sample scheme analytes and report request sample scheme analytes.

Determining Uncertainty

Uncertainty can be reported alongside the results.

A number of parameters are needed to generate a formatted final value, including rounding and the calculation of uncertainty. The sample scheme analyte's uncertainty needs to be reported as a string so that it can be placed next to the formatted final value. Uncertainty can be calculated via script, range table, a fixed percentage value, or any combination of these.

To configure the uncertainty determination to not occur, a scheme version analyte's Uncertainty Type can be set to None, in which case, if a report request's Report Type is Certificate, when a report is generated, then the sample scheme analyte's Numeric Final Value is used to determine the report request sample scheme analyte's Formatted Final Value, but Uncertainty is left empty.

To configure uncertainty as a default value, a scheme version analyte's Uncertainty Type can be set to Default Value, and an Uncertainty Factor entered, such that, if a report request's Report Type is Certificate, when a report is generated, then the sample scheme analyte's Numeric Final Value is used to determine the report request sample scheme analyte's Formatted Final Value, and Uncertainty is set to the linked scheme version analyte's Uncertainty Factor / 100 x Numeric Final Value, expressed as a string.

To configure uncertainty as a default string, a scheme version analyte's Uncertainty Type an be set to Default Text, and Uncertainty Text entered, such that, if a report request's Report Type of Certificate, when a report is generated, then the sample scheme analyte's Numeric Final Value is used to determine the report request sample scheme analyte's Formatted Final Value, and Uncertainty is set to the linked scheme version analyte's Uncertainty Text.

To configure uncertainty using the Numeric Final Value input to a range table, a scheme version analyte's Uncertainty Type can be set to Table and Uncertainty Range Table Code entered, such that, if a report request's Report Type is Certificate, when a report is generated, then the sample scheme analyte's Numeric Final Value is used to determine the report request sample scheme analyte's Formatted Final Value, and Uncertainty is set to the factor from the range table (value that is returned from the range table denoted by the linked scheme version analyte's Uncertainty Range Table Code when the Numeric Final Value is supplied as the input to the table) / 100 x Numeric Final Value, expressed as a string.

To configure uncertainty using a script, a scheme version analyte's Uncertainty Type can be set to Script, and an Uncertainty Text, Uncertainty Factor, Uncertainty Range Table Code and Uncertainty Script Code entered, such that, if a report request's Report Type is Certificate, when a report is generated, then the sample scheme analyte's Numeric Final Value is used to determine the report request sample scheme analyte's Formatted Final Value, and Uncertainty is set by the script denoted by the linked scheme version analyte's Uncertainty Script Code. The scheme version analyte's Uncertainty Text, Uncertainty Factor and Uncertainty Range Table Code are available to the script.

Invoicing and Job Costs

Scheme version analytes can be flagged to be invoiceable and included in job costs.

To be invoiceable, regardless of whether the scheme's Price Type is Sample-Based, Scheme-Based, Unit-Based or Analyte-Based, a scheme must be both active for invoicing, and associated with a valid pricing model (via a price book and price schedule).

An invoice scheme analyte's Invoiceable flag is inherited from the job scheme analyte's Invoiceable flag, which, in turn, is inherited from the interim sample scheme analyte's Invoiceable flag when adding a group of samples to a job, which, in turn, is inherited from the scheme version analyte's Invoiceable flag.

A job cost is the actual cost of analysis to the laboratory for the job. The pricing framework for internal costs is maintained in exactly the same manner as with client invoicing. A costing price catalogue group is created and associated with the laboratory and related price books contain price schedules for the costs. The price codes used for costing are the same as those assigned for client invoicing.

For a sample scheme analyte to be activated for internal costing, the scheme version analyte's Include in Costs must be selected.

Enabling Org-scope Scheme Version Anlytes for Use in the Laboratory

When an org-scope scheme is selected to be enabled for the laboratory, if the scheme has:

Org-scope and the highest published scheme version, is not yet enabled for the laboratory, then the scheme version is enabled.
Org-scope and the highest published scheme version is already enabled for the laboratory, then the scheme version is not re-enabled.
Enabled scope or lab-scope, then an error returns saying that the scheme is not suitable for laboratory enabling.

If a scheme version is enabled, then:

A copy of the org-scope scheme record is created and given enabled-scope for that laboratory (other laboratories can enable their own set of schemes).
A copy of the org-scope highest published scheme version is created and given enabled-scope for the laboratory.
A copy of the org-scope scheme version analytes in the enabled scheme version are created and given enabled-scope for the laboratory.

Refer to Maintaining Schemes to enabled org-schemes for use in a laboratory.

An enabled-scope scheme analyte can be localised by the laboratory by configuring the ALLOW_SCHEMEVERSIONANALYTE_EDITABLE_PROPERTIES application preference which specified which scheme version analyte DTO properties are editable. This allows properties that are inherited from the scheme version analyte into a sample scheme analyte or job scheme analyte analyte to be tailored to local requirements, but also ensures that those properties which are deemed to be organisation-controlled remain inviolate.

Set the ALLOW_SCHEMEVERSIONANALYTE_EDITABLE_PROPERTIES Preference

When an org-scope scheme is enabled for use by a laboratory, data cannot be added to the analytes in that copied scheme. This requires a new scheme version on the org-scope scheme, then that new scheme version needs to be published and then enabled by the laboratory.

Referencing Scheme Version Analytes in Specifications

Analytes within master scheme versions can be added to specifications to set limits for scheme version analytes and added to samples. Analytes can be added from the highest-published scheme version of a scheme. Note that an org-scope scheme version must be enabled by a laboratory for it to be available to the laboratory.

Registering Scheme Version Analytes on Samples

When an analyte is registered on a sample, the sample scheme analyte is linked to the actual scheme version analyte that was used.

When an org-scope scheme is registered on an org-scope or lab-scope sample, it is the org-scope scheme version relating to the highest enabled-scoped scheme version in the laboratory that is added to the sample, however:

For an org-scope sample, the sample scheme details are taken from the org-scope scheme and scheme version, and the sample scheme analyte details are taken from the org-scope scheme version analyte.
For a lab-scope sample, the sample scheme details are taken from the enabled-scope scheme and scheme version, and the sample scheme analyte details are taken from the enabled-scope scheme version analyte.

The WORKBOOK_OVERRIDE_SCHEME_VERSION_ANALYTE_LIST amd ALLOW_REPORTING_UNCERTAINTY_OVERRIDE application preferences are used by the system to allow the CCWKOP—Open Workbook application to use enabled-scope scheme version analyte properties.

Refer to the Using Organisational Schemes vs Laboratory Schemes.