Maintaining Samples for a Report Request

Overview

A report request can contain multiple samples, across multiple jobs. After a report request is created, other samples can be added to it to add samples and tests to the report request, or samples removed from it.

A sample cannot be added where it contains a sample scheme linked to a scheme version where the scheme is already on the report request for a different scheme version.

Process

Adding Samples to a Report Request

Samples in a report request are maintained, and samples are added to a report request, using the CRPTR—Report Request application.

Maintain samples for a report request

When the Samples tab is selected in the CCRPTR—Report Request Detail screen, then the AUTO_RETRIEVE_ALL_REP_REQ_SAMPLES application preference controls whether all samples are retrieved automatically from the server and displayed in the grid:

If enabled, then paging is turned off and all samples are retrieved and loaded in the grid. Enabling this preference is useful to retrieve all report request samples from the server prior to performing multiple sample editing, otherwise only the first fifty samples are retrieved by default.

If disabled, then only the first fifty samples are retrieved by default, and more are retrieved as the grid is navigated, or Grid Retrieve All Records is selected to retrieve all report request samples from the server.

Set the AUTO_RETRIEVE_ALL_REP_REQ_SAMPLES application preference

When searching for samples to add to a report request:

When a lab-scope sample scheme is created using an enabled-scope scheme, then the sample is searchable by setting the Scheme Code search criteria on the Analysis Criteria tab either to the org-scope or enabled-scope scheme code. Both codes would appear in the drop-down list, and be the same code, but each scheme's name may be different.
The available biofields for the Biofield Code search criteria on the Biofields tab are filtered by those with org-scope that have either no line of business defined, or a line of business matching one of the laboratory's lines of business, or by those with lab-scope.
Cancelled samples are excluded by default in search results. To return cancelled samples in the search results set, include Cancelled in the Workflow Status criteria and select Include Cancelled Samples. Where selected, then the Job Cancelled date range criteria becomes available on the Sample Dates tab. Where cleared, then any selection of Cancelled in the Workflow Status criteria is ignored. Refer to Cancelling Jobs for limitations placed on cancelled jobs and samples.

When adding samples to a report request:

A sample cannot be added where it contains a sample scheme linked to a scheme version where the scheme is already on the report request for a different scheme version.
Where a cancelled sample is selected for adding to a report request, the cancelled job and the cancelled sample is added as per normal. Note, however, that report documents cannot be generated for a report request where there is one or more cancelled jobs in the report request.
The samples are added to the report request in the order in which they were selected on the search results grid in the CCRPTRSAMP—Search Sample screen.
Newly added report request samples inherit their Reportable flag from the sample.
A report request sample's Reportable flag is set from the sample based on the type of report request:
- For a labels report request, a report request sample's Reportable flag defaults to the sample's Generate Label flag.
- For a paperwork report request, a report request sample's Reportable flag defaults to the sample's Generate Paperwork flag.
- For a certificate report request ,a report request sample's Reportable flag defaults to the sample's Reportable flag.
Only the tests in the added samples are brought into the report request.
All schemes and analytes are added to the report request, as report request schemes and report request scheme analytes.

Refer to Maintaining Tests for a Report Request.

As 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.

Adding Related Laboratory Batch QC Samples to a Report Request

Where a sample has a related scheme version analyte analysed as part of a laboratory batch job, it is often a requirement to include QC samples from the laboratory batch in the certificate report.

If the QCSAMPLE_REPORTABLE application preference is defined and contains a comma-separated list of analytical types of REP, BLK, STD and/or SPK, when batch QC samples are added to a report request for a production job using the Add Batch QC service, for each laboratory batch job associated with a sample scheme analyte in the report request, then samples with a Primary Analytical Type of Replicate, Blank, Standard and/or Spike are brought into the report request. If the string is empty (default on deploy), then all types of QC samples are brought in to the report request.

Example:

Production job JOB1 contains:

Sample1..10	Sch1
	Cu	LB100
	Pb	LB100
	Zn	LB121

and laboratory batch job LB100 contains:

Sample1	Sch1	(Cu, Pb)
STD	Sch1	(Cu, Pb)
Sample2	Sch1	(Cu, Pb)
BLK	Sch1	(Cu, Pb)
Sample3	Sch1	(Cu, Pb)
SPK Sample3	Sch1	(Cu, Pb)
Sample4	Sch1	(Cu, Pb)
Sample5	Sch1	(Cu, Pb)
REP Sample5	Sch1	(Cu, Pb)
Sample6..10	Sch1	(Cu, Pb)
REP Sample6	Sch1	(Cu, Pb)
SPK Sample8	Sch1	(Cu, Pb)

and the report request contains:

RR	RRScheme	RRSchemeAnalyte	RRSample	RRSampleScheme	RRSampleSchemeAnalyte
Job1	Sch1	(Cu, Pb)	Sample1..5	Sch1	(Cu, Pb)

and the report request contains:

RR	RRScheme	RRSchemeAnalyte	RRSample	RRSampleScheme	RRSampleSchemeAnalyte
Job1	Sch1	(Cu, Pb)	Sample1..5	Sch1	(Cu, Pb)
LB100	Sch1	(Cu, Pb)	STD	Sch1	(Cu, Pb)
			BLK	Sch1	(Cu, Pb)
			SPK Sample3	Sch1	(Cu, Pb)
			REP Sample5	Sch1	(Cu, Pb)

Re-sequencing Samples in a Report Request

Job reordering does not re-order the samples within those jobs. However, sample order within the report request can be changed on the Samples tab to then affect the order of samples in the reportable result sets.

Re-sequence samples in a report request

Changing the Reportability of Report Request Sample

The reportability of samples in a report request can be toggled, as per the requirements for the report.

Update the reportability of a report request sample

When a report request job's Reportable flag is updated, then the reportability is cascaded down to the related report request samples, report request sample schemes and report request sample scheme analytes. Refer to Maintaining Tests for a Report Request.

Use this activity to update the reporting specification for a report request sample.

Updating Report Details for Multiple Samples in a Report Request

When report details for multiple samples need to be updated, this can be done in one pass.

Update report details for multiple report request samples

When a report request scheme's Reportable flag is updated, then the reportability is cascaded down to the related report request scheme analytes, report request sample schemes and report request sample scheme analytes.

When a report request scheme analyte's Reportable flag is updated, then the reportability is cascaded down to the related report request sample scheme analytes.

Refer to Maintaining Tests for a Report Request.

Updating the Reporting Specification for a Report Request Sample

Update the reporting specification for a report request sample