Population of the CCSampleSchemeAnalyte DTO

The CCSampleSchemeAnalyte DTO is referenced when Creating Report Requests from Job Report Stakeholders, to place content into the output document as per the report template.

When an org-scope scheme version analyte is registered on an org-scope sample, then for the org-scope sample scheme analyte:

  • The master scheme is the org-scope scheme.
  • The scoped scheme is the org-scope scheme.

When an org-scope scheme version analyte is registered on a lab-scope sample, then for the lab-scope sample scheme analyte:

  • The master scheme is the org-scope scheme.
  • The scoped scheme is the enabled-scope scheme.

When a lab-scope scheme version analyte is registered on a lab-scope sample, then for the lab-scope sample scheme analyte:

  • The master scheme is the lab-scope scheme.
  • The scoped scheme is the lab-scope scheme.

For enabled-scope schemes, defaults originating from the master org-scope scheme version analyte are indicated.

Property Default

Org-scope sample with
org-scope analyte

Lab-scope sample with
enabled-scope analyte

Lab-scope sample with
lab-scope analyte

For identification:

 

 

 

 
  • id

Current entity's ID

 

 

 
  • isOrganisationScope

Indicates whether the entity has organisation scope

True

False

False
  • organisationCode

sample.organisationCode

Current organisation

Current organisation

Current organisation
  • laboratoryCode

sample.laboratoryCode

 

Current laboratory

Current laboratory
  • jobId
  • jobCode

The job code is a string containing the unique code assigned to the job.

job.id and code

 

 

 
  • sampleId
  • sampleCode

The sample code is a string containing the unique code assigned to the sample.

sample.id and code

 

 

 
  • sampleName

sample.name

 

 

 
  • clientSampleName

sample.clientSampleName

 

 

 
  • sourceSampleTemplateId
  • templateSampleCode

If registration of template sample added the sample scheme analyte, then set to the template sample.id and code

 

 

 
  • jobSchemeAnalyteId

jobSchemeAnalyte.id

 

 

 
  • sampleSchemeId

sampleScheme.id

 

 

 
  • schemeLaboratoryCode

Master scheme.laboratoryCode

Empty

Empty

Current laboratory's Code

  • schemeId
  • schemeCode

The scheme code is a string containing the unique code assigned to the scheme.

Master scheme.id and scoped scheme code

Displays org-scope

Displays org-scope

Displays lab-scope
  • isSchemeOrganisationScope

Indicates whether the master scheme has organisation scope

True

True

False
  • schemeVersionId
  • schemeVersion

The scheme version is a string containing the version number for the scheme for which sample scheme analytes were tested.

Master schemeVersionAnalyte.schemeVersionId and versionNumber

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteId
  • code

The analyte code is a string containing the unique code assigned to the analyte.

Master schemeVersionAnalyte.id and code

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteName

Master schemeVersionAnalyte.name

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteDescription

Master schemeVersionAnalyte.description

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteParentAnalyteId
  • schemeVersionAnalyteParentAnalyteCode

Master schemeVersionAnalyte.parentAnalyteId and parentAnalyteCode

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteIsMandatoryProfile

Master schemeVersionAnalyte.isMandatoryProfile

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteAutoRelease

Master schemeVersionAnalyte.autoRelease

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteAutoValidate

Master schemeVersionAnalyte.autoValidate

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteReportName

Master schemeVersionAnalyte.reportName

Displays org-scope

Displays org-scope

Displays lab-scope
  • schemeVersionAnalyteReportDescription

Master schemeVersionAnalyte.reportDescription

Displays org-scope

Displays org-scope

Displays lab-scope
  • registrationSequence

Numerical sequence of analyte within the sample scheme

 

 

 
  • profileSequence

Numerical sequence of sample within the job scheme analyte

 

 

 
  • creationDate
  • creationTime
  • creationUser

 

 

 

 
  • lastModDate
  • lastModTime
  • lastModUser

 

 

 

 

For registration flow:

 

 

 

 
  • isAddToAll

 

 

 

 
  • appliesToAllSamples

 

 

 

 
  • includeInAutoReg

 

 

 

 
  • includeInManualReg

 

 

 

 
  • defaultWorkflowStatus

 

 

 

 
  • status—Obsolete field.

 

 

 

 

For management:

 

 

 

 
  • requiredDate

sampleScheme.requiredDate

 

 

 
  • activatedUserId
  • activatedUserCode

 

 

 

 
  • lastActivatedDate

 

 

 

 
  • isWorkflowActive—No functional use in core CCLAS. This flag is taken from the master scheme version analyte.

Scoped schemeVersionAnalyte.isWorkflowActive

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • workflowStatus

Not Started

 

 

 
  • userWorkflowStatus

 

 

 

 

For pre-analysis:

 

 

 

 
  • isIncludeOnWorksheet

Scoped schemeVersionAnalyte.isIncludeOnWorksheet

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • holdingTime

Scoped schemeVersionAnalyte.holdingTime

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • warningDate

sample.sampledDate + sampleSchemeAnalyte.warningTime if sampleSchemeAnalyte.warningTime is defined, else set to sample.sampledDate + sampleScheme.warningTime if sampleScheme.warningTime is defined, else empty

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • expiryDate

sample.sampledDate + sampleSchemeAnalyte.holdingTime if sampleSchemeAnalyte.holdingTime is defined, else set to sample.sampledDate + sampleScheme.holdingTime if sampleScheme.holdingTime is defined, else empty

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • labBatchJobCode

 

 

 

 
  • labBatchSampleCode

 

 

 

 

For analysis:

 

 

 

 
  • spreadsheetFormula

Master schemeVersionAnalyte.spreadsheetFormula

Uses org-scope

Uses org-scope

Uses lab-scope
  • unitId
  • unitCode

The unit code is a string containing the unique code assigned to the analytical unit, and represents the unit of the analytical result.

Scoped schemeVersionAnalyte.unitId and unit.code

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • intLowerDetLimit

The internal lower detection limit is a numerical value of the lowest quantity of analytical substance that is detectable by the scheme, and is used to determine the internal detection limit status.

Scoped schemeVersionAnalyte.internalLowerDetectionLimit

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • isIntLowerLimCritical

Indicates whether a result that is below the internal lower detection limit causes the internal detection limit status to be set to indicate failure.

Scoped schemeVersionAnalyte.isInternalLowerLimitCritical

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • intUpperDetLimit

The internal upper detection limit is a numerical value of the highest quantity of analytical substance that is detectable by the scheme, and is used to determine the internal detection limit status.

Scoped schemeVersionAnalyte.internalUpperDetectionLimit

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • isIntUpperLimCritical

Indicates whether a result that is above the internal upper detection limit causes the internal detection limit status to be set to indicate failure.

Scoped schemeVersionAnalyte.isInternalUpperLimitCritical

Uses org-scope

Uses enabled-scope

Uses lab-scope

  • lowerTemplateSampleCode

 The template sample whose tests can be registered on the sample if the sample scheme analyte's Workflow Status is Check due to the result being above the Internal Upper DL and the Internal Lower DL Critical is selected.

Uses org-scope

Uses enabled-scope

Uses lab-scope

  • lowerTemplateSamplelabCode

        

  • upperTemplateSampleCode

 The template sample whose tests can be registered on the sample if the sample scheme analyte's Workflow Status is Check due to the result being below the Internal Upper DL and the Internal Upper DL Critical is selected.

Uses org-scope

Uses enabled-scope

Uses lab-scope

  • upperTemplateSamplelabCode

        
  • applicationName

 

 

 

 
  • latestReadingId

 

 

 

 
  • isLabBatchContext

 

 

 

 
  • isDoDataConvert

 

 

 

 
  • isUsedInAggregate

True

 

 

 
  • weight

 

 

 

 
  • volume

 

 

 

 
  • dilutionFactor

 

 

 

 
  • compositeCorrectionFactor

 

 

 

 
  • param1Name

 

 

 

 
  • param1Value

 

 

 

 
  • param2Name

 

 

 

 
  • param2Value

 

 

 

 
  • param3Name

 

 

 

 
  • param3Value

 

 

 

 
  • param4Name

 

 

 

 
  • param4Value

 

 

 

 
  • param5Name

 

 

 

 
  • param5Value

 

 

 

 
  • currentDataType

Scoped schemeVersionAnalyte.dataType

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • numericRawValue

The numeric raw value is the result of the sample scheme analyte, uncorrected for weight, volume, instrument factor and digestion, where the current data type is numeric or numeric only.

 

 

 
  • numericFinalValue

The numeric final value is the result of the sample scheme analyte where the current data type is numeric or numeric only.

 

 

 
  • booleanValue

The boolean value is the result of the sample scheme analyte where the current data type is boolean.

 

 

 
  • dateTimeValue

The date time value is the result of the sample scheme analyte where the current data type is date-time.

 

 

 
  • textValue

The text value is the result of the sample scheme analyte where the current data type is text.

 

 

 
  • image
  • imageFileId

The image is a graphics file holding the result of the sample scheme analyte where the current data type is image.

Where the current data type is not image, the image is a graphics file associated with the sample scheme analyte.

 

 

 
  • document
  • documentFileId

The document is a data file holding the result of the sample scheme analyte where the current data type is document.

Where the current data type is not document, the document is a data file associated with the sample scheme analyte.

 

 

 
  • isNotesAvailable

 

 

 

 
  • isQcActive—Indicates whether the sample scheme analyte undergoes QC assessment. Where the analyte does not undergo QC assessment, any QC statuses on related sample scheme analytes are set to Not Required.

Scoped schemeVersionAnalyte.isQcActive

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • intDetLimitStatus

Not Tested

 

 

 
  • limitStatus

Not Tested

 

 

 
  • precisionStatus

Not Tested

 

 

 
  • standardStatus

Not Tested

 

 

 
  • specificationStatus

Not Tested

 

 

 
  • compositeQcStatus

Not Tested

 

 

 
  • compositeSpecStatus

Not Tested

 

 

 
  • userQcStatus

 

 

 

 
  • qcIgnoredDate

 

 

 

 
  • qcIgnoredUserId
  • qcIgnoredUserCode

 

 

 

 
  • percentageDifference

 

 

 

 
  • recovery

The calculated recovery if the sample's primary or secondary analytical type is standard.

 

 

 
  • rpd

Where the sample's primary analytical type is duplicate or replicate, this is the calculated relative percentage difference between the result and the result in the original sample.

Where the sample's primary analytical type is blank, standard or spike, this is the calculated relative percentage difference between the result and the expected result of the substance.

 

 

 
  • startedDate

 

 

 

 
  • analysedDate

 

 

 

 
  • analysedByUserId
  • analysedByUserCode

 

 

 

 
  • isOverriddenAnalyseDate

 

 

 

 
  • releasedDate

 

 

 

 
  • releasedByUserId
  • releasedByUserCode

 

 

 

 

For validation:

 

 

 

 
  • validatedDate

 

 

 

 
  • validationUserId
  • validationUserCode

 

 

 

 

For reporting:

 

 

 

 
  • isReportable

Indicates the default setting for a sample scheme analyte's reportability within a report request.

Scoped schemeVersionAnalyte.isReportable

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • reportSequence

The report sequence is the default setting for a sample scheme analyte's report sequence within a report request, and is a numerical value used to place the analyte on the report in a sequence that is different to the result set record sequence.

Master schemeVersionAnalyte.reportSequence

Uses org-scope

Uses org-scope scheme

This differs to the SS that uses this field from enabled-scope

Uses lab-scope
  • reportTextId
  • reportText

 

 

 

 
  • reportUnitId
  • reportUnitCode

The report unit code is the default setting for a sample scheme analyte's report unit code within a report request, and is a string containing the unique code assigned to the reportable analytical unit.

Scoped schemeVersionAnalyte.reportUnitId and unit.code

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • roundingTableId
  • roundingTableCode

The rounding table code is the default setting for a sample scheme analyte's rounding table code within a report request, and is a string containing the code of the rounding table used to apply rounding to the results presented in the report.

Scoped schemeVersionAnalyte.roundingTableId and roundingTable.code

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • repLowerDetLimit

The report lower detection limit is the default setting for a sample scheme analyte's report lower detection limit within a report request, and is a numerical value of the lowest quantity of analytical substance that is detectable by the reported scheme.

Scoped schemeVersionAnalyte.reportLowerDetectionLimit

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • repUpperDetLimit

The report upper detection limit is the default setting for a sample scheme analyte's report upper detection limit within a report request, and is a numerical value of the highest quantity of analytical substance that is detectable by the reported scheme.

Scoped schemeVersionAnalyte.reportUpperDetectionLimit

Uses org-scope

Uses enabled-scope

Uses lab-scope
  • correctedIntLowerDetLimit

 

 

 

 
  • correctedIntUpperDetLimit

 

 

 

 
  • formattedFinalValue

The formatted final value is a string containing the sample scheme analyte result, with any required rounding and formatting applied.

If a certificate report is generated with a Report Status Type of Final and the TRANSFER_RRSSA_REPORT_DATA_TO_SSA application preference is checked, when a result is rounded, then sample scheme analyte's Formatted Final Value, Rep Lower Det Limit, Rep Upper Det Limit and Uncertainty Value are set to those on the report request sample scheme analyte.

 

 

 
  • uncertaintyValue

The uncertainty value is a string containing the calculated uncertainty of the sample scheme analyte result, as a percentage indicating the confidence of the result.

If a certificate report is generated with a Report Status Type of Final and the TRANSFER_RRSSA_REPORT_DATA_TO_SSA application preference is checked, when a result is rounded, then sample scheme analyte's Formatted Final Value, Rep Lower Det Limit, Rep Upper Det Limit and Uncertainty Value are set to those on the report request sample scheme analyte.

 

 

 
  • formattedReportLowerDL

The formatted report lower detection limit is a string containing the reported lower detection limit, with any required rounding and formatting applied.

If a certificate report is generated with a Report Status Type of Final and the TRANSFER_RRSSA_REPORT_DATA_TO_SSA application preference is checked, when a result is rounded, then sample scheme analyte's Formatted Final Value, Rep Lower Det Limit, Rep Upper Det Limit and Uncertainty Value are set to those on the report request sample scheme analyte.

 

 

 
  • formattedReportUpperDL

The formatted report upper detection limit is a string containing the reported upper detection limit, with any required rounding and formatting applied.

If a certificate report is generated with a Report Status Type of Final and the TRANSFER_RRSSA_REPORT_DATA_TO_SSA application preference is checked, when a result is rounded, then sample scheme analyte's Formatted Final Value, Rep Lower Det Limit, Rep Upper Det Limit and Uncertainty Value are set to those on the report request sample scheme analyte.

 

 

 
  • firstReportedDate

 

 

 

 
  • lastReportedDate

 

 

 

 

For invoicing:

 

 

 

 
  • isInvoiceable—Obsolete field. A job invoice sample's isInvoiceable defaults to the sample's isInvoiceable, and the job invoice scheme's isInvoiceable defaults to the scheme version's isInvoiceable. These two flags determine the invoiceability of the sample scheme in the job invoice.

Master schemeVersionAnalyte.isInvoiceable

Uses org-scope

Uses org-scope scheme

This differs to the SS that uses this field from enabled-scope

Uses lab-scope
  • priceCodeId
  • priceItem—Obsolete fields. The price code on the job scheme analyte is used by the pricing engine.

 

 

 

 
  • packagePriceCodeLabCode

Where the package price code is org-scope then left empty, where lab-scope then set to the current laboratory

 

 

 
  • packagePriceCode

If registration of template sample added the sample scheme analyte, then set to the template sample.templatePriceCode

 

 

 
  • lastInvoicedDate