Maintaining Sample Tests

Overview

A scheme denotes one of the steps performed on a sample for analytical process to occur. A scheme denotes either a sample preparation, analytical preparation, analytical or miscellaneous process. Analytical preparation and analytical schemes can have analytes which specify a type of analytical result.

A sample scheme (SS) is an implementation of a scheme version's method on a sample, created by registering a scheme and scheme version, and analytes where required, on the sample. The sample scheme holds the details and status of the test for the sample. When sample schemes are created, various attributes are inherited from the scheme or scheme version.

A sample scheme analyte (SSA) holds the details, result and status of a test parameter. When sample scheme analytes are created, various attributes are inherited from the laboratory-scope scheme version analyte.

A test denotes either a scheme or an analyte on a sample.

Sample Scheme and Sample Scheme Analyte Scope

Schemes exist either at the organisation level or at the laboratory level, that is, schemes with org-scope or lab-scope. Those at the organisational level can be enabled for use by a laboratory, upon which, an enabled-scope scheme is created (and possibly updated) by the laboratory.

Schemes and their associated version and analytes are maintained using the CCSCHM—Scheme application. Refer to Maintaining Schemes.

Only org-scope schemes can be registered on samples contained within an org-scope template job.

Only lab-scope or enabled-scope schemes can be registered on samples contained within a lab-scope job, template or otherwise.

Sample schemes are scoped by the related sample, scheme and scheme version.

Sample scheme analytes are scoped by the related sample scheme.

Process

Once samples are added to a job, single or multiple samples within the context of a job can be searched and maintained using the CCREGN—Job application, or single samples outside the context of a job can be searched and maintained using the CCSAMP—Sample application.

A test is a scheme and analyte, or a scheme itself. It also encompasses those schemes without analytes: sample preparation and miscellaneous, even though they are generally not 'tests'. Analytes are displayed in rows below each scheme. The scheme can be expanded or collapsed to show or hide its analytes. Refer to Maintaining Schemes.

Viewing Sample Tests

When a sample is created to then display the interim sample (which is a temporary sample that becomes one or more registered samples upon submit), or a single sample or multiple samples are opened in the CCSAMP—Sample Update application, then the related tests are displayed on the Tests tab.

Adding Sample Tests

Tests can be added to an interim samples, single samples or multiple samples. When an interim sample is first created, it has no tests assigned to it.

If tests are added to an interim sample that expands to multiple samples upon submit, then the tests on the interim sample are registered on all expanded samples.

The Test tab consists of two grids:

  • Upper grid—The schemes and analytes already added to the sample.

    Note: When opening a sample in a laboratory batch job, if the sample belongs to a production job, then the tests are read-only.

  • Lower grid—The search grid containing schemes and analytes returned from a search which are enabled by the laboratory for addition to production samples.

Tests can be added to an interim sample, single samples or multiple samples in two ways, by:

  • Locating tests in the lower grid using a set of criteria to return tests available for registration.

    Schemes and optionally analytes can be searched using Scheme Code, Scheme Name, Analyte Code, Analyte Name, Scheme Type, Section Name, Section Description, Method Name and/or Method Description.

    In the scheme search criteria, setting the Filter Option to:

    • Filter Schemes—Returns schemes that match the criteria and ALL of their analytes. For example, entering an Analyte Code of CU returns schemes where there is a related scheme version analyte whose Analyte Code is CU, however all analytes within those schemes are returned.

    • Filter Schemes and Analytes—Returns schemes and analytes that match the criteria. For example, entering an Analyte Code of CU returns schemes where there is a related scheme version analyte whose Analyte Code is CU, and just that analyte in those schemes is returned.

    The list only contains the highest published scheme version of a scheme. Refer to the Effect of Scheme Scope when Registering Tests on Samples.

    For an org-scope template job, the list of tests that are returned from this search are those that are not registered on the sample/s, and includes org-scope schemes with a published scheme version.

    For a lab-scope job, template or otherwise, the list of tests that are returned from this search are those that are not registered on the sample, and includes a) enabled-scope schemes which are org-scope schemes that have no line of business or a line of business matching one of the laboratory's lines of business, and were subsequently enabled for laboratory use, and b) lab-scope schemes.

    Note: When searching and filtering based on schemes and analytes using Analyte Code or Analyte Name criteria, then the scheme is still returned from the search, even if the analytes that match the criteria are ALREADY registered on the sample, however, only analytes that are NOT already registered on the sample are returned from the search. Where all analytes for a scheme version are already registered on the sample, then the scheme is not returned from the search.

    Inheriting Properties from the Master Scheme and Analyte into a Sample Scheme and Sample Scheme Analyte

    When a sample scheme is created from a master scheme, various properties are inherited from the scheme or scheme version.

    When a sample scheme analyte or job scheme analyte is created from a master scheme version analyte, various properties are inherited from the scheme version analyte.

    Where an org-scope scheme or analyte is added, these properties are taken from the enabled-scope scheme, scheme version or scheme version analyte.

    Where a lab-scope scheme or analyte is added, these properties are taken from the lab-scope scheme, scheme version or scheme version analyte.

  • Adding tests from a selected template sample.

    This allows an older version of a scheme to be added to a sample, where another version of the same scheme does not already exist on the sample. Refer to Registering Jobs from Template Jobs, Adding Samples to a Job using Template Samples, and Adding Tests to Samples using Template Samples.

    Note: Any attempt to register an additional analyte to a sample scheme where the analyte belongs to a later version of the scheme compared to the version of the scheme on the sample results in an error since there may be analytes in a later scheme version that are not available in the earlier scheme version.

    Inheriting Properties from the Template Sample Scheme or Sample Scheme Analyte

    When a sample scheme is created from a template sample scheme, various properties are inherited from the scheme or scheme version.

    When a sample scheme analyte or job scheme analyte is created from a template sample scheme analyte, various properties are inherited from the template sample scheme analyte.

Adding Tests During Multiple Sample Update

When updating multiple samples and using Add All to add missing schemes and analytes to samples, then any sample schemes and sample scheme analytes created are created using a Save As process where the source sample is the first sample in the multiple sample update. Therefore, if the first sample in the multiple sample update is a template sample, then any new sample scheme and sample scheme analyte inherits all fields from the source template sample scheme and sample scheme analyte, respectively.

For example, if the first sample in the multiple update was created from a template sample, such that its sample schemes and sample scheme analytes link to the source template sample and template sample's Package Price Code, then the new sample schemes and sample scheme analytes also link to the source template sample and template sample's package price code.

Also refer to Registering Jobs from Template Jobs, Adding Samples to a Job using Template Samples.

Removing Schemes and Analytes from Samples

There are options to remove Schemes or Analytes from the sample via the grid flow:

Remove Analyte - Allows the user to delete selected analytes from the sample scheme.

Remove Scheme - Allows the user to delete selected schemes from the sample.

Note: An analyte or scheme cannot be deleted from the sample if the sample is in a lab batch if the mechanism used to delete is Remove Analyte or Remove Scheme.

Deletion of a sample scheme can change which sample scheme is the precursor sample scheme of a sequel sample scheme, and can therefore have an affect on expiry date and warning date calculations.

Refer to Conditions for Calculating Expiry and Warning Dates and Using Sample Expiry.

Remove Scheme with Related QC – Removes the selected scheme from a sample and all its related QC samples (duplicates, replicates, spikes). If the removed scheme is the last scheme on a QC sample, the QC sample can also be deleted by an option in the dialog.

This service also applies to lab batch jobs (unlike the standard Remove Scheme service). If the sample has been lab batched, the scheme is also removed from all related QC samples in the batch, regardless of whether those QC samples were created in the batch or not. If removing the scheme leaves a QC sample with no remaining schemes, the QC sample can also be deleted from the batch.

This ensures that schemes remain consistent across the original sample, its related QC samples, and any associated lab batch samples.

Composite job scheme and job scheme analyte records are deleted, as required.

Job invoice scheme and job invoice scheme analyte records are deleted, as required.

Note: A scheme cannot be deleted from a laboratory batch sample using CCREGN, as the removal service is not available for lab batch job types.
An analyte or scheme cannot be deleted from the sample if it is referenced in an invoice and the invoice status is past Draft.

Example:

  • A production job contains unknown and QC samples added from an update QC process. When a parent original or spike original sample scheme analyte is deleted, then the related duplicate, replicate or spike QC sample scheme analyte is deleted also. When a duplicate, replicate or spike QC sample scheme analyte is deleted, then the parent original or spike original sample scheme analyte remains untouched.

        Production Job—Before delete   Production Job—After delete        

    QC Source

    Sample

    A1

    A2

    A3

     

    A1

    A2

    A3

    2

    BLANK

     

     

     

     

     

     

     

    1

    S1

     

    Delete

     

     

     

     

     

    2

    S1 REP

     

     

     

     

     

     

     

    2

    STD1

     

     

     

     

     

     

     

    2

    STD3

     

     

     

     

     

     

     

    1

    S2

     

     

     

     

     

     

     

    1

    S3

     

     

     

     

     

     

     

    1

    S4

     

     

     

     

     

     

     

    1

    S5

     

     

     

     

     

     

     

    1

    S6

     

     

     

     

     

     

     

    2

    S6 REP

     

    Delete

     

     

     

     

     

    1

    S7

     

     

     

     

     

     

     

    1

    S8

     

     

     

     

     

     

     

    1

    S9

     

     

     

     

     

     

     

    1

    S10

     

     

     

     

     

     

     

    2

    STD2

     

     

     

     

     

     

     

Removing Links to Laboratory Batch Jobs

If a test belongs to a sample in a job where the job's Job Type is Production or Internal, then any links to laboratory batch jobs should be removed before the sample scheme and/or analyte is deleted. If this is not done, then any related laboratory batch sample cannot have results entered, leaving the laboratory batch job in a state where it can never be completed.

Links to laboratory batch jobs can either be removed one of the following ways:

  • Deleting the related sample in the laboratory batch job

    This removes the link from any sample scheme analytes in the production/internal jobs to the laboratory batch job.

    Warning: The consequence of this action is that the laboratory batch jobs are shrunk and the rack positions adjusted, meaning that any instrument run lists created previously may now be out of date.

  • Removing the links from the production/internal sample scheme analytes to the laboratory batch job and samples.

    When the link from any sample scheme analytes to the laboratory batch job and samples are removed, then the Workflow Status for each associated laboratory batch sample scheme analyte is set to Not Analysed, which cascades up to set the Workflow Status for each associated laboratory batch sample scheme to Not Analysed, and in turn, cascades up to set the Workflow Status for the associated laboratory batch sample to Not Analysed.

    This means that the de-linked laboratory batch samples do not leave the laboratory batch job in a state where it can never be completed.

Remove links from registered samples to lab-batch samples

After doing this, deletion of the sample can proceed.

Upon sample scheme analyte deletion:

  • The same analyte is deleted from sample schemes of related QC samples in the same job. (The same action is not applied when analytes are added to a sample scheme.)

  • Any laboratory batch job that contained the deleted sample scheme analyte now shows that sample scheme analyte as no longer in the laboratory batch job.

  • Job invoice scheme and job invoice scheme analyte records are deleted, as required.

  • Deletion of a sample scheme can change which sample scheme is the precursor sample scheme of a sequel sample scheme, and can therefore have an affect on expiry date and warning date calculations.

  • Any QC records associated with the deleted tests are maintained in the QC history repository.

Maintaining Sample Tests

Upon maintaining tests on samples:

  • Composite job scheme and job scheme analyte records are created or updated, as required, and the job scheme's Number of Samples and Number of Unknowns is updated.

  • The event is audited. Refer to Reviewing Operational Data Audits.

Maintain sample tests

Maintaining a Sample Scheme's Subcontract Laboratory Details

The Subcontract Laboratory Code denotes the laboratory where samples are subcontracted for analysis by this scheme where they cannot be analysed in-house.

A sample scheme's Subcontract Laboratory Code defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

When searching for samples for Batching Samples for Analysis, then samples can be searched based on the subcontract laboratory.

Maintaining a Sample Scheme's Priority and Dates

A sample scheme's Priority is used when selecting and sorting samples for laboratory batching.

A sample scheme's Priority defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme.

A sample scheme's Required On date-time defaults from the sample.

Refer to Conditions for Calculating Expiry and Warning Dates and Using Sample Expiry.

When searching samples for Batching Samples for Analysis, then samples can be searched based on priority.

Maintaining a Sample Scheme's Precursor Sample Scheme

A precursor scheme is a scheme that must be process in the laboratory before one or more sequel schemes are processes. This typically includes analytical preparation scheme work that occur before analytical scheme work.

The Precursor Scheme Code indicates which sample scheme is a precursor of the current sample scheme. This is used to determine holding times, expiry times, and QC sample propagation into job schemes other than the one for which the QC sample was created.

A sample scheme's Precursor Scheme Code defaults from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme's precursor scheme relationships when it is registered using a master scheme. Both schemes must be registered on the sample. When a scheme is registered on a sample, if an existing sample scheme is a precursor or sequel of the new sample scheme, then a precursor sample scheme relationship is established.

A master scheme can have a list of precursor schemes, and one or more of those precursor schemes can be configured to be registered automatically when the sequel scheme is registered on the sample, as long as the precursor scheme is either a lab-scope scheme or an org-scope scheme that is enabled for laboratory use.

Where more than one sample scheme is a precursor of a sequel sample scheme, when the sequel sample scheme is registered, the sample scheme's Precursor Scheme Code is set to the first precursor sample scheme, based on alphanumerical order, after which it can be updated to link to a different precursor sample scheme. A precursor scheme scenario could be that you do not want to include samples in the count for analysis until their preparation is at least started, or one sample scheme may have a varying preparation pathway, or different samples may have a different combination of precursor schemes and sequel schemes.

When an org-scope scheme is registered on a lab-scope job, the master scheme from where precursor scheme relationships are determined is the enabled-scope scheme.

A precursor sample scheme's state controls which sample schemes are available for batching and which sequel sample schemes may be expired for analysis.

A precursor sample scheme's Ready Date can be used as a sample search criteria when searching for samples to batch.

A precursor sample scheme's Completed Date is used to determine a sequel sample scheme's Warning Date and Expiry Date and sequel sample scheme analyte's Warning Date and Expiry Date, which can be used to lock sequel sample scheme analyte's cell in a workbook session.

Example:

  • Scenario:

    Scheme Code

    Precursor Scheme Code

    Auto Profile

    ICP

    CRU

    Y

     

    DRY

    Y

    AAS

    DIA

    N

     

    DRY

    Y

     

    PUL

    Y

    Sample1 is registered with ICP, CRU, DRY.

    Sample 2 is registered with AAS, DEY, PUL.

    The precursor sample schemes that would be available for selection are:

    Sample Code

    Scheme Code

    Available Precursor Scheme Code

    Sample1

    ICP

    CRU (current)

     

     

    DRY

    Sample2

    AAS

    DRY (current)

     

     

    PUL

Example:

  • These scenarios cover edge cases were in the set of samples in the multi-update, some sample schemes have existing precursor scheme relationships and some do not, and some sample schemes have different versions of a precursor scheme.

    Scenarios for the following precursor relationships and registrations:

    • Ana1PrepB precursors: Ana1PrepA

    • Ana1 precursors: Ana1PrepA, Ana1PrepB (auto-reg=True), Ana1PrepC, Ana1PrepD

    In the following scenarios, all 5 samples are included in a multi-update. Note that no precursor scheme codes can be displayed as they can vary on each SS in the multi-update.

  • A) Add to All is used—without adding Schemes or Precursor Scheme links

    Grid before multi-update:

     

    Ana1PrepA

    Ana1PrepB

    Ana1

    S1

    Reg

    --

    Reg, precursor=Ana1PrepA

    S2

    --

    Reg

    Reg, precursor=Ana1PrepB

    S3

    Reg

    Reg

    Reg, precursor=Ana1PrepA

    S4

    --

    --

    --

    S5

    --

    Reg

    Reg

    The following action shows that on registration of new SSs via add to all, then existing precursor relationship is not updated, but new ones are established.

    • Ana1PrepA --> Add to All

    • Ana1PrepB --> Add to All

    Submit gives:

     

    Ana1PrepA

    Ana1PrepB

    Ana1

    S1

    Reg

    Reg

    Reg, precursor=Ana1PrepA (precursor already on SS, so don't change)

    S2

    Reg

    Reg

    Reg, precursor=Ana1PrepB (precursor already on SS, so don't change)

    S3

    Reg

    Reg

    Reg, precursor=Ana1PrepA (precursor already on SS, so don't change)

    S4

    Reg

    Reg

    --

    S5

    Reg

    Reg

    Reg, precursor=Ana1PrepA (establish new precursor relationship; precursor set based on alpha-numeric order)

  • B) Manually specify a Precursor Scheme

    Grid before multi-update:

      Ana1PrepA Ana1PrepB Ana1

    S1

    Reg

    --

    Reg, precursor=Ana1PrepA

    S2

    --

    Reg

    Reg, precursor=Ana1PrepB

    S3

    Reg

    Reg

    Reg, precursor=Ana1PrepA

    S4

    --

    --

    --

    S5

    Reg

    Reg

    Reg

    The following action shows that when a new precursor relationship is selected, then it is set where that scheme is registered on the sample.

    • Ana1's precursor set to Ana1PrepB

    Submit gives:

      Ana1PrepA Ana1PrepB Ana1

    S1

    Reg

    --

    Reg, precursor=Ana1PrepA (no change as Ana1PrepB not registered on the sample)

    S2

    --

    Reg

    Reg, precursor=Ana1PrepB (was Ana1PrepB already)

    S3

    Reg

    Reg

    Reg, precursor=Ana1PrepB (updated precursor)

    S4

    --

    --

    --

    S5

    Reg

    Reg

    Reg, precursor=Ana1PrepB (would normally default to Ana1PrepA based on alpha-numeric order, but since Ana1PrepB is selected as precursor, this is set)

  • C) Precursor Scheme is Added to Samples

    Note that S2, Ana1 Precursor scheme starts as not assigned.

    Grid before multi-update:

      Ana1PrepA Ana1

    S1

    Reg

    Reg, precursor=Ana1PrepA

    S2

    Reg

    Reg

    S3

    --

    Reg

    S4

    --

    --

    S5

    --

    Reg

    The following action shows that on registration of new SSs via search and add, then existing precursor relationship is not updated, but new ones are established.

    Search Ana1PrepC in the bottom grid and add to the top grid (which does an auto-submit and refresh).

      Ana1PrepA Ana1 Ana1PrepC

    S1

    Reg

    Reg, precursor=Ana1PrepA (precursor already on SS, so don't change)

    Reg

    S2

    Reg

    Reg, precursor=Ana1PrepC (establish new precursor relationship)

    Reg

    S3

    --

    Reg, precursor=Ana1PrepC (establish new precursor relationship)

    Reg

    S4

    --

    --

    Reg

    S5

    --

    Reg, precursor=Ana1PrepC (establish new precursor relationship)

    Reg

    Now Ana1's precursor drop-down contains Ana1PrepA and Ana1PrepC as available options for change.

  • D) Add PreCursor Scheme to Sample(s) and use Add To All for the Sequel Scheme.

    Note that S2, Ana1 Precursor scheme starts as not assigned.

    Note that: Ana1PrepB is Auto-reg =True for Ana1 scheme.

    Grid before multi-update:

      Ana1PrepA Ana1

    S1

    Reg

    Reg, precursor=Ana1PrepA

    S2

    Reg

    Reg

    S3

    --

    Reg

    S4

    Reg

    --

    S5

    --

    Reg

    The following action shows that on registration of new SSs via add to all, then existing precursor relationship is not updated, but new ones are established.

    Search Ana1PrepC in the bottom grid and add to the top grid (which does an auto-submit and refresh).

    Now Ana1's precursor drop-down contains Ana1PrepA and Ana1PrepC

    Select Ana1's precursor as Ana1PrepA

    Select Ana1 --> Add to All

    Submit gives:

      Ana1PrepA Ana1 Ana1PrepB Ana1PrepC

    S1

    Reg

    Reg, precursor=Ana1PrepA (was Ana1PrepA already)

     

    Reg

    S2

    Reg

    Reg, precursor=Ana1PrepA (updated to selected precursor)

     

    Reg

    S3

    --

    Reg, precursor=Ana1PrepC (establish precursor relationship; precursor set to first alpha-numeric precursor)

     

    Reg

    S4

    Reg

    Reg, precursor=Ana1PrepA (auto-reg Ana1PrepB when Ana1 reg; establish precursor relationship; precursor set to first alpha-numeric precursor)

    Reg (auto)

    Reg

    S5

    --

    Reg, precursor=Ana1PrepC (establish precursor relationship; precursor set to first alpha-numeric precursor)

     

    Reg

    Now Ana1's precursor drop-down contains Ana1PrepA and Ana1PrepB and Ana1PrepC.

The master scheme's precursor scheme link affects propagation of QC samples from a precursor job scheme into a sequel job scheme, when:

A sample scheme's precursor scheme link affects the calculation of a sample scheme's or sample scheme analyte's Expiry Date, triggered when:

A sample scheme's precursor scheme link affects whether samples can be located and batched for particular schemes, when returning sample counts for batching, by whether precursor schemes are started, completed or ready.

Refer to Conditions for Calculating Expiry and Warning Dates and Using Sample Expiry.

Maintaining a Sample Scheme's Holding Time

A sample scheme's Holding Time is the maximum time frame in which a sample has to be analysed after it is prepared by a preparation process before the sample deteriorates to such a point that the correctness of the analytical result would be questionable. The point of deterioration is known as the expiry date. The warning date is the date and time at which users need to be notified of potential sample expiries.

A sample scheme's Holding Time defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme.

The Expiry Date date-time is counted either from the sample's Sampled On date-time, or Received On date-time if Sampled On is not set for sample schemes with no precursor sample scheme, or from the precursor sample scheme's Completed On date-time, plus the Holding Time.

When the holding time is updated for a production sample scheme and the production sample scheme does not have a precursor sample scheme, the sample scheme is included in a laboratory batch, and the sample's Received Date or Sample Date is set, then the laboratory batch sample scheme's Holding Time is synchronised with the production sample scheme's Holding Time, and the laboratory batch sample scheme's Expiry Date is calculated. Refer to Using Sample Expiry.

Example: A production job contains S2Ana5 and S2Ana6, and S2Ana5 is the precursor sample scheme of S2Ana6. If S2Ana5 and S2Ana6 are included in the same laboratory batch job, then in the laboratory batch job, LB_S2_Ana5 is the precursor sample scheme of LB_S2_Ana6. In this case, an update to S2Ana5's Holding Time would recalculate LB_S2Ana5's Expiry Date using S2's Sampled Date or Received Date (whichever is earlier) and S2Ana5's Holding Time.

A sample scheme's Expiry Date and precursor sample scheme's Expiry Date is returned and displayed for samples when Batching Samples for Analysis, and can potentially show a workbook cell as locked. Refer to Workbook Cell Locks and and Unlocking Workbook Cells.

Note that the scheme version's Warning Time determines the sample scheme's Warning Date which can be included in laboratory status reports to see which samples are coming up to being expired for given schemes.

Maintaining a Sample Scheme's Workbook Script

The Scheme Script is the code of the script whose event functions are run at various points in a workbook session, when samples for the scheme are loaded into the workbook.

A sample scheme's Scheme Script defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme.

Maintaining a Sample Scheme's Considering a Sample Scheme in Context of Job Scheme QC Placements

When Creating QC Samples using QC Masks for a job scheme, then the action includes sample schemes only where the sample scheme's Included in Job QC is selected.

A sample scheme's Include in Job QC defaults to selected.

For each job scheme included in the process, then:

  • The related sample schemes are grouped by QC Mask Code, then for each of those groups, QC samples are created and added to the job scheme.

  • Once a sample scheme has been included in a update QC process, then the sample scheme's Include in Job QC is cleared by the system.

A sample scheme's QC Mask Code defaults from the template sample scheme's QC Mask Code when a template sample is used to register a sample scheme, and from the scheme version's QC Mask Code when it is registered using a master scheme.

Maintaining a Sample Scheme's Reporting Details

The following table shows how reportable details are inherited from the master scheme / scheme version or template sample scheme, into the sample scheme, then into the report request sample scheme.

Master Scheme Version (SV) or
Template Sample Scheme (template SS)		 Sample Scheme (SS) Report Request Sample Scheme (RRSS) Use
SV or Template SS Reportable SS Reportable RRSS Reportable Determines whether the SS scheme is included in the report result sets when the sample and scheme are included in a certificate report request.
SV or Template SS Report Sequence SS Report Sequence RRS Report Sequence No core functional use, but may be used where the report template includes a DSC to apply custom report logic, to place this sample scheme earlier than other sample schemes.
SV or Template SS Report Header Text SS Report Header Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.
SV or Template SS Report Footer Text SS Report Footer Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.
SV or Template SS Results Header Text SS Results Header Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.

Canned comments are available to quickly entered pre-canned text. When canned comments are accessed for a given note field, the canned comments are filtered by Canned Comment Type and Canned Comment Subtype.

  • The Canned Comment Type of GLOBAL, JOB, SAMPLE or SCHEME, and the Canned Comment Subtype of GLOBAL, REGISTRATION, RECEIPT, ANALYSIS, RELEASE, VALIDATION, REPORT or INVOICE.

or:

Reporting details for sample schemes can be updated from the Tests grid in the CCSAMP—Sample Detail and CCSAMPMULTIEDIT—Update Multiple Samples Detail screens by directly editing the fields.

Maintaining a Sample Scheme's Invoicing Details

A sample scheme's Invoiceable denotes whether the sample scheme is included in invoice pricing when the sample and scheme are included in a job invoice.

A sample scheme's Invoiceable defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme.

The Number of Hours has no core functional use.

Where a template sample was used to register the sample scheme, then the Package Price Code, inherited from the template sample's Template Price Code, indicates that pricing of the sample scheme is covered by package pricing, such that, it is not included in regular pricing of the scheme.

Maintaining a Sample Scheme's Costing Details

A sample scheme's Internal Cost has no core functional use.

Maintaining a Sample Scheme's Sample Scheme Notes

Analysis Notes and Report Notes can be added to a sample scheme for informational or reporting purposes.

A sample scheme's Analysis Notes and Report Notes defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme, but note that they are linked to new text entities containing the defaulted text.

Canned comments are available to quickly entered pre-canned text. When canned comments are accessed for a given note field, the canned comments are filtered by Canned Comment Type and Canned Comment Subtype.

  • The Canned Comment Type of GLOBAL, JOB, SAMPLE or SCHEME, and the Canned Comment Subtype of GLOBAL, REGISTRATION, RECEIPT, ANALYSIS, RELEASE, VALIDATION, REPORT or INVOICE.

or:

Maintaining a Sample Scheme's Ready Date

A sample scheme's Ready Date is the date-time at which the sample portion associated with the sample scheme is ready for analysis to proceed, based upon precursor relationships. A sequel sample scheme of a precursor sample scheme is available for batching if the precursor sample scheme's Ready Date is at or earlier than the current system date-time.

If the scheme version's Waiting Time is defined then the sample scheme's Ready Date defaults to the sample scheme's Started Date + the scheme version's Waiting Time, and is updated automatically when the sample scheme's Workflow Status becomes Started, in which the sample scheme's Started Date is set.

However, this means that if a sample scheme's Ready Date is set for all samples expanded from the sample group, then it is overwritten when the sample scheme's Started Date is set. This leads to the potential to batch sample schemes because their precursor sample scheme's Ready Date is at or later than the current system date-time even though the precursor sample scheme's Started Date may not yet been set, or their sample scheme's Ready Date is at or later than the current system date-time even though the sample scheme's Started Date may not yet been set.

A sample scheme's Ready Date affects returning sample counts for batching, by whether precursor schemes are started, completed or ready.

Maintaining a Sample Scheme's Scheme Limits

The Scheme Limits Specification Code denotes the specification limits applied during scheme limit assessment of results to set the sample scheme analyte's Limit Status which rolls into the sample scheme analyte's Composite QC Status.

A sample scheme's Scheme Limits Specification Code defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme.

The sample scheme's limit specification can be opened to display its limits. The specification can be accessed directly via the CCSPFN—Specification application or it can be accessed via the sample scheme.

A sample scheme's Limit Specification Code effects Assessing Results against Scheme or Surrogate Limits.

Maintaining a Sample Scheme's Linked Schemes

Some tests always share common aliquot for analysis, whilst other tests always use their own aliquot for analysis. This can change from sample to sample, however, the linked scheme relationships on the master schemes dictate the default link scheme relationships between sample schemes (if both a from and to scheme is registered on the sample).

A sample scheme's linked scheme relationships default from the template sample scheme analyte when a template sample is used to register a sample scheme analyte, and from the scheme's linked scheme relationships when it is registered using a master scheme. Both schemes must be registered on the sample. When a scheme is registered on a sample, if an existing sample scheme is a linked sample scheme, then a linked sample scheme relationship is established.

When an org-scope scheme is registered on a lab-scope sample, the master scheme from where linked scheme relationships are determined is the enabled-scope scheme.

Linked schemes only apply to analytical preparation and analytical schemes.

Where sample schemes use the same aliquot for analysis, after Opening a Workbook Session in Weight/Volume mode for the first linked job scheme (only the first linked job scheme can be opened in this mode), when a weight or volume result is received into the linked from sample scheme, then the weight or volume is propagated into the linked to sample schemes.

Maintaining a Sample Scheme Analyte's Paperwork Requirements

Set a sample scheme analyte's Include on Worksheet to include the sample scheme analyte in paperwork or labels.

A sample scheme analyte's Include on Worksheets defaults from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

If a sample scheme analyte's Include on Worksheets is selected, then a report request sample scheme analyte is created for a paperwork or labels report request. A report request sample scheme is created for a paperwork or labels report request if at least one sample scheme analyte's Include on Worksheets is selected, and its reportability defaults to true.

Maintaining a Sample Scheme Analyte's Holding Time

A sample scheme analyte's Holding Time denotes the longest time the sample scheme analyte can wait for analysis to be done. The Expiry Date date-time is counted either from the sample's Sampled On date-time, or Received On date-time if Sampled On is not set for sample schemes with no precursor sample scheme, or from the precursor sample scheme's Completed On date-time, plus the Holding Time.

A sample scheme analyte's Holding Time defaults from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

Refer to Conditions for Calculating Expiry and Warning Dates.

Maintaining a Sample Scheme Analyte's Workflow and QC Assessment Settings

A sample scheme analyte's Workflow Active has no functional use in core CCLAS. This flag is taken from the master scheme version analyte.

A sample scheme analyte's QC Active indicates whether a result for the sample scheme analyte undergoes QC assessment.

A sample scheme analyte's QC Active defaults from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

This effects system processes following result entry with regard to whether the result is subjected to QC assessment.

If a sample scheme analyte is assessed for QC, when a final numeric result is received for the sample scheme analyte, then, depending upon the type of sample (unknown, duplicate, replicate, standard, blank or spike), then various QC assessments are performed on the result to set the various individual sample scheme analyte's QC statuses and the composite sample scheme analyte's Composite QC Status.

Maintaining a Sample Scheme Analyte's Priority and Dates

A sample scheme analyte's Required On date-time defaults to the sample's Required On date-time.

The required date is set or cleared, allowing it to be different to other analytes and schemes on the sample, especially pertinent to urgent work.

Refer to Conditions for Calculating Expiry and Warning Dates.

Maintaining a Sample Scheme Analyte's Analysis Details

A sample scheme analyte's Unit Code denotes the internal unit of analysis. A result must undergo unit conversion to be reported in another unit.

A sample scheme analyte's Unit Code defaults from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

The Internal Lower DL and Internal Upper DL are the lower and upper detection limits, respectively, below and above which a result is outside the capability of the scheme, therefore providing no confidence in the result.

A sample scheme analyte's Internal Lower DL, Internal Upper DL, Internal Lower DL Critical and Internal Upper DL Critical default from the template sample scheme analyte when a template sample is used to register a sample scheme, and from the scheme version analyte when it is registered using a master scheme.

If a sample scheme analyte's Internal Lower DL Critical is cleared, when a final numeric result is received for the sample scheme analyte and Assessing Results against Detection Limits occurs and the result is less than the sample scheme analyte's Internal Lower DL, then the sample scheme analyte's Detection Limit Status is set to Lower Failure. However the non-criticality means it has no impact upon the pathway to validate the result, in which case, the sample scheme analyte's Workflow Status is set to Analysed, thereby allowing the result to automatically or manually proceed to being released and then validated.

If a sample scheme analyte's Internal Lower DL Critical is selected, when a final numeric result is received for the sample scheme analyte and Assessing Results against Detection Limits occurs and the result is less than the sample scheme analyte's Internal Lower DL, then whilst the sample scheme analyte's Detection Limit Status is set to Lower Failure, the sample scheme analyte's Workflow Status is set to Check, stopping the result being automatically or manually released or validated, that is, operator intervention is required. Any result below the lower detection limit must be checked and made good, or ignored with reason, before the sample scheme analyte can proceed to an analysed state.

If a sample scheme analyte's Internal Upper DL Critical is cleared, when a final numeric result is received for the sample scheme analyte and Assessing Results against Detection Limits occurs and the result is greater than the sample scheme analyte's Internal Lower DL, then the sample scheme analyte's Detection Limit Status is set to Upper Failure. However the non-criticality means it has no impact upon the pathway to validate the result, in which case, the sample scheme analyte's Workflow Status is set to Analysed, allowing the result to automatically or manually proceed to being released and then validated.

If a sample scheme analyte's Internal Upper DL Critical is selected, when a final numeric result is received for the sample scheme analyte and Assessing Results against Detection Limits occurs and the result is less than the sample scheme analyte's Internal Upper DL, then whilst the sample scheme analyte's Detection Limit Status is set to Upper Failure, the sample scheme analyte's Workflow Status is set to Check, stopping the result being automatically or manually released or validated, that is, operator intervention is required. Any result above the upper detection limit must be checked and made good, or ignored with reason, before the sample scheme analyte can proceed to an analysed state.

Refer to Conditions for Setting a Critical DL Status Failure for a High Result.

A scheme version analyte can be assigned a Lower Template Sample Code and Upper Template Sample Code, such that, if the lower or upper detection limit, respectively, is breached on a sample scheme analyte related to the default scheme version analyte, then the user can trigger the registration of the tests from the particular template sample onto the sample so that check analysis can be performed.

Note: The Lower Template Sample Code and Upper Template Sample Code must be active, approved, a sample template, and scope sensitive to be accepted values. An expected validation message will occur if otherwise.

Alternately, a scheme version analyte can be assigned an Upper Scheme and Upper Analyte. The upper scheme and analyte is generally registered for the sample but assigned a Workflow Status of Not Analysed or No Result as there may ultimately be no need to analyse the scheme by this method where the lower scheme's range is suitable based on the result. However, where the upper detection limit is breached on a sample scheme analyte related to the default scheme version analyte and the AUTO_ACTIVATE_UPPER_SCHEME application preference is set, then:

  • The linked upper scheme analyte is activated, which means that if the upper sample scheme's Workflow Status is Not Analysed or No Result, then it is set to Not Started to indicate that there are tests outstanding for it.
  • The linked upper analyte is activated, which means that if the upper sample scheme analyte's Workflow Status is Not Analysed or No Result, then it is set to Repeat (rather than to Not Started) so that the sample scheme analyte can be located easily since these results need to be determined more quickly to get the report to the client.
  • The lower sample scheme analyte's Workflow Status is updated from Check to Analysed to indicate that is completely analysed and that there is nothing further to be done for it.

Refer to Conditions for Auto-activation of Upper Scheme Analytes.

The limitation to using an Upper Scheme and Upper Analyte instead of a Lower Template Sample Code and Upper Template Sample Code is that only one scheme analyte is provided for the check analysis.

Maintaining a Sample Scheme Analyte's Reporting Details

During reporting, the system automatically converts numeric results from the analysis unit to the reporting unit, before the rounding mechanism formats it for reporting.

Reporting details are either inherited from the master scheme version analyte, or from the template sample scheme analyte.

The following table shows how reportable details are inherited from the master scheme version analyte or template sample scheme analyte, into the sample scheme analyte, then into the report request sample scheme analyte.

Master Scheme Version Anayte (SVA) or
Template Sample Scheme Analyte (template SSA)		 Sample Scheme Analyte Report Request Sample Scheme Analyte Use
SVA or Template SSA Reportable SSA Reportable RRSSA Reportable Determines whether the SSA scheme is included in the report result sets when the sample and analyte are included in a certificate report request.
SVA or Template SSA Report Sequence SSA Report Sequence RRSAA Report Sequence No core functional use, but may be used where the report template includes a DSC to apply custom report logic, to place this sample scheme analyte earlier than other sample scheme analytes.
SVA or Template SSA Report Unit Code SSA Report Unit Code RRSSA Report Unit Code Sets the default report settings for report request sample scheme analytes and report request scheme analytes.
SVA or Template SSA Report Lower DL SSA Report Lower DL RRSSA Report Lower DL The lower reportable limit used in rounding the numeric final result for the report.
SVA Internal Lower DL Critical     The criticality of the lower reportable limit used in rounding the numeric final result for the report.
SVA or Template SSA Report Upper DL SSA Report Upper DL RRSSA Report Upper DL The upper reportable limit used in rounding the numeric final result for the report.
SVA Internal Upper DL Critical     The criticality of the upper reportable limit used in rounding the numeric final result for the report.
SVA or Template SSA Rounding Table Code SSA Rounding Table Code RRSSA Rounding Table Code The rounding table used to round a numeric result for the sample scheme analyte to achieve a reportable result string.
SVA or Template SSA Report Header Text SSA Report Header Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.
SVA or Template SSA Report Footer Text SSA Report Footer Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.
SVA or Template SSA Results Header Text SSA Results Header Text  

Can be included in the report template for informational or reporting purposes.

See the note regarding entering notes using canned comments.

Canned comments are available to quickly entered pre-canned text. When canned comments are accessed for a given note field, the canned comments are filtered by Canned Comment Type and Canned Comment Subtype.

  • The Canned Comment Type of GLOBAL, JOB, SAMPLE or SCHEME, and the Canned Comment Subtype of GLOBAL, REGISTRATION, RECEIPT, ANALYSIS, RELEASE, VALIDATION, REPORT or INVOICE.

or:

  • The list of category codes entered in the Category Code. The category codes are initially populated from the categories whose code appears in the related preference, where the preference changes according to the particular notes field being updated:

There are times that the analysis and reporting units need to be changed on a sample to suit a specific analysis or reporting requirement.

Reporting details can be updated for a sample scheme analyte in two ways, by:

  • Changing reporting details directly in the Tests grid in the CCSAMP—Sample Detail and CCSAMPMULTIEDIT—Update Multiple Samples Detail screens.

    However, where there are no conversion factors configured between the internal analysis unit and reporting unit, then no numeric conversions can take place, leading to the situation of results being reported without the correct numeric scales.

    Changing a sample scheme analyte's Report Unit Code by directly editing the fields does not factorise the Report Lower DL and Report Upper DL to reflect the newly selected reporting unit. To do this, use the Change Reporting Details grid flow.

  • Running the Change Reporting Details grid flow.

    Update sample scheme analyte reporting details

    This process restricts the user from selecting a reporting unit that does not have a pre-configured conversion from the internal unit.

    Where a New Reporting Unit is selected, then the dialog allows the Report Lower Detection Limit and Report Upper Detection Limit values that are associated with the existing Report Unit Code on each sample scheme analyte involved in the update to be converted to reflect the New Reporting Unit.

    With the update in reporting units, the dialog allows for the selection of a New Rounding Table.

    Apart from changing reporting units and rounding tables, the dialog also allows sample scheme analytes to be made Reportable or not.

    On applying the update:

    • Where a conversion factor does not exist between the New Reporting Unit and the scheme version analyte's Unit Code associated with each sample scheme analyte involved in the update (except where the New Reporting Unit is the same as the scheme version analyte's Unit Code), then an error is returned.

    • When a sample scheme analyte's Reporting Unit Code is updated to a different code, then:

      • Where the new reporting unit is the same as the analysis Unit Code on the scheme version analyte, then there is no conversion factor existence validation of the new reporting unit based on not having any unit conversion to itself.
      • Where conversion factors exist between the new reporting unit and the previous reporting unit, then the sample scheme analyte's Report Lower DL and Report Upper DL are converted to reflect the new reporting unit code, based on the conversion factors defined in the CCUNIT—Unit application.

    Example: Where the scheme version analyte's Unit Code is G and Report Unit Code is G, and the sample scheme analyte's Unit Code is G, Report Unit Code is G and Report Lower DL is 1, when the sample scheme analyte's Report Unit Code is updated to KG, then the system validates that a conversion unit exists between the scheme version analyte's Unit Code and KG and returns an error if no conversion factor exists, and if a conversion factor does exist then

    SVA

    SSA

    Reporting unit conversion rules

    Unit Code

    Report Unit Code

    Unit Code

    Report Unit Code

    Report Lower DL

    New Report Unit Code

    New Report Lower DL

    		  

    G

    G

    G

    G

    1

    KG

    0.001

    Where no conversion factor exists between the SVA.Unit Code (G) and the new SSA.Report Unit Code (KG), then return an error. In this case, we presume no error returns.

    Where a conversion factor exists between the previous SSA.Report Unit Code (G) and the new SSA.Report Unit Code (KG), then convert the Report Lower DL based on the conversion factor. In this case, the reportable detection limits convert.

    KG

    G

    KG

    G

    1

    KG

    0.001

    Where the SVA.Unit Code is the same as the new SSA.Report Unit Code, then do not validate the existence of a conversion factor. In this case, the units are the same.

    Where a conversion factor exists between the previous SSA.Report Unit Code (G) and the new SSA.Report Unit Code (KG), then convert the Report Lower DL based on the conversion factor. In this case, the reportable detection limits convert.

    KG

    G

    C

    C

    0.1

    F

    0.1

    Where no conversion factor exists between the SVA.Unit Code (G) and the new SSA.Report Unit Code (KG), then return an error. In this case, we presume an error is returned.

Maintaining a Sample Scheme Analyte's Invoicing Details

A sample scheme analyte's Invoiceable denotes whether the sample scheme analyte is included in invoice pricing when the sample, scheme and analyte are included in a job invoice.

A sample scheme analyte's Invoiceable defaults from the template sample scheme when a template sample is used to register a sample scheme, and from the scheme version when it is registered using a master scheme, but note that they are linked to new text entities containing the defaulted text.

Where a template sample was used to register the sample scheme analyte, then the Package Price Code, inherited from the template sample's Template Price Code, indicates that pricing of the sample scheme analyte is covered by package pricing, such that, it is not included in regular pricing of the scheme/analyte.

During invoicing, a sample scheme analyte's invoiceability is determined by whether the invoice sample scheme analyte's Invoiceable is selected. An invoice sample scheme analyte's Invoiceable defaults to the sample scheme analyte's Invoiceable.