StructureDefinition for Distance

<?xml version="1.0" encoding="UTF-8"?>

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Distance"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
       top;">
        <tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align:
         top">
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a> 
          </th> 
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a> 
          </th> 
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a> 
          </th> 
          <th class="hierarchy" style="width: 100px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a> 
          </th> 
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; Constraints</a> 
            <span style="float: right">
              <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">
                <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/> 
              </a> 
            </span> 
          </th> 
        </tr> 
        <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color:
         white">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(data:image/png;bas
          e64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCAYAAACg/LjIAAAAJUlEQVR4Xu3IIQEAAAgDsHd9/w4EQIOamFnaBgAA4M
          MKAACAKwNp30CqZFfFmwAAAABJRU5ErkJggg==)">
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: inherit"/> 
            <img alt="." class="hierarchy" src="data:(snipped in html view)" style="background-color: white; background-color: inherit" title="Data Type"/>  
            <a href="datatypes-definitions.html#Distance" title="Distance : A length - a value with a unit that is a physical distance.">Distance</a> 
          </td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="versions.html#std-process" style="padding-left: 3px; padding-right: 3px; border: 1px grey solid; font-weight: bold;
             color: black; background-color: #fff5e6" title="Standards Status = Trial Use">TU</a> 
          </td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px"/> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">
            <a href="datatypes.html#Quantity">Quantity</a> 
          </td> 
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0
           solid; padding:0px 4px 0px 4px">A length - a value with a unit that is a physical distance
            <br/>  Binding: 
            <a href="valueset-distance-units.html" title="Appropriate units for Distance.">Common UCUM Codes for Distance</a>  (
            <a href="terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value
             set if any of the codes within the value set can apply to the concept being communicated.
              If the value set does not cover the concept (based on human review), alternate
             codings (or, data type allowing, text) may be included instead.">Extensible</a> )
            <table class="grid">
              <tr> 
                <td style="font-size: 11px">
                  <b> Additional Bindings</b> 
                </td> 
                <td style="font-size: 11px">Purpose</td> 
              </tr> 
              <tr> 
                <td style="font-size: 11px">
                  <a href="valueset-all-distance-units.html">All UCUM Expression for Distance</a> 
                </td> 
                <td style="font-size: 11px">
                  <a href="valueset-additional-binding-purpose.html#additional-binding-purpose-maximum" title="A required binding, for use when the binding strength is 'extensible' or 'preferred'">Max Binding</a> 
                </td> 
              </tr> 
            </table> 
            <br/>  
            <span style="font-style: italic" title="dis-1">+ Rule: There SHALL be a code if there is a value and it SHALL be an expression
               of length.  If system is present, it SHALL be UCUM.</span> 
            <br/>  
            <br/>  Elements defined in Ancestors: 
            <a href="types.html#Element" title="Unique id for the element within a resource (for internal references). This may
             be any string value that does not contain spaces.">id</a> , 
            <a href="types.html#Element" title="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.">extension</a> , 
            <a href="datatypes.html#Quantity" title="The value of the measured amount. The value includes an implicit precision in the
             presentation of the value.">value</a> , 
            <a href="datatypes.html#Quantity" title="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 &quot;&lt;&quot; , then the real value is &lt; stated value.">comparator</a> , 
            <a href="datatypes.html#Quantity" title="A human-readable form of the unit.">unit</a> , 
            <a href="datatypes.html#Quantity" title="The identification of the system that provides the coded form of the unit.">system</a> , 
            <a href="datatypes.html#Quantity" title="A computer processable form of the unit in some unit representation system.">code</a> 
          </td> 
        </tr> 

        <tr> 
          <td class="hierarchy" colspan="5">
            <br/>  
            <a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format">
              <img alt="doco" src="data:(snipped in html view)" style="background-color: inherit"/>  Documentation for this format
            </a> 
          </td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use"/> 
  </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="has-units"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/Distance"/> 
  <version value="6.0.0-ballot2"/> 
  <name value="Distance"/> 
  <status value="draft"/> 
  <experimental value="false"/> 
  <date value="2024-11-20T21:23:48+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="Distance Type: A length - a value with a unit that is a physical distance."/> 
  <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="rim"/> 
    <uri value="http://hl7.org/v3"/> 
    <name value="RIM Mapping"/> 
  </mapping> 
  <mapping> 
    <identity value="v2"/> 
    <uri value="http://hl7.org/v2"/> 
    <name value="HL7 V2 Mapping"/> 
  </mapping> 
  <kind value="complex-type"/> 
  <abstract value="false"/> 
  <type value="Distance"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Quantity"/> 
  <derivation value="specialization"/> 
  <snapshot> 
    <element id="Distance">
      <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use"/> 
      </extension> 
      <path value="Distance"/> 
      <short value="A length - a value with a unit that is a physical distance"/> 
      <definition value="A length - a value with a unit that is a physical distance."/> 
      <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="Distance"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="dis-1"/> 
        <severity value="error"/> 
        <human value="There SHALL be a code if there is a value and it SHALL be an expression of length.
          If system is present, it SHALL be UCUM."/> 
        <expression value="(code.exists() or value.empty()) and (system.empty() or system = %ucum)"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Distance"/> 
      </constraint> 
      <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() &gt; 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> 
      <isModifier value="false"/> 
      <binding> 
        <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition">
          <valueMarkdown value="Appropriate units for Distance."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="DistanceUnits"/> 
        </extension> 
        <strength value="extensible"/> 
        <description value="Appropriate units for Distance."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/distance-units"/> 
        <additional> 
          <purpose value="maximum"/> 
          <valueSet value="http://hl7.org/fhir/ValueSet/all-distance-units"/> 
        </additional> 
      </binding> 
      <mapping> 
        <identity value="v2"/> 
        <map value="SN (see also Range) or CQ"/> 
      </mapping> 
      <mapping> 
        <identity value="rim"/> 
        <map value="PQ, IVL&lt;PQ&gt;, MO, CO, depending on the values"/> 
      </mapping> 
    </element> 
    <element id="Distance.id">
      <path value="Distance.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> 
      <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler
       magic (j)  -->
      <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="Distance.extension">
      <path value="Distance.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() &gt; 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="Distance.value">
      <path value="Distance.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() &gt; 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="Distance.comparator">
      <path value="Distance.comparator"/> 
      <short value="&lt; | &lt;= | &gt;= | &gt; | ad - how to understand the value"/> 
      <definition value="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 &quot;&lt;&quot; , then the real value is &lt; stated value."/> 
      <requirements value="Need a framework for handling measures where the value is &lt;5ug/L or &gt;400mg/L
       due to the limitations of measuring methodology."/> 
      <min value="0"/> 
      <max value="1"/> 
      <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() &gt; id.count())"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="true"/> 
      <isModifierReason value="This is labeled as &quot;Is Modifier&quot; 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/tools/StructureDefinition/binding-definition">
          <valueMarkdown value="How the Quantity should be understood and represented."/> 
        </extension> 
        <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="Distance.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="Distance.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() &gt; 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="Distance.system">
      <path value="Distance.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() &gt; 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="Distance.code">
      <extension url="http://hl7.org/fhir/tools/StructureDefinition/no-binding">
        <valueBoolean value="true"/> 
      </extension> 
      <path value="Distance.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() &gt; 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="Distance">
      <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use"/> 
      </extension> 
      <path value="Distance"/> 
      <short value="A length - a value with a unit that is a physical distance"/> 
      <definition value="A length - a value with a unit that is a physical distance."/> 
      <min value="0"/> 
      <max value="*"/> 
      <constraint> 
        <key value="dis-1"/> 
        <severity value="error"/> 
        <human value="There SHALL be a code if there is a value and it SHALL be an expression of length.
          If system is present, it SHALL be UCUM."/> 
        <expression value="(code.exists() or value.empty()) and (system.empty() or system = %ucum)"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Distance"/> 
      </constraint> 
      <binding> 
        <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition">
          <valueMarkdown value="Appropriate units for Distance."/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="DistanceUnits"/> 
        </extension> 
        <strength value="extensible"/> 
        <description value="Appropriate units for Distance."/> 
        <valueSet value="http://hl7.org/fhir/ValueSet/distance-units"/> 
        <additional> 
          <purpose value="maximum"/> 
          <valueSet value="http://hl7.org/fhir/ValueSet/all-distance-units"/> 
        </additional> 
      </binding> 
      <mapping> 
        <identity value="rim"/> 
        <map value="PQ"/> 
      </mapping> 
    </element> 
  </differential> 
</StructureDefinition>