INTEROPen CareConnect Base STU3 Implementation Guide
3.0.0 - CI Build
INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
Definitions for the CareConnect-Quantity-1 Profile.
| 1. Quantity | |
| Definition | 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() | (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()) |
| 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 |
| 3. Quantity.extension | |
| Definition | An Extension |
| Control | 0..* |
| Type | Extension |
| 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.extension:valueApproximation | |
| SliceName | valueApproximation |
| Definition | Value Approximation |
| Control | 0..1 |
| Type | Extension(Extension-CareConnect-ValueApproximation-1) (Extension Type: boolean) |
| 5. Quantity.value | |
| Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
| Control | 0..1 |
| Type | decimal |
| 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). |
| 6. Quantity.comparator | |
| Definition | 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..1 |
| Binding | How the Quantity should be understood and represented. The codes SHALL be taken from QuantityComparator |
| Type | code |
| Is Modifier | true |
| Requirements | Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
| Comments | This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
| Meaning if Missing | If there is no comparator, then there is no modification of the value |
| 7. Quantity.unit | |
| Definition | A human-readable form of the unit. |
| Control | 0..1 |
| Type | string |
| Requirements | There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms. |
| 8. Quantity.system | |
| Definition | The identification of the system that provides the coded form of the unit. |
| Control | 0..1 This element is affected by the following invariants: qty-3 |
| Type | uri |
| Requirements | Need to know the system that defines the coded form of the unit. |
| 9. Quantity.code | |
| Definition | A computer processable form of the unit in some unit representation system. |
| Control | 0..1 |
| Type | code |
| 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. |