Enum V3NullFlavor
- java.lang.Object
-
- java.lang.Enum<V3NullFlavor>
-
- org.hl7.fhir.r4.model.codesystems.V3NullFlavor
-
- All Implemented Interfaces:
Serializable,Comparable<V3NullFlavor>
public enum V3NullFlavor extends Enum<V3NullFlavor>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ASKUInformation was sought but not found (e.g., patient was asked but didn't know)DERDescription:An actual value may exist, but it must be derived from the provided information (usually an EXPR generic data type extension will be used to convey the derivation expressionexpression .INVDescription:The value as represented in the instance is not a member of the set of permitted data values in the constrained value domain of a variable.MSKThere is information on this item available but it has not been provided by the sender due to security, privacy or other reasons.NAKnown to have no proper value (e.g., last menstrual period for a male).NASKThis information has not been sought (e.g., patient was not asked)NAVInformation is not available at this time but it is expected that it will be available later.NAVUInformation is not available at this time (with no expectation regarding whether it will or will not be available in the future).NIDescription:The value is exceptional (missing, omitted, incomplete, improper).NINFNegative infinity of numbers.NPValue is not present in a message.NULLadded to help the parsersOTHDescription:The actual value is not a member of the set of permitted data values in the constrained value domain of a variable.PINFPositive infinity of numbers.QSDescription:The specific quantity is not known, but is known to be non-zero and is not specified because it makes up the bulk of the material.TRCThe content is greater than zero, but too small to be quantified.UNCDescription: The actual value has not yet been encoded within the approved value domain.UNKDescription:A proper value is applicable, but not known.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static V3NullFlavorfromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static V3NullFlavorvalueOf(String name)Returns the enum constant of this type with the specified name.static V3NullFlavor[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NI
public static final V3NullFlavor NI
Description:The value is exceptional (missing, omitted, incomplete, improper). No information as to the reason for being an exceptional value is provided. This is the most general exceptional value. It is also the default exceptional value.
-
INV
public static final V3NullFlavor INV
Description:The value as represented in the instance is not a member of the set of permitted data values in the constrained value domain of a variable.
-
DER
public static final V3NullFlavor DER
Description:An actual value may exist, but it must be derived from the provided information (usually an EXPR generic data type extension will be used to convey the derivation expressionexpression .
-
OTH
public static final V3NullFlavor OTH
Description:The actual value is not a member of the set of permitted data values in the constrained value domain of a variable. (e.g., concept not provided by required code system). Usage Notes: This flavor and its specializations are most commonly used with the CD datatype and its flavors. However, it may apply to *any* datatype where the constraints of the type are tighter than can be conveyed. For example, a PQ that is for a true measured amount whose units are not supported in UCUM, a need to convey a REAL when the type has been constrained to INT, etc. With coded datatypes, this null flavor may only be used if the vocabulary binding has a coding strength of CNE. By definition, all local codes and original text are part of the value set if the coding strength is CWE.
-
NINF
public static final V3NullFlavor NINF
Negative infinity of numbers.
-
PINF
public static final V3NullFlavor PINF
Positive infinity of numbers.
-
UNC
public static final V3NullFlavor UNC
Description: The actual value has not yet been encoded within the approved value domain. Example: Original text or a local code has been specified but translation or encoding to the approved value set has not yet occurred due to limitations of the sending system. Original text has been captured for a PQ, but not attempt has been made to split the value and unit or to encode the unit in UCUM. Usage Notes: If it is known that it is not possible to encode the concept, OTH should be used instead. However, use of UNC does not necessarily guarantee the concept will be encodable, only that encoding has not been attempted. Data type properties such as original text and translations may be present when this null flavor is included.
-
MSK
public static final V3NullFlavor MSK
There is information on this item available but it has not been provided by the sender due to security, privacy or other reasons. There may be an alternate mechanism for gaining access to this information. Note: using this null flavor does provide information that may be a breach of confidentiality, even though no detail data is provided. Its primary purpose is for those circumstances where it is necessary to inform the receiver that the information does exist without providing any detail.
-
NA
public static final V3NullFlavor NA
Known to have no proper value (e.g., last menstrual period for a male).
-
UNK
public static final V3NullFlavor UNK
Description:A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
-
ASKU
public static final V3NullFlavor ASKU
Information was sought but not found (e.g., patient was asked but didn't know)
-
NAV
public static final V3NullFlavor NAV
Information is not available at this time but it is expected that it will be available later.
-
NASK
public static final V3NullFlavor NASK
This information has not been sought (e.g., patient was not asked)
-
NAVU
public static final V3NullFlavor NAVU
Information is not available at this time (with no expectation regarding whether it will or will not be available in the future).
-
QS
public static final V3NullFlavor QS
Description:The specific quantity is not known, but is known to be non-zero and is not specified because it makes up the bulk of the material. e.g. 'Add 10mg of ingredient X, 50mg of ingredient Y, and sufficient quantity of water to 100mL.' The null flavor would be used to express the quantity of water.
-
TRC
public static final V3NullFlavor TRC
The content is greater than zero, but too small to be quantified.
-
NP
public static final V3NullFlavor NP
Value is not present in a message. This is only defined in messages, never in application data! All values not present in the message must be replaced by the applicable default, or no-information (NI) as the default of all defaults.
-
NULL
public static final V3NullFlavor NULL
added to help the parsers
-
-
Method Detail
-
values
public static V3NullFlavor[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (V3NullFlavor c : V3NullFlavor.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static V3NullFlavor valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
fromCode
public static V3NullFlavor fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-