Maintaining Tests for a Report Request

• Maintaining Tests for a Report Request
  • Overview
    • Maintaining a Report Request Sample Scheme's Reporting Units
    • Maintaining a Report Request Sample Scheme Analyte's Reporting Details
      • Maintaining a Report Request Sample Scheme Analyte's Reporting Details

Overview

As jobs and samples are added or removed from a report request, the following entities are maintained:

• Report request samples
• Report request schemes
• Report request scheme analytes
• Report request sample schemes
• Report request sample scheme analytes.

When a job is added to a report request:

• All unknown samples are added to the report request. A report request sample's Reportable flag defaults from the sample.
• All QC samples where the sample is Reportable are added to the report request, such that, a report request QC sample's Reportable flag defaults from the sample.

Whilst a report request can go across multiple jobs and samples, and can contain multiple schemes and analytes, only one version of a scheme can be added to it.

Various attributes of a report request scheme default from the job scheme, the master scheme or the scheme version, and the various attributes of a report request scheme analyte default from the job scheme analyte or the master scheme version analyte. Refer to the Effect of Scheme Scope when Creating a Report Request.

Maintaining a Report Request Sample Scheme's Reporting Units

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.
SV or Template SS Report Footer Text	SS Report Footer Text		Can be included in the report template for informational or reporting purposes.
SV or Template SS Results Header Text	SS Results Header Text		Can be included in the report template for informational or reporting purposes.

Maintaining a Report Request Sample Scheme Analyte's Reporting Details

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.
SVA or Template SSA Report Footer Text	SSA Report Footer Text		Can be included in the report template for informational or reporting purposes.
SVA or Template SSA Results Header Text	SSA Results Header Text		Can be included in the report template for informational or reporting purposes.

Maintaining a Report Request 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.

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 report request sample scheme analyte in two ways, by:

• Changing reporting details directly in the Tests grid in the CCRPTR—Report Request Detail and CCRPTRMULTIEDIT—Report Request Sample Multiple Edit Detail screens.

  The problem with this approach is, 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 report request 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 report request sample scheme analyte reporting units

  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 report request 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 report request 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 report request 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 report request 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 report request 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	RRSSA	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 RRSSA.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 RRSSA.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 RRSSA.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 RRSSA.Report Unit Code (G) and the new RRSSA.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 RRSSA.Report Unit Code (KG), then return an error. In this case, we presume an error is returned.