org.hl7.types.enums
Enum ObservationInterpretation

java.lang.Object
  extended by java.lang.Enum<ObservationInterpretation>
      extended by org.hl7.types.enums.ObservationInterpretation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ObservationInterpretation>, ANY, CD, CE, CS, CV

public enum ObservationInterpretation
extends java.lang.Enum<ObservationInterpretation>
implements CS

One or more codes specifying a rough qualitative interpretation of the observation, such as "normal", "abnormal", "below normal", "change up", "resistant", "susceptible", etc.

Discussion: These interpretation codes are sometimes called "abnormal flags", however, the judgment of normalcy is just one of the common rough interpretations, and is often not relevant. For example, the susceptibility interpretations are not about "normalcy", and for any observation of a pathologic condition, it does not make sense to state the normalcy, since pathologic conditions are never considered "normal."


Enum Constant Summary
Better
          Better (of severity or nominal observations)
Change
          Change of quantity and/or severity.
Decreased
          Significant change down (quantitative observations, does not imply B or W)
Exceptions
          Technical exceptions.
HighAlert
          Above upper alert threshold (for quantitative observations)
HighOffScale
          Above absolute high-off instrument scale.
Increased
          Significant change up (quantitative observations, does not imply B or W)
Intermediate
          Intermediate
LowAlert
          Below lower alert threshold (for quantitative observations)
LowOffScale
          Below absolute low-off instrument scale.
ModeratelySusceptible
          Moderately susceptible
Normal
          Normal (for all service types)
Normality
          Normality, Abnormality, Alert.
NormalityAbnormal
          Abnormal (for nominal observations, all service types)
NormalityAlert
          Abnormal alert (for nominal observations and all service types)
NormalityHigh
          Above high normal (for quantitative observations)
NormalityLow
          Below low normal (for quantitative observations)
Resistent
          Resistent
root
           
Susceptibility
          Microbiology: interpretations of minimal inhibitory concentration (MIC) values.
Susceptible
          Susceptible
VerySusceptible
          Very susceptible
Worse
          Worse (of severity or nominal observations)
 
Field Summary
static UID CODE_SYSTEM
           
static ST CODE_SYSTEM_NAME
           
 
Method Summary
 ST code()
          The plain code symbol defined by the code system.
 UID codeSystem()
          Specifies the code system that defines the code.
 ST codeSystemName()
          A common name of the coding system.
 ST codeSystemVersion()
          If applicable, a version descriptor defined specifically for the given code system.
 ST displayName()
          A name or title for the code, under which the sending system shows the code value to its users.
 java.lang.String domainName()
           
 BL equal(ANY that)
           
 BL implies(CD that)
           
 BL isNull()
           
 boolean isNullJ()
           
 ObservationInterpretation mostSpecificGeneralization(CD that)
           
 BL nonNull()
           
 boolean nonNullJ()
           
 BL notApplicable()
           
 boolean notApplicableJ()
           
 NullFlavor nullFlavor()
          An exceptional value expressing missing information and possibly the reason why the information is missing.
 ST originalText()
           
 BL other()
           
 boolean otherJ()
           
 LIST<CR> qualifier()
           
 java.lang.String toString()
           
 SET<CD> translation()
           
 BL unknown()
           
 boolean unknownJ()
           
static ObservationInterpretation valueOf(ST code)
           
static ObservationInterpretation valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ObservationInterpretation[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

root

public static final ObservationInterpretation root

Change

public static final ObservationInterpretation Change
Change of quantity and/or severity. At most one of B or W and one of U or D allowed.


Better

public static final ObservationInterpretation Better
Better (of severity or nominal observations)


Decreased

public static final ObservationInterpretation Decreased
Significant change down (quantitative observations, does not imply B or W)


Increased

public static final ObservationInterpretation Increased
Significant change up (quantitative observations, does not imply B or W)


Worse

public static final ObservationInterpretation Worse
Worse (of severity or nominal observations)


Exceptions

public static final ObservationInterpretation Exceptions
Technical exceptions. At most one allowed. Does not imply normality or severity.


HighOffScale

public static final ObservationInterpretation HighOffScale
Above absolute high-off instrument scale. This is statement depending on the instrument, logically does not imply LL or L (e.g., if the instrument is inadequate). If an off-scale value is also high or critically high one must also report H and HH respectively.


LowOffScale

public static final ObservationInterpretation LowOffScale
Below absolute low-off instrument scale. This is statement depending on the instrument, logically does not imply LL or L (e.g., if the instrument is inadequate). If an off-scale value is also low or critically low one must also report L and LL respectively.


Normality

public static final ObservationInterpretation Normality
Normality, Abnormality, Alert. Concepts in this category are mutually exclusive, i.e., at most one is allowed.


Normal

public static final ObservationInterpretation Normal
Normal (for all service types)


NormalityAbnormal

public static final ObservationInterpretation NormalityAbnormal
Abnormal (for nominal observations, all service types)


NormalityAlert

public static final ObservationInterpretation NormalityAlert
Abnormal alert (for nominal observations and all service types)


NormalityHigh

public static final ObservationInterpretation NormalityHigh
Above high normal (for quantitative observations)


HighAlert

public static final ObservationInterpretation HighAlert
Above upper alert threshold (for quantitative observations)


NormalityLow

public static final ObservationInterpretation NormalityLow
Below low normal (for quantitative observations)


LowAlert

public static final ObservationInterpretation LowAlert
Below lower alert threshold (for quantitative observations)


Susceptibility

public static final ObservationInterpretation Susceptibility
Microbiology: interpretations of minimal inhibitory concentration (MIC) values. At most one allowed.


Intermediate

public static final ObservationInterpretation Intermediate
Intermediate


ModeratelySusceptible

public static final ObservationInterpretation ModeratelySusceptible
Moderately susceptible


Resistent

public static final ObservationInterpretation Resistent
Resistent


Susceptible

public static final ObservationInterpretation Susceptible
Susceptible


VerySusceptible

public static final ObservationInterpretation VerySusceptible
Very susceptible

Field Detail

CODE_SYSTEM

public static final UID CODE_SYSTEM

CODE_SYSTEM_NAME

public static final ST CODE_SYSTEM_NAME
Method Detail

values

public static final ObservationInterpretation[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ObservationInterpretation c : ObservationInterpretation.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ObservationInterpretation valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

equal

public final BL equal(ANY that)
Specified by:
equal in interface ANY

implies

public BL implies(CD that)
Specified by:
implies in interface CD

mostSpecificGeneralization

public ObservationInterpretation mostSpecificGeneralization(CD that)
Specified by:
mostSpecificGeneralization in interface CD

valueOf

public static ObservationInterpretation valueOf(ST code)

toString

public java.lang.String toString()
Specified by:
toString in interface CS
Overrides:
toString in class java.lang.Enum<ObservationInterpretation>

domainName

public java.lang.String domainName()

code

public ST code()
Description copied from interface: CD
The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Specified by:
code in interface CD

displayName

public ST displayName()
Description copied from interface: CD
A name or title for the code, under which the sending system shows the code value to its users.

Specified by:
displayName in interface CD

codeSystem

public UID codeSystem()
Description copied from interface: CD
Specifies the code system that defines the code.

Specified by:
codeSystem in interface CD

codeSystemName

public ST codeSystemName()
Description copied from interface: CD
A common name of the coding system.

Specified by:
codeSystemName in interface CD

codeSystemVersion

public ST codeSystemVersion()
Description copied from interface: CD
If applicable, a version descriptor defined specifically for the given code system.

Specified by:
codeSystemVersion in interface CD

originalText

public ST originalText()
Specified by:
originalText in interface CD

translation

public SET<CD> translation()
Specified by:
translation in interface CD

qualifier

public LIST<CR> qualifier()
Specified by:
qualifier in interface CD

nullFlavor

public NullFlavor nullFlavor()
Description copied from interface: ANY
An exceptional value expressing missing information and possibly the reason why the information is missing.

Specified by:
nullFlavor in interface ANY

isNullJ

public boolean isNullJ()
Specified by:
isNullJ in interface ANY

nonNullJ

public boolean nonNullJ()
Specified by:
nonNullJ in interface ANY

notApplicableJ

public boolean notApplicableJ()
Specified by:
notApplicableJ in interface ANY

unknownJ

public boolean unknownJ()
Specified by:
unknownJ in interface ANY

otherJ

public boolean otherJ()
Specified by:
otherJ in interface ANY

isNull

public BL isNull()
Specified by:
isNull in interface ANY

nonNull

public BL nonNull()
Specified by:
nonNull in interface ANY

notApplicable

public BL notApplicable()
Specified by:
notApplicable in interface ANY

unknown

public BL unknown()
Specified by:
unknown in interface ANY

other

public BL other()
Specified by:
other in interface ANY