• No results found

Dictionary Entry Name Rate Type

5 Core Data Types

5.16 Quantity Type

5.17.2 Dictionary Entry Name Rate Type

5.17.2

Dictionary Entry Name

Rate. Type

5.17.3

Definition

A rate is a quantity, amount, frequency, or dimensionless factor, measured against an independent base unit, expressed as a quotient. 5.17.4

Representation Term

Rate

5.17.5

Remarks

5.17.6

Usage Guidance

Rate. Type is used to represent the numerical quotient resulting from a comparison of two independent things such as a quantity meas- ured with respect to another measured quantity such as a rate of speed, a measure of a part with respect to a whole - a proportion such as the mortality rate, a tax rate, the cost per unit of a commodity or service or a charge or payment calculated in relation to a particular sum or quantity such as interest rates. The quotient is calculated by taking into account the Rate. Multiplier. Value and Rate. Base Multiplier. Val- ue supplementary components that affect the unit codes used at the numerator and the denominator. For example, if a unit of measure was expressed as hour, when what was needed was 1/1000 of an hour, the multiplier value would be .001. Conversely, if a unit of meas- ure was expressed as hour, when what was needed was hundreds of hours; the multiplier value would be 100. The input of positive and negative numbers is possible. A minus sign (-) must precede a negative number. A plus sign (+) may precede a positive number.

Rate. Type should not be confused with Percentage Type for percentages, Ratio. Type for ratios, or Measure. Type for measures – de- pending on how the measure was obtained and what is the intended use. However, it is acceptable to use Rate. Type for cases where the business requirements cannot be restricted to these sub-cases and require the flexibility of Rate. Type. For example Interest. Rate may, depending on the business context be expressed in percent such as per thousand or per million.

Core Components Data Type Catalogue Version 3.1 Page 74 of 121 5.17.7

Rate. Type Content Component

Dictionary Entry Name Data Type Term Property Term Allowed Primitives Cardinality Definition Usage Rules Unique Identifier

Rate. Content Ratio Content Decimal Double Float Integer

1..1 The numerical value of the rate. UNDTWERO12

5.17.8

Rate. Type Supplementary Components

Dictionary Entry Name Data Type Term Property Term

Representation Term

Allowed Primitives

Cardinality Definition Usage Rules Unique Identifier

Comments

Rate. Multiplier. Value Rate Multiplier Value Decimal Double Float Integer

0..1 The multiplier of the Rate. Unit. Code or Rate. Currency. Code

UNDT0123EW Default value = 1

Rate. Unit. Code Rate Unit Code Normalized String String Token

0..1 The unit of measure of the numerator UNDT4862G1 UNDTQAZ8XC UNDTRTB546

The primitive is specified by the

Code List

Rate. Currency. Code Rate Currency Code Normalized String String Token

0..1 The currency of the numerator UNDTQAZ8XC

UNDT5420SS UNDTRTB546

The primitive is specified by the

Code List

Rate. Base Multiplier. Value Rate Base Multiplier Value Decimal Double Float Integer

0..1 The multiplier of the Rate. Base Unit. Code or Rate. Base Currency. Code

UNDT0123EW Default value = 1

Rate. Base Unit. Code Rate Base Unit Code Normalized String String Token

0..1 The unit of measure of the denominator UNDT4862G1

UNDT7B6N33 UNDTRTB546

The primitive is specified by the

Code List

Rate. Base Currency. Code Rate Base Currency Code Normalized String String Token

0..1 The currency of the denominator UNDT7B6N33 UNDT5420SS UNDTRTB546

The primitive is specified by the

Core Components Data Type Catalogue Version 3.1 Page 75 of 121 5.17.9

Core Value Domains

5.17.9.1 Rate. Content

The allowed Rate. Content core value domains consist of the following primitives:

Primitive Core Value Domain Default Indicator

Decimal True

Double False

Float False

Integer False

5.17.9.2 Rate. Multiplier. Value

The allowed Rate. Multiplier. Value core value domains consist of the following primitives:

Primitive Core Value Domain Default Indicator Core Value Domain Default Value

Decimal True 1

Double False 1

Float False 1

Integer False 1

5.17.9.3 Rate. Unit. Code

The allowed Rate. Unit. Code core value domains consist of the following code lists: a. UN/CEFACT Codes for Units of Measure Used in International Trade

Code List ID [1..1] Version ID [1..1] Agency ID [1..1]

Allowed Primitives Modification Allowed Indicator [1..1]

Core Value Domain Default Indicator

6Recommendation20 20086 6 Token False True

5.17.9.4 Rate. Currency. Code

The allowed Rate. Currency. Code core value domains consist of the following code lists: a. ISO Codes for the representation of currencies and funds

Code List ID [1..1] Version ID [1..1] Agency ID [1..1]

Allowed Primitives Modification Allowed Indicator [1..1]

Core Value Domain Default Indicator

Core Components Data Type Catalogue Version 3.1 Page 76 of 121 5.17.9.5 Rate. Base Multiplier. Value

The allowed Rate. Base Multiplier. Value core value domains consist of the following primitives:

Primitive Core Value Domain Default Indicator Core Value Domain Default Value

Decimal True 1

Double False 1

Float False 1

Integer False 1

5.17.9.6 Rate. Base Unit. Code

The allowed Rate. Base Unit. Code core value domains consist of the following code lists: a. UN/CEFACT Codes for Units of Measure Used in International Trade

Code List ID [1..1] Version ID [1..1] Agency ID [1..1]

Allowed Primitives Modification Allowed Indicator [1..1]

Core Value Domain Default Indicator

6Recommendation20 20086 6 Token False True

5.17.9.7 Rate. Base Currency. Code

The allowed Rate. Base Currency. Code core value domains consist of the following code lists a. ISO Codes for the representation of currencies and funds

Code List ID [1..1] Version ID [0..1] Agency ID [0..1]

Allowed Primitives Modification Allowed Indicator [1..1]

Core Value Domain Default Indicator

Core Components Data Type Catalogue Version 3.1 Page 77 of 121

Related documents