Record Class CodedConcept

java.lang.Object
java.lang.Record
com.framed.interop.mapping.CodedConcept
Record Components:
code - the concept code (e.g. a LOINC code such as "59408-5")
system - the code system (e.g. "LOINC")
display - human-readable display name
unit - unit of measure (UCUM, e.g. "%", "mm[Hg]"); may be empty
valueType - HL7 v2 value type for the OBX-2 field ("NM" numeric, "ST" string)
mdc - IEEE 11073-10101 nomenclature code for SDC (empty if not assigned; SDC descriptors carry a coded type only when this is set)
kind - what the channel is at the SDC boundary — determines the BICEPS descriptor (METRIC/SETTING → numeric metric, WAVEFORM → real-time sample array) and excludes waveforms from the HL7/MQTT bridges

public record CodedConcept(String code, String system, String display, String unit, String valueType, String mdc, CodedConcept.Kind kind) extends Record
A coded clinical concept: how a FRAMED channel is identified in an interoperability standard.
  • Constructor Details

  • Method Details

    • isNumeric

      public boolean isNumeric()
      Returns:
      true if this concept is numeric (OBX-2 = NM).
    • isWaveform

      public boolean isWaveform()
      Returns:
      true if this channel is a high-rate waveform (see CodedConcept.Kind.WAVEFORM).
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • code

      public String code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component
    • system

      public String system()
      Returns the value of the system record component.
      Returns:
      the value of the system record component
    • display

      public String display()
      Returns the value of the display record component.
      Returns:
      the value of the display record component
    • unit

      public String unit()
      Returns the value of the unit record component.
      Returns:
      the value of the unit record component
    • valueType

      public String valueType()
      Returns the value of the valueType record component.
      Returns:
      the value of the valueType record component
    • mdc

      public String mdc()
      Returns the value of the mdc record component.
      Returns:
      the value of the mdc record component
    • kind

      public CodedConcept.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component