SampledData.profile.xml

StructureDefinition for SampledData

Raw XML

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="SampledData"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div>
  </text>
  <url value="http://hl7.org/fhir/StructureDefinition/SampledData"/>
  <name value="SampledData"/>
  <publisher value="HL7 FHIR Standard"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
  </contact>
  <description value="Base StructureDefinition for SampledData Resource"/>
  <requirements value="There is a need for a concise way to handle the data produced by devices that sample a
   physical state at a high frequency."/>
  <status value="draft"/>
  <date value="2015-03-27T00:13:00+11:00"/>
  <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>
  <type value="type"/>
  <abstract value="false"/>
  <base value="http://hl7.org/fhir/StructureDefinition/Element"/>
  <snapshot>
    <element>
      <path value="SampledData"/>
      <short value="A series of measurements taken by a device"/>
      <definition value="A series of measurements taken by a device, with upper and lower limits. There may be
       more than one dimension in the data."/>
      <comments value="The data is not interpretable without at least origin, period, and dimensions, but these
       are optional to allow a separation between the template of measurement and the actual
       measurement, such as between DeviceCapabilities and DeviceLog.  When providing a summary
       view (for example with Observation.value[x]) SampledData should be represented with a
       brief display text such as &quot;Sampled Data&quot;."/>
      <requirements value="There is a need for a concise way to handle the data produced by devices that sample a
       physical state at a high frequency."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="SampledData"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="N/A (but see section 7.14 in v2.7)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST + GLIST"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.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="SampledData.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="SampledData.origin"/>
      <short value="Zero value and units"/>
      <definition value="The base quantity that a measured value of zero represents. In addition, this provides
       the units of the entire measurement series."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.origin"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.period"/>
      <short value="Number of milliseconds between samples"/>
      <definition value="The length of time between sampling times, measured in milliseconds."/>
      <comments value="This is usually a whole number."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="GLIST.increment"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.factor"/>
      <short value="Multiply data by this before adding to origin"/>
      <definition value="A correction factor that is applied to the sampled data points before they are added to
       the origin."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <defaultValueDecimal value="1"/>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.factor"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.lowerLimit"/>
      <short value="Lower limit of detection"/>
      <definition value="The lower limit of detection of the measured points. This is needed if any of the data
       points have the value &quot;L&quot; (lower than detection limit)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (use SLIST.digits.nullFlavor)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.upperLimit"/>
      <short value="Upper limit of detection"/>
      <definition value="The upper limit of detection of the measured points. This is needed if any of the data
       points have the value &quot;U&quot; (higher than detection limit)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (use SLIST.digits.nullFlavor)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.dimensions"/>
      <short value="Number of sample points at each time point"/>
      <definition value="The number of sample points at each time point. If this value is greater than one, then
       the dimensions will be interlaced - all the sample points for a point in time will be
       recorded at once."/>
      <comments value="If there is more than one dimension, the code for the type of data will define the meaning
       of the dimensions (typically ECG data)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="integer"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (fixed to 1)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.data"/>
      <short value="Decimal values with spaces, or &quot;E&quot; | &quot;U&quot; | &quot;L&quot;"/>
      <definition value="A series of data points which are decimal values separated by a single space (character
       u20). The special values &quot;E&quot; (error), &quot;L&quot; (below detection limit)
       and &quot;U&quot; (above detection limit) can also be used in place of a decimal value."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.digits"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element>
      <path value="SampledData"/>
      <short value="A series of measurements taken by a device"/>
      <definition value="A series of measurements taken by a device, with upper and lower limits. There may be
       more than one dimension in the data."/>
      <comments value="The data is not interpretable without at least origin, period, and dimensions, but these
       are optional to allow a separation between the template of measurement and the actual
       measurement, such as between DeviceCapabilities and DeviceLog.  When providing a summary
       view (for example with Observation.value[x]) SampledData should be represented with a
       brief display text such as &quot;Sampled Data&quot;."/>
      <requirements value="There is a need for a concise way to handle the data produced by devices that sample a
       physical state at a high frequency."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Element"/>
      </type>
      <mapping>
        <identity value="v2"/>
        <map value="N/A (but see section 7.14 in v2.7)"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST + GLIST"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.origin"/>
      <short value="Zero value and units"/>
      <definition value="The base quantity that a measured value of zero represents. In addition, this provides
       the units of the entire measurement series."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="Quantity"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.origin"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.period"/>
      <short value="Number of milliseconds between samples"/>
      <definition value="The length of time between sampling times, measured in milliseconds."/>
      <comments value="This is usually a whole number."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="GLIST.increment"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.factor"/>
      <short value="Multiply data by this before adding to origin"/>
      <definition value="A correction factor that is applied to the sampled data points before they are added to
       the origin."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <defaultValueDecimal value="1"/>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.factor"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.lowerLimit"/>
      <short value="Lower limit of detection"/>
      <definition value="The lower limit of detection of the measured points. This is needed if any of the data
       points have the value &quot;L&quot; (lower than detection limit)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (use SLIST.digits.nullFlavor)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.upperLimit"/>
      <short value="Upper limit of detection"/>
      <definition value="The upper limit of detection of the measured points. This is needed if any of the data
       points have the value &quot;U&quot; (higher than detection limit)."/>
      <min value="0"/>
      <max value="1"/>
      <type>
        <code value="decimal"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (use SLIST.digits.nullFlavor)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.dimensions"/>
      <short value="Number of sample points at each time point"/>
      <definition value="The number of sample points at each time point. If this value is greater than one, then
       the dimensions will be interlaced - all the sample points for a point in time will be
       recorded at once."/>
      <comments value="If there is more than one dimension, the code for the type of data will define the meaning
       of the dimensions (typically ECG data)."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="integer"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="N/A (fixed to 1)"/>
      </mapping>
    </element>
    <element>
      <path value="SampledData.data"/>
      <short value="Decimal values with spaces, or &quot;E&quot; | &quot;U&quot; | &quot;L&quot;"/>
      <definition value="A series of data points which are decimal values separated by a single space (character
       u20). The special values &quot;E&quot; (error), &quot;L&quot; (below detection limit)
       and &quot;U&quot; (above detection limit) can also be used in place of a decimal value."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="string"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="SLIST.digits"/>
      </mapping>
    </element>
  </differential>
</StructureDefinition>