Range
A minimum and a maximum Quantity, with a flag for whether the range is approximate.
- Kind
- Concrete class
- Attributes
- 6, 5 required
- NCI code
- C38013
Official definition
An expression that defines the lower and upper limits of a variation.
Inheritance
Range is a kind of QuantityRange and inherits its attributes. Wherever the model asks for a QuantityRange, a Range can be used.
Attributes
6 attributes, 5 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file.Inherited from QuantityRange |
| minValuerequired | Quantity | cardinality 1 | The smallest value in quantity or degree in a set of values. |
| maxValuerequired | Quantity | cardinality 1 | The largest value in quantity or degree in a set of values. |
| isApproximaterequired | boolean | cardinality 1 | An indication as to whether the value range is almost, but not quite, exact. |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model. |
Smallest valid Range
The attributes a JSON file must carry for a Range, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.
Range, required attributes only
{
"id": "Range_1",
"minValue": Quantity,
"maxValue": Quantity,
"isApproximate": boolean,
"instanceType": "Range"
}
Where Range is used
These classes hold or point to a Range.
- ExtensionAttribute.valueRangenested
- PopulationDefinition.plannedAgenested
Example
A Range from the example study. Coded values are shortened to one line.
Range_1
{
"id": "Range_1",
"minValue": {
"id": "Quantity_5",
"value": 18,
"unit": { "standardCode": { "code": "C29848", "decode": "Year", … }, … },
"instanceType": "Quantity"
},
"maxValue": {
"id": "Quantity_6",
"value": 75,
"unit": { "standardCode": { "code": "C29848", "decode": "Year", … }, … },
"instanceType": "Quantity"
},
"isApproximate": false,
"instanceType": "Range"
}
Related classes
Other classes in codes, quantities and extensions: