Package org.hl7.fhir.r5.model

Class SampledData

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.DataType
org.hl7.fhir.r5.model.SampledData
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType
public class SampledData extends DataType implements org.hl7.fhir.instance.model.api.ICompositeType
SampledData Type: A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
See Also:

  • Field Details

    • origin

      protected Quantity origin
      The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.

    • interval

      protected DecimalType interval
      Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

    • intervalUnit

      protected CodeType intervalUnit
      The measurement unit in which the sample interval is expressed.

    • factor

      protected DecimalType factor
      A correction factor that is applied to the sampled data points before they are added to the origin.

    • lowerLimit

      protected DecimalType lowerLimit
      The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

    • upperLimit

      protected DecimalType upperLimit
      The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

    • dimensions

      protected PositiveIntType dimensions
      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.

    • codeMap

      protected CanonicalType codeMap
      Reference to ConceptMap that defines the codes used in the data.

    • offsets

      protected StringType offsets
      A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.

    • data

      protected StringType data
      A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.

  • Constructor Details

  • Method Details

    • getOrigin

      public Quantity getOrigin()
      Returns:
      origin (The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.)

    • hasOrigin

      public boolean hasOrigin()

    • setOrigin

      public SampledData setOrigin(Quantity value)
      Parameters:
      value - origin (The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.)

    • getIntervalElement

      public DecimalType getIntervalElement()
      Returns:
      interval (Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.). This is the underlying object with id, value and extensions. The accessor "getInterval" gives direct access to the value

    • hasIntervalElement

      public boolean hasIntervalElement()

    • hasInterval

      public boolean hasInterval()

    • setIntervalElement

      public SampledData setIntervalElement(DecimalType value)
      Parameters:
      value - interval (Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.). This is the underlying object with id, value and extensions. The accessor "getInterval" gives direct access to the value

    • getInterval

      public BigDecimal getInterval()
      Returns:
      Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

    • setInterval

      public SampledData setInterval(BigDecimal value)
      Parameters:
      value - Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

    • setInterval

      public SampledData setInterval(long value)
      Parameters:
      value - Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

    • setInterval

      public SampledData setInterval(double value)
      Parameters:
      value - Amount of intervalUnits between samples, e.g. milliseconds for time-based sampling.

    • getIntervalUnitElement

      public CodeType getIntervalUnitElement()
      Returns:
      intervalUnit (The measurement unit in which the sample interval is expressed.). This is the underlying object with id, value and extensions. The accessor "getIntervalUnit" gives direct access to the value

    • hasIntervalUnitElement

      public boolean hasIntervalUnitElement()

    • hasIntervalUnit

      public boolean hasIntervalUnit()

    • setIntervalUnitElement

      public SampledData setIntervalUnitElement(CodeType value)
      Parameters:
      value - intervalUnit (The measurement unit in which the sample interval is expressed.). This is the underlying object with id, value and extensions. The accessor "getIntervalUnit" gives direct access to the value

    • getIntervalUnit

      public String getIntervalUnit()
      Returns:
      The measurement unit in which the sample interval is expressed.

    • setIntervalUnit

      public SampledData setIntervalUnit(String value)
      Parameters:
      value - The measurement unit in which the sample interval is expressed.

    • getFactorElement

      public DecimalType getFactorElement()
      Returns:
      factor (A correction factor that is applied to the sampled data points before they are added to the origin.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

    • hasFactorElement

      public boolean hasFactorElement()

    • hasFactor

      public boolean hasFactor()

    • setFactorElement

      public SampledData setFactorElement(DecimalType value)
      Parameters:
      value - factor (A correction factor that is applied to the sampled data points before they are added to the origin.). This is the underlying object with id, value and extensions. The accessor "getFactor" gives direct access to the value

    • getFactor

      public BigDecimal getFactor()
      Returns:
      A correction factor that is applied to the sampled data points before they are added to the origin.

    • setFactor

      public SampledData setFactor(BigDecimal value)
      Parameters:
      value - A correction factor that is applied to the sampled data points before they are added to the origin.

    • setFactor

      public SampledData setFactor(long value)
      Parameters:
      value - A correction factor that is applied to the sampled data points before they are added to the origin.

    • setFactor

      public SampledData setFactor(double value)
      Parameters:
      value - A correction factor that is applied to the sampled data points before they are added to the origin.

    • getLowerLimitElement

      public DecimalType getLowerLimitElement()
      Returns:
      lowerLimit (The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).). This is the underlying object with id, value and extensions. The accessor "getLowerLimit" gives direct access to the value

    • hasLowerLimitElement

      public boolean hasLowerLimitElement()

    • hasLowerLimit

      public boolean hasLowerLimit()

    • setLowerLimitElement

      public SampledData setLowerLimitElement(DecimalType value)
      Parameters:
      value - lowerLimit (The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).). This is the underlying object with id, value and extensions. The accessor "getLowerLimit" gives direct access to the value

    • getLowerLimit

      public BigDecimal getLowerLimit()
      Returns:
      The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

    • setLowerLimit

      public SampledData setLowerLimit(BigDecimal value)
      Parameters:
      value - The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

    • setLowerLimit

      public SampledData setLowerLimit(long value)
      Parameters:
      value - The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

    • setLowerLimit

      public SampledData setLowerLimit(double value)
      Parameters:
      value - The lower limit of detection of the measured points. This is needed if any of the data points have the value "L" (lower than detection limit).

    • getUpperLimitElement

      public DecimalType getUpperLimitElement()
      Returns:
      upperLimit (The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).). This is the underlying object with id, value and extensions. The accessor "getUpperLimit" gives direct access to the value

    • hasUpperLimitElement

      public boolean hasUpperLimitElement()

    • hasUpperLimit

      public boolean hasUpperLimit()

    • setUpperLimitElement

      public SampledData setUpperLimitElement(DecimalType value)
      Parameters:
      value - upperLimit (The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).). This is the underlying object with id, value and extensions. The accessor "getUpperLimit" gives direct access to the value

    • getUpperLimit

      public BigDecimal getUpperLimit()
      Returns:
      The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

    • setUpperLimit

      public SampledData setUpperLimit(BigDecimal value)
      Parameters:
      value - The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

    • setUpperLimit

      public SampledData setUpperLimit(long value)
      Parameters:
      value - The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

    • setUpperLimit

      public SampledData setUpperLimit(double value)
      Parameters:
      value - The upper limit of detection of the measured points. This is needed if any of the data points have the value "U" (higher than detection limit).

    • getDimensionsElement

      public PositiveIntType getDimensionsElement()
      Returns:
      dimensions (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.). This is the underlying object with id, value and extensions. The accessor "getDimensions" gives direct access to the value

    • hasDimensionsElement

      public boolean hasDimensionsElement()

    • hasDimensions

      public boolean hasDimensions()

    • setDimensionsElement

      public SampledData setDimensionsElement(PositiveIntType value)
      Parameters:
      value - dimensions (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.). This is the underlying object with id, value and extensions. The accessor "getDimensions" gives direct access to the value

    • getDimensions

      public int getDimensions()
      Returns:
      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.

    • setDimensions

      public SampledData setDimensions(int value)
      Parameters:
      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.

    • getCodeMapElement

      public CanonicalType getCodeMapElement()
      Returns:
      codeMap (Reference to ConceptMap that defines the codes used in the data.). This is the underlying object with id, value and extensions. The accessor "getCodeMap" gives direct access to the value

    • hasCodeMapElement

      public boolean hasCodeMapElement()

    • hasCodeMap

      public boolean hasCodeMap()

    • setCodeMapElement

      public SampledData setCodeMapElement(CanonicalType value)
      Parameters:
      value - codeMap (Reference to ConceptMap that defines the codes used in the data.). This is the underlying object with id, value and extensions. The accessor "getCodeMap" gives direct access to the value

    • getCodeMap

      public String getCodeMap()
      Returns:
      Reference to ConceptMap that defines the codes used in the data.

    • setCodeMap

      public SampledData setCodeMap(String value)
      Parameters:
      value - Reference to ConceptMap that defines the codes used in the data.

    • getOffsetsElement

      public StringType getOffsetsElement()
      Returns:
      offsets (A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.). This is the underlying object with id, value and extensions. The accessor "getOffsets" gives direct access to the value

    • hasOffsetsElement

      public boolean hasOffsetsElement()

    • hasOffsets

      public boolean hasOffsets()

    • setOffsetsElement

      public SampledData setOffsetsElement(StringType value)
      Parameters:
      value - offsets (A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.). This is the underlying object with id, value and extensions. The accessor "getOffsets" gives direct access to the value

    • getOffsets

      public String getOffsets()
      Returns:
      A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.

    • setOffsets

      public SampledData setOffsets(String value)
      Parameters:
      value - A series of data points which are decimal values separated by a single space (character u20). The units in which the offsets are expressed are found in intervalUnit. The absolute point at which the measurements begin SHALL be conveyed outside the scope of this datatype, e.g. Observation.effectiveDateTime for a timing offset.

    • getDataElement

      public StringType getDataElement()
      Returns:
      data (A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.). This is the underlying object with id, value and extensions. The accessor "getData" gives direct access to the value

    • hasDataElement

      public boolean hasDataElement()

    • hasData

      public boolean hasData()

    • setDataElement

      public SampledData setDataElement(StringType value)
      Parameters:
      value - data (A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.). This is the underlying object with id, value and extensions. The accessor "getData" gives direct access to the value

    • getData

      public String getData()
      Returns:
      A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.

    • setData

      public SampledData setData(String value)
      Parameters:
      value - A series of data points which are decimal values or codes separated by a single space (character u20). The special codes "E" (error), "L" (below detection limit) and "U" (above detection limit) are also defined for used in place of decimal values.

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DataType
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public SampledData copy()
      Specified by:
      copy in class DataType

    • copyValues

      public void copyValues(SampledData dst)

    • typedCopy

      protected SampledData typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element