Sample Test Type Standard Version Range in ESG data model

Ranges of values associated with a sample test type and how the results within those ranges should be interpreted and acted upon based on a specific standard version.

The intent is for this guideline table to contain non-overlapping values from 0 - infinity so that a single value delivered in a sample test type will have a single sample test type guideline to provide additional data on how to interpret the result.

Traits

This entity has the following traits:

is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/SampleTestTypeStandardVersionRangeIdattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"1.4.0"string

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Sampling & Reporting"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Type Standard Version Range
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRanges of values associated with a sample test type and how the results within those ranges should be interpreted and acted upon based on a specific standard version.

The intent is for this guideline table to contain non-overlapping values from 0 - infinity so that a single value delivered in a sample test type will have a single sample test type guideline to provide additional data on how to interpret the result.

entitya reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or re-states parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
SampleTestTypeId The unique identifier of a sample test type. SampleTestTypeStandardVersionRange
StandardId The unique identifier of a Standard. SampleTestTypeStandardVersionRange
StandardVersionId The unique identifier of a Standard Version. SampleTestTypeStandardVersionRange
SampleTestTypeStandardVersionPeriodStartDate The starting date of the period for the reading of the associated regulated substance. SampleTestTypeStandardVersionRange
SampleTestTypeStandardVersionRangeId AThe unique identifier of a sample test type range within a standard version. SampleTestTypeStandardVersionRange
MinimumReadingValue The minimum value for which this range is applicable. SampleTestTypeStandardVersionRange
MaximumReadingValue The maximum value for which this range is applicable. SampleTestTypeStandardVersionRange
SampleTestResultTypeId The unique identifier of a Sample Test Result Type. SampleTestTypeStandardVersionRange
SampleTestTypeStandardVersionRangeNote A note, comment or additional information regarding the Sample Test Type Standard Version Range. SampleTestTypeStandardVersionRange

SampleTestTypeId

The unique identifier of a sample test type.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameSample Test Type ID
descriptionThe unique identifier of a sample test type.
isPrimaryKeytrue
dataFormatint32

Traits

The SampleTestTypeId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/SampleTestTypeIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SampleTestTypeStandardVersion.cdm.json/SampleTestTypeStandardVersionSampleTestTypeId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a sample test type.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

StandardId

The unique identifier of a Standard.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameStandard ID
descriptionThe unique identifier of a Standard.
isPrimaryKeytrue
dataFormatint32

Traits

The StandardId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/StandardIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SampleTestTypeStandardVersion.cdm.json/SampleTestTypeStandardVersionStandardId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Standard.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

StandardVersionId

The unique identifier of a Standard Version.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameStandard Version ID
descriptionThe unique identifier of a Standard Version.
isPrimaryKeytrue
dataFormatint32

Traits

The StandardVersionId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/StandardVersionIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SampleTestTypeStandardVersion.cdm.json/SampleTestTypeStandardVersionStandardVersionId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Standard Version.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

SampleTestTypeStandardVersionPeriodStartDate

The starting date of the period for the reading of the associated regulated substance.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameSample Test Type Standard Version Period Start Date
descriptionThe starting date of the period for the reading of the associated regulated substance.
isPrimaryKeytrue
dataFormatdate

Traits

The SampleTestTypeStandardVersionPeriodStartDate attribute has the following traits:

is.dataFormat.date
means.measurement.date
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/SampleTestTypeStandardVersionPeriodStartDateattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SampleTestTypeStandardVersion.cdm.json/SampleTestTypeStandardVersionSampleTestTypeStandardVersionPeriodStartDate
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Type Standard Version Period Start Date
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe starting date of the period for the reading of the associated regulated substance.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.date

SampleTestTypeStandardVersionRangeId

AThe unique identifier of a sample test type range within a standard version.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameSample Test Type Standard Version Range ID
descriptionAThe unique identifier of a sample test type range within a standard version.
isPrimaryKeytrue
dataFormatint32

Traits

The SampleTestTypeStandardVersionRangeId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.identifiedBy
names a specific identity attribute to use with an entity

ParameterValueData typeExplanation
attributeSampleTestTypeStandardVersionRange/(resolvedAttributes)/SampleTestTypeStandardVersionRangeIdattribute

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Type Standard Version Range ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enAThe unique identifier of a sample test type range within a standard version.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

MinimumReadingValue

The minimum value for which this range is applicable.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameMinimum Reading Value
descriptionThe minimum value for which this range is applicable.
dataFormatdecimal

Traits

The MinimumReadingValue attribute has the following traits:

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe number of digits to the right of the decimal place

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enMinimum Reading Value
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe minimum value for which this range is applicable.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

MaximumReadingValue

The maximum value for which this range is applicable.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameMaximum Reading Value
descriptionThe maximum value for which this range is applicable.
dataFormatdecimal

Traits

The MaximumReadingValue attribute has the following traits:

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe number of digits to the right of the decimal place

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enMaximum Reading Value
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe maximum value for which this range is applicable.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

SampleTestResultTypeId

The unique identifier of a Sample Test Result Type.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameSample Test Result Type ID
descriptionThe unique identifier of a Sample Test Result Type.
dataFormatint32
isNullabletrue

Traits

The SampleTestResultTypeId attribute has the following traits:

is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.

is.dataFormat.numeric
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Result Type ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Sample Test Result Type.
entitya reference to the constant entity holding the list of localized text

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
SampleTestResultType.cdm.json/SampleTestResultTypeSampleTestResultTypeId
entitya reference to the constant entity holding the list of entity references

is.dataFormat.integer

SampleTestTypeStandardVersionRangeNote

A note, comment or additional information regarding the Sample Test Type Standard Version Range.
First included in: SampleTestTypeStandardVersionRange (this entity)

Properties

NameValue
displayNameSample Test Type Standard Version Range Note
descriptionA note, comment or additional information regarding the Sample Test Type Standard Version Range.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

The SampleTestTypeStandardVersionRangeNote attribute has the following traits:

is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object

is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enSample Test Type Standard Version Range Note
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enA note, comment or additional information regarding the Sample Test Type Standard Version Range.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object