Standard Health Record

IntegerQuantityProfile


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="shr-core-IntegerQuantity"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>SHR IntegerQuantity Profile</b></p>
  <p>A Quantity that is an integer.</p>
  <p><b>SHR Mapping Summary</b></p>
  <p><pre>shr.core.IntegerQuantity maps to Count:
  decimal maps to value
  Units.Coding.code maps to code
  Units.Coding.CodeSystem maps to system
  Units.Coding.DisplayText maps to unit
  Comparator maps to comparator
</pre></p>
</div>
  </text>
  <url
       value="http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-IntegerQuantity"/>
  <identifier>
    <system value="http://standardhealthrecord.org"/>
    <value value="shr.core.IntegerQuantity"/>
  </identifier>
  <version value="0.1.0"/>
  <name value="IntegerQuantityProfile"/>
  <title value="SHR IntegerQuantity Profile"/>
  <status value="draft"/>
  <date value="2018-08-22T00:00:00-04:00"/>
  <publisher value="The MITRE Corporation: Standard Health Record Collaborative"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://standardhealthrecord.org"/>
    </telecom>
  </contact>
  <description value="A Quantity that is an integer."/>
  <purpose
           value="Need to able to capture all sorts of measured values, even if the measured value are not precisely quantified. Values include exact measures such as 3.51g, customary units such as 3 tablets, and currencies such as $100.32USD."/>
  <fhirVersion value="3.0.1"/>
  <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="Count"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Count"/>
  <derivation value="constraint"/>
  <snapshot>
    <element id="Count:shr-core-IntegerQuantity">
      <path value="Count"/>
      <short value="SHR IntegerQuantity Profile"/>
      <definition value="A Quantity that is an integer."/>
      <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="*"/>
      <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()"/>
        <xpath value="not(exists(f:code)) or exists(f:system)"/>
        <source value="Quantity"/>
      </constraint>
      <constraint>
        <key value="cnt-3"/>
        <severity value="error"/>
        <human
               value="There SHALL be a code with a value of &quot;1&quot; if there is a value and it SHALL be an expression of length.  If system is present, it SHALL be UCUM.  If present, the value SHALL a whole number."/>
        <expression
                    value="(code or value.empty()) and (system.empty() or system = %ucum) and (code.empty() or code = &#39;1&#39;) and (value.empty() or value.toString().contains(&#39;.&#39;).not())"/>
        <xpath
               value="(f:code or not(f:value)) and (not(exists(f:system)) or (f:system/@value=&#39;http://unitsofmeasure.org&#39; and f:code/@value=&#39;1&#39;)) and not(contains(f:value/@value, &#39;.&#39;))"/>
      </constraint>
      <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="Count:shr-core-IntegerQuantity.id">
      <path value="Count.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). 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>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Count:shr-core-IntegerQuantity.extension">
      <path value="Count.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. 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."/>
      <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>
      <mapping>
        <identity value="rim"/>
        <map value="n/a"/>
      </mapping>
    </element>
    <element id="Count:shr-core-IntegerQuantity.value">
      <path value="Count.value"/>
      <short value="Numerical value (with implicit precision)"/>
      <definition value="Decimal representing a Quantity that is an integer."/>
      <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="1"/>
      <max value="1"/>
      <base>
        <path value="Quantity.value"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="decimal"/>
      </type>
      <isSummary value="true"/>
      <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="Count:shr-core-IntegerQuantity.comparator">
      <path value="Count.comparator"/>
      <short value="&lt; | &lt;= | &gt;= | &gt; - 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."/>
      <comment
               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."/>
      <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"/>
      <isModifier value="true"/>
      <isSummary value="true"/>
      <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."/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/quantity-comparator"/>
        </valueSetReference>
      </binding>
      <mapping>
        <identity value="v2"/>
        <map value="SN.1  / CQ.1"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="IVL properties"/>
      </mapping>
    </element>
    <element id="Count:shr-core-IntegerQuantity.unit">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
        <valueBoolean value="true"/>
      </extension>
      <path value="Count.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>
      <isSummary value="true"/>
      <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="Count:shr-core-IntegerQuantity.system">
      <path value="Count.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"/>
      <isSummary value="true"/>
      <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="Count:shr-core-IntegerQuantity.code">
      <path value="Count.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>
      <isSummary value="true"/>
      <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="Count:shr-core-IntegerQuantity">
      <path value="Count"/>
      <short value="SHR IntegerQuantity Profile"/>
      <definition value="A Quantity that is an integer."/>
    </element>
    <element id="Count:shr-core-IntegerQuantity.value">
      <path value="Count.value"/>
      <definition value="Decimal representing a Quantity that is an integer."/>
      <min value="1"/>
      <max value="1"/>
    </element>
  </differential>
</StructureDefinition>