DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Range.profile.xml

Raw XML (canonical form)

StructureDefinition for Range

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Range"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <table border="0" cellpadding="0" cellspacing="0" style="border: 0px; 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; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="The logical name of the element">Name</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Information about the use of the element">Flags</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a>
          </th>
          <th class="hierarchy" style="width: 100px">
            <a href="formats.html#table" title="Reference to the type of the element">Type</a>
          </th>
          <th class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="formats.html#table" title="Additional information about the element">Description &amp; Constraints</a>
            <span style="float: right">
              <a href="formats.html#table" title="Legend for this format">
                <img alt="doco" src="help16.png" style="background-color: inherit"/>
              </a>
            </span>
          </th>
        </tr>
        <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px;
           white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA
          YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5
          CYII=)">
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAMQfAOvGUf7ztuvPMf/78/fkl/Pbg+u8Rvjqteu2Pf3zxPz36Pz0z+vTmPzurPvuw
            /npofbjquvNefHVduuyN+uuMu3Oafbgjfnqvf/3zv/3xevPi+vRjP/20/bmsP///////yH5BAEAAB8ALAAAAAAQABAAAAV24CeOZG
            mepqeqqOgxjBZFa+19r4ftWQUAgqDgltthMshMIJAZ4jYDHsBARSAmFOJvq+g6HIdEFgcYmBWNxoNAsDjGHgBnmV5bCoUDHLBIq9s
            FEhIdcAYJdYASFRUQhQkLCwkOFwcdEBAXhVabE52ecDahKy0oIQA7" style="background-color: white; background-color: inherit" title="Element"/> 
            <a href="datatypes-definitions.html#Range" title="Range : A set of ordered Quantities defined by a low and high limit.">Range</a>
            <a name="Range"> </a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <span title="This element is included in summaries">Σ </span>
            <span title="This element has or is affected by some invariants">I</span>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px"/>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="element.html">Element</a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Set of values bounded by low and high
            <br/>
            <span style="font-style: italic" title="rng-2">If present, low SHALL have a lower value than high</span>
          </td>
        </tr>

        <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px;
           white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA
          YAAACg/LjIAAAAL0lEQVR42u3XsQ0AQAgCQHdl/xn8jxvYWB3JlTR0VJLa+OltBwAAYP6EEQAAgCsPVYVAgIJrA/sAAAAASUVORK5
          CYII=)">
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzI3XJ6V3QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+2RsQ0AIAzDav
            7/2VzQwoCY4iWbZSmo1QGoUgNMghvWaIejPQW/CrrNCylIwcOCDYfLNRcNer4SAAAAAElFTkSuQmCC" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAOZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQk
            ad4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRP
            z58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPv
            szv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866O
            UPvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6i
            f3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///////yH5BAEAAH8ALAAAAAAQABAAAAfNgH+Cg36FfoOIhH4JBxBghYl/hQ
            kNAV0IVT5GkJKLCwtQaSsSdx9aR26Gcwt2IkQaNRI6dBERIzCFDSgWSW8WCDkbBnoOQ3uFARc/JQJfCAZlT0x4ZFyFBxdNQT9ZCBN
            WKQoKUQ+FEDgcdTIAV14YDmg2CgSFA0hmQC5TLE4VRTdrKJAoxOeFCzZSwsw4U6BCizwUQhQyEaAPiAwCVNCY0FCNnA6GPAwYoETI
            FgY9loiRA4dToTYnsOxg8CBGHE6ICvEYQ4AKzkidfgoKBAA7" style="background-color: white; background-color: inherit" title="Data Type"/> 
            <a href="datatypes-definitions.html#Range.low" title="Range.low : The low limit. The boundary is inclusive.">low</a>
            <a name="Range.low"> </a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <span title="This element is included in summaries">Σ </span>
            <span title="This element has or is affected by some invariants">I</span>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="datatypes.html#SimpleQuantity">SimpleQuantity</a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">Low limit</td>
        </tr>

        <tr style="border: 0px; padding:0px; vertical-align: top; background-color: white;">
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px;
           white-space: nowrap; background-image: url(data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAACCA
          YAAACg/LjIAAAAI0lEQVR42u3QIQEAAAACIL/6/4MvTAQOkLYBAAB4kAAAANwMad9AqkRjgNAAAAAASUVORK5CYII=)">
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAAWCAYAAAABxvaqAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzIs1vtcMQAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAAE0lEQVQI12P4//8/AxMDAw
            NdCABMPwMo2ctnoQAAAABJRU5ErkJggg==" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAWCAYAAADJqhx8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB
            3RJTUUH3wYeFzME+lXFigAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUHAAAANklEQVQ4y+3OsRUAIAjEUO
            L+O8cJABttJM11/x1qZAGqRBEVcNIqdWj1efDqQbb3HwwwwEfABmQUHSPM9dtDAAAAAElFTkSuQmCC" style="background-color: inherit"/>
            <img alt="." class="hierarchy" src="data: image/png;base64,R0lGODlhEAAQAOZ/APrkusOiYvvfqbiXWaV2G+jGhdq1b8GgYf3v1frw3vTUlsWkZNewbcSjY/DQk
            ad4Hb6dXv3u0f3v1ObEgfPTlerJiP3w1v79+e7OkPrfrfnjuNOtZPrpydaxa+/YrvvdpP779ZxvFPvnwKKBQaFyF/369M2vdaqHRP
            z58/HNh/vowufFhfroxO3OkPrluv779tK0e6JzGProwvrow9m4eOnIifPTlPDPkP78+Naxaf3v0/zowfXRi+bFhLWUVv379/rnwPv
            szv3rye3LiPvnv+3MjPDasKiIS/789/3x2f747eXDg+7Mifvu0tu7f+/QkfDTnPXWmPrjsvrjtPbPgrqZW+/QlPz48K2EMv36866O
            UPvowat8Ivvgq/Pbrvzgq/PguvrgrqN0Gda2evfYm9+7d/rpw9q6e/LSku/Rl/XVl/LSlfrkt+zVqe7Wqv3x1/bNffbOf59wFdS6i
            f3u0vrqyP3owPvepfXQivDQkO/PkKh9K7STVf779P///////yH5BAEAAH8ALAAAAAAQABAAAAfNgH+Cg36FfoOIhH4JBxBghYl/hQ
            kNAV0IVT5GkJKLCwtQaSsSdx9aR26Gcwt2IkQaNRI6dBERIzCFDSgWSW8WCDkbBnoOQ3uFARc/JQJfCAZlT0x4ZFyFBxdNQT9ZCBN
            WKQoKUQ+FEDgcdTIAV14YDmg2CgSFA0hmQC5TLE4VRTdrKJAoxOeFCzZSwsw4U6BCizwUQhQyEaAPiAwCVNCY0FCNnA6GPAwYoETI
            FgY9loiRA4dToTYnsOxg8CBGHE6ICvEYQ4AKzkidfgoKBAA7" style="background-color: white; background-color: inherit" title="Data Type"/> 
            <a href="datatypes-definitions.html#Range.high" title="Range.high : The high limit. The boundary is inclusive.">high</a>
            <a name="Range.high"> </a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <span title="This element is included in summaries">Σ </span>
            <span title="This element has or is affected by some invariants">I</span>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">0..1</td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">
            <a href="datatypes.html#SimpleQuantity">SimpleQuantity</a>
          </td>
          <td class="hierarchy" style="vertical-align: top; text-align : left; background-color: white; padding:0px 4px 0px 4px">High limit</td>
        </tr>

        <tr>
          <td class="hierarchy" colspan="5">
            <br/>
            <a href="formats.html#table" title="Legend for this format">
              <img alt="doco" src="help16.png" style="background-color: inherit"/> Documentation for this format
            </a>
          </td>
        </tr>
      </table>
    </div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/Range"/>
  <name value="Range"/>
  <status value="draft"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <date value="2015-10-24T07:41:03+11:00"/>
  <description value="Base StructureDefinition for Range Type"/>
  <requirements value="Need to be able to specify ranges of values."/>
  <fhirVersion value="1.0.2"/>
  <mapping>
    <identity value="v2"/>
    <uri value="http://hl7.org/v2"/>
    <name value="HL7 v2"/>
  </mapping>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <kind value="datatype"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="Range"/>
      <short value="Set of values bounded by low and high"/>
      <definition value="A set of ordered Quantities defined by a low and high limit."/>
      <comments value="The stated low and high value are assumed to have arbitrarily high precision when it comes
       to determining which values are in the range. I.e. 1.99 is not in the range 2 -&gt; 3."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="rng-2"/>
        <severity value="error"/>
        <human value="If present, low SHALL have a lower value than high"/>
        <xpath value="not(exists(f:low/f:value/@value)) or not(exists(f:high/f:value/@value)) or (number(f:low/f:value/@va
        lue) &lt;= number(f:high/f:value/@value))"/>
      </constraint>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR and also possibly SN (but see also quantity)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL&lt;QTY[not(type=&quot;TS&quot;)]&gt; [lowClosed=&quot;true&quot; and highClosed=&quot;true&quot;
        ]or URG&lt;QTY[not(type=&quot;TS&quot;)]&gt;"/>
      </mapping>
    </element>
    <element>
      <path value="Range.id"/>
      <representation value="xmlAttr"/>
      <short value="xml:id (or equivalent in JSON)"/>
      <definition value="unique id for the element within a resource (for internal references)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="id"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Range.extension"/>
      <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. In order 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 is allowed to define an extension, there is a set of requirements that SHALL
       be met as part of the definition of the extension."/>
      <comments 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="*"/>
      <type>
        <code value="Extension"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element>
      <path value="Range.low"/>
      <short value="Low limit"/>
      <definition value="The low limit. The boundary is inclusive."/>
      <comments value="If the low element is missing, the low boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/>
      </type>
      <condition value="rng-2"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./low"/>
      </mapping>
    </element>
    <element>
      <path value="Range.high"/>
      <short value="High limit"/>
      <definition value="The high limit. The boundary is inclusive."/>
      <comments value="If the high element is missing, the high boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/>
      </type>
      <condition value="rng-2"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./high"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="Range"/>
      <short value="Set of values bounded by low and high"/>
      <definition value="A set of ordered Quantities defined by a low and high limit."/>
      <comments value="The stated low and high value are assumed to have arbitrarily high precision when it comes
       to determining which values are in the range. I.e. 1.99 is not in the range 2 -&gt; 3."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Element"/>
      </type>
      <constraint>
        <key value="rng-2"/>
        <severity value="error"/>
        <human value="If present, low SHALL have a lower value than high"/>
        <xpath value="not(exists(f:low/f:value/@value)) or not(exists(f:high/f:value/@value)) or (number(f:low/f:value/@va
        lue) &lt;= number(f:high/f:value/@value))"/>
      </constraint>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR and also possibly SN (but see also quantity)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL&lt;QTY[not(type=&quot;TS&quot;)]&gt; [lowClosed=&quot;true&quot; and highClosed=&quot;true&quot;
        ]or URG&lt;QTY[not(type=&quot;TS&quot;)]&gt;"/>
      </mapping>
    </element>
    <element>
      <path value="Range.low"/>
      <short value="Low limit"/>
      <definition value="The low limit. The boundary is inclusive."/>
      <comments value="If the low element is missing, the low boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/>
      </type>
      <condition value="rng-2"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./low"/>
      </mapping>
    </element>
    <element>
      <path value="Range.high"/>
      <short value="High limit"/>
      <definition value="The high limit. The boundary is inclusive."/>
      <comments value="If the high element is missing, the high boundary is not known."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/SimpleQuantity"/>
      </type>
      <condition value="rng-2"/>
      <isSummary value="true"/>
      <mapping>
        <identity value="v2"/>
        <map value="NR.2"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="./high"/>
      </mapping>
    </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.