This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw XML (canonical form + also see XML Format Specification)
StructureDefinition for SimpleQuantity
<?xml version="1.0" encoding="UTF-8"?> <StructureDefinition xmlns="http://hl7.org/fhir"> <id value="SimpleQuantity"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2> Datatype SimpleQuantity</h2> <p> A fixed quantity (no comparator)</p> <h3> Rule</h3> <p> The comparator is not used on a SimpleQuantity</p> <p> Expression:</p> <blockquote> <pre> comparator.empty()</pre> </blockquote> </div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="has-range"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="is-continuous"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="can-bind"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> <valueCode value="has-units"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="fhir"/> </extension> <url value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/> <version value="6.0.0-ballot2"/> <name value="SimpleQuantity"/> <status value="active"/> <experimental value="false"/> <date value="2024-11-05T17:55:42+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> </contact> <contact> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="A fixed quantity (no comparator)"/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <fhirVersion value="6.0.0-ballot2"/> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 V2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <kind value="complex-type"/> <abstract value="false"/> <type value="Quantity"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Quantity"/> <derivation value="constraint"/> <snapshot> <element id="Quantity"> <path value="Quantity"/> <short value="A fixed quantity (no comparator)"/> <definition value="The comparator is not used on a SimpleQuantity"/> <comment value="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."/> <min value="0"/> <max value="*"/> <base> <path value="Quantity"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <constraint> <key value="qty-3"/> <severity value="error"/> <human value="If a code for the unit is present, the system SHALL also be present"/> <expression value="code.empty() or system.exists()"/> <source value="http://hl7.org/fhir/StructureDefinition/Quantity"/> </constraint> <constraint> <key value="sqty-1"/> <severity value="error"/> <human value="The comparator is not used on a SimpleQuantity"/> <expression value="comparator.empty()"/> </constraint> <isModifier value="false"/> <mapping> <identity value="rim"/> <map value="n/a,PQ, IVL<PQ>, MO, CO, depending on the values"/> </mapping> <mapping> <identity value="v2"/> <map value="SN (see also Range) or CQ"/> </mapping> </element> <element id="Quantity.id"> <path value="Quantity.id"/> <representation value="xmlAttr"/> <short value="Unique id for inter-element referencing"/> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="id"/> </extension> <code value="http://hl7.org/fhirpath/System.String"/> </type> <condition value="ele-1"/> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Quantity.extension"> <path value="Quantity.extension"/> <slicing> <discriminator> <type value="value"/> <path value="url"/> </discriminator> <description value="Extensions are always sliced by (at least) url"/> <rules value="open"/> </slicing> <short value="Additional content defined by implementations"/> <definition value="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 managable, 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."/> <comment value="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."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Quantity.value"> <path value="Quantity.value"/> <short value="Numerical value (with implicit precision)"/> <definition value="The value of the measured amount. The value includes an implicit precision in the presentation of the value."/> <comment value="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)."/> <requirements value="Precision is handled implicitly in almost all cases of measurement."/> <min value="0"/> <max value="1"/> <base> <path value="Quantity.value"/> <min value="0"/> <max value="1"/> </base> <type> <code value="decimal"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="SN.2 / CQ - N/A"/> </mapping> <mapping> <identity value="rim"/> <map value="PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"/> </mapping> </element> <element id="Quantity.comparator"> <path value="Quantity.comparator"/> <short value="< | <= | >= | > | ad - how to understand the value"/> <definition value="Not allowed to be used in this context"/> <requirements value="Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology."/> <min value="0"/> <max value="0"/> <base> <path value="Quantity.comparator"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <meaningWhenMissing value="If there is no comparator, then there is no modification of the value"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="true"/> <isModifierReason value="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"/> <isSummary value="false"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="QuantityComparator"/> </extension> <strength value="required"/> <description value="How the Quantity should be understood and represented."/> <valueSet value="http://hl7.org/fhir/ValueSet/quantity-comparator|6.0.0-ballot2"/> </binding> <mapping> <identity value="v2"/> <map value="SN.1 / CQ.1"/> </mapping> <mapping> <identity value="rim"/> <map value="IVL properties"/> </mapping> </element> <element id="Quantity.unit"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true"/> </extension> <path value="Quantity.unit"/> <short value="Unit representation"/> <definition value="A human-readable form of the unit."/> <requirements value="There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms."/> <min value="0"/> <max value="1"/> <base> <path value="Quantity.unit"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="(see OBX.6 etc.) / CQ.2"/> </mapping> <mapping> <identity value="rim"/> <map value="PQ.unit"/> </mapping> </element> <element id="Quantity.system"> <path value="Quantity.system"/> <short value="System that defines coded unit form"/> <definition value="The identification of the system that provides the coded form of the unit."/> <requirements value="Need to know the system that defines the coded form of the unit."/> <min value="0"/> <max value="1"/> <base> <path value="Quantity.system"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <condition value="qty-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="(see OBX.6 etc.) / CQ.2"/> </mapping> <mapping> <identity value="rim"/> <map value="CO.codeSystem, PQ.translation.codeSystem"/> </mapping> </element> <element id="Quantity.code"> <path value="Quantity.code"/> <short value="Coded form of the unit"/> <definition value="A computer processable form of the unit in some unit representation system."/> <comment value="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."/> <requirements value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Quantity.code"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <condition value="qty-3"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() or (children().count() > id.count())"/> <source value="http://hl7.org/fhir/StructureDefinition/Element"/> </constraint> <isModifier value="false"/> <isSummary value="false"/> <mapping> <identity value="v2"/> <map value="(see OBX.6 etc.) / CQ.2"/> </mapping> <mapping> <identity value="rim"/> <map value="PQ.code, MO.currency, PQ.translation.code"/> </mapping> </element> </snapshot> <differential> <element id="Quantity"> <path value="Quantity"/> <short value="A fixed quantity (no comparator)"/> <definition value="The comparator is not used on a SimpleQuantity"/> <min value="0"/> <max value="*"/> <constraint> <key value="sqty-1"/> <severity value="error"/> <human value="The comparator is not used on a SimpleQuantity"/> <expression value="comparator.empty()"/> </constraint> <isModifier value="false"/> </element> <element id="Quantity.comparator"> <path value="Quantity.comparator"/> <definition value="Not allowed to be used in this context"/> <max value="0"/> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Tue, Nov 5, 2024 18:01+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change