Package com.framed.interop.mapping
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 nameunit- unit of measure (UCUM, e.g."%","mm[Hg]"); may be emptyvalueType- 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumChannel kind at the SDC boundary (mapping JSON fieldkind, lowercase). -
Constructor Summary
ConstructorsConstructorDescriptionConvenience constructor for concepts without SDC attributes (mdcempty,kindCodedConcept.Kind.METRIC).CodedConcept(String code, String system, String display, String unit, String valueType, String mdc, CodedConcept.Kind kind) Defaults a blankvalueTypeto"NM", a nullsystemto"LOINC", a nullmdcto empty and a nullkindtoCodedConcept.Kind.METRIC. -
Method Summary
Modifier and TypeMethodDescriptioncode()Returns the value of thecoderecord component.display()Returns the value of thedisplayrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.booleanbooleankind()Returns the value of thekindrecord component.mdc()Returns the value of themdcrecord component.system()Returns the value of thesystemrecord component.final StringtoString()Returns a string representation of this record class.unit()Returns the value of theunitrecord component.Returns the value of thevalueTyperecord component.
-
Constructor Details
-
CodedConcept
public CodedConcept(String code, String system, String display, String unit, String valueType, String mdc, CodedConcept.Kind kind) Defaults a blankvalueTypeto"NM", a nullsystemto"LOINC", a nullmdcto empty and a nullkindtoCodedConcept.Kind.METRIC. -
CodedConcept
Convenience constructor for concepts without SDC attributes (mdcempty,kindCodedConcept.Kind.METRIC).- Parameters:
code- the concept codesystem- the code systemdisplay- the display nameunit- the unit of measurevalueType- the HL7 v2 value type
-
-
Method Details
-
isNumeric
public boolean isNumeric()- Returns:
trueif this concept is numeric (OBX-2 =NM).
-
isWaveform
public boolean isWaveform()- Returns:
trueif this channel is a high-rate waveform (seeCodedConcept.Kind.WAVEFORM).
-
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. -
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. -
equals
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 withObjects::equals(Object,Object). -
code
Returns the value of thecoderecord component.- Returns:
- the value of the
coderecord component
-
system
Returns the value of thesystemrecord component.- Returns:
- the value of the
systemrecord component
-
display
Returns the value of thedisplayrecord component.- Returns:
- the value of the
displayrecord component
-
unit
Returns the value of theunitrecord component.- Returns:
- the value of the
unitrecord component
-
valueType
Returns the value of thevalueTyperecord component.- Returns:
- the value of the
valueTyperecord component
-
mdc
Returns the value of themdcrecord component.- Returns:
- the value of the
mdcrecord component
-
kind
Returns the value of thekindrecord component.- Returns:
- the value of the
kindrecord component
-
