CH EMED (R4)
4.0.0-ballot - ballot
CH EMED (R4)
4.0.0-ballot - ballot
This page is part of the CH EMED (R4) (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
| Active as of 2021-02-11 |
Definitions for the ch-emed-quantity data type profile.
Guidance on how to interpret the contents of this table can be found here.
| 1. Quantity | |
| 2. Quantity.value | |
| Control | 10..1 |
| 3. Quantity.unit | |
| Control | 10..1 |
| 4. Quantity.system | |
| Control | 10..1 |
| 5. Quantity.code | |
| Definition | Units of Presentation A computer processable form of the unit in some unit representation system. |
| Control | 10..1 |
| Binding | The codes SHALL be taken from UnitCodeFor codes, see (unbound) The coded unit used describing the quantity |
Guidance on how to interpret the contents of this table can be found here.
| 1. Quantity | |||
| Definition | The comparator is not used on a SimpleQuantity A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. | ||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists()) sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty()) | ||
| 2. Quantity.value | |||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
| Control | 10..1 | ||
| Type | decimal | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 3. Quantity.comparator | |||
| Definition | Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. | ||
| Control | 0..01 | ||
| Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented. | ||
| Type | code | ||
| Is Modifier | true | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 4. Quantity.unit | |||
| Definition | A human-readable form of the unit. | ||
| Control | 10..1 | ||
| Type | string | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Obligations |
| ||
| Summary | true | ||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 5. Quantity.system | |||
| Definition | The identification of the system that provides the coded form of the unit. | ||
| Control | 10..1 This element is affected by the following invariants: qty-3 | ||
| Type | uri | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need to know the system that defines the coded form of the unit. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 6. Quantity.code | |||
| Definition | Units of Presentation A computer processable form of the unit in some unit representation system. | ||
| Control | 10..1 | ||
| Binding | The codes SHALL be taken from UnitCodeFor codes, see (unbound) The coded unit used describing the quantity | ||
| Type | code | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
Guidance on how to interpret the contents of this table can be found here.
| 1. Quantity | |||
| Definition | The comparator is not used on a SimpleQuantity | ||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| 2. Quantity.id | |||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Control | 0..1 | ||
| Type | string | ||
| XML Representation | In the XML format, this property is represented as an attribute. | ||
| Summary | false | ||
| 3. Quantity.extension | |||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Control | 0..* | ||
| Type | Extension | ||
| Summary | false | ||
| Alternate Names | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||
| Slicing | This element introduces a set of slices on Quantity.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||
| 4. Quantity.value | |||
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. | ||
| Control | 1..1 | ||
| Type | decimal | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Precision is handled implicitly in almost all cases of measurement. | ||
| Comments | The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books). | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 5. Quantity.comparator | |||
| Definition | Not allowed to be used in this context | ||
| Control | 0..0 | ||
| Binding | The codes SHALL be taken from QuantityComparator How the Quantity should be understood and represented | ||
| Type | code | ||
| Is Modifier | true | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. | ||
| Meaning if Missing | If there is no comparator, then there is no modification of the value | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 6. Quantity.unit | |||
| Definition | A human-readable form of the unit. | ||
| Control | 1..1 | ||
| Type | string | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Obligations |
| ||
| Summary | true | ||
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 7. Quantity.system | |||
| Definition | The identification of the system that provides the coded form of the unit. | ||
| Control | 1..1 This element is affected by the following invariants: qty-3 | ||
| Type | uri | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need to know the system that defines the coded form of the unit. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||
| 8. Quantity.code | |||
| Definition | Units of Presentation | ||
| Control | 1..1 | ||
| Binding | The codes SHALL be taken from UnitCode The coded unit used describing the quantity | ||
| Type | code | ||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||
| Summary | true | ||
| Requirements | Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest. | ||
| Comments | The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system. | ||
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||