Package org.hl7.fhir.r5.model
Enum MedicationUsage.MedicationUsageStatusCodes
- java.lang.Object
-
- java.lang.Enum<MedicationUsage.MedicationUsageStatusCodes>
-
- org.hl7.fhir.r5.model.MedicationUsage.MedicationUsageStatusCodes
-
- All Implemented Interfaces:
Serializable,Comparable<MedicationUsage.MedicationUsageStatusCodes>
- Enclosing class:
- MedicationUsage
public static enum MedicationUsage.MedicationUsageStatusCodes extends Enum<MedicationUsage.MedicationUsageStatusCodes>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACTIVEThe medication is still being taken.COMPLETEDThe medication is no longer being taken.ENTEREDINERRORSome of the actions that are implied by the medication usage may have occurred.INTENDEDThe medication may be taken at some time in the future.NOTTAKENThe medication was not consumed by the patientNULLadded to help the parsers with the generic typesONHOLDActions implied by the usage have been temporarily halted, but are expected to continue later.STOPPEDActions implied by the usage have been permanently halted, before all of them occurred.UNKNOWNThe state of the medication use is not currently known.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MedicationUsage.MedicationUsageStatusCodesfromCode(String codeString)StringgetDefinition()StringgetDisplay()StringgetSystem()StringtoCode()static MedicationUsage.MedicationUsageStatusCodesvalueOf(String name)Returns the enum constant of this type with the specified name.static MedicationUsage.MedicationUsageStatusCodes[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ACTIVE
public static final MedicationUsage.MedicationUsageStatusCodes ACTIVE
The medication is still being taken.
-
COMPLETED
public static final MedicationUsage.MedicationUsageStatusCodes COMPLETED
The medication is no longer being taken.
-
ENTEREDINERROR
public static final MedicationUsage.MedicationUsageStatusCodes ENTEREDINERROR
Some of the actions that are implied by the medication usage may have occurred. For example, the patient may have taken some of the medication. Clinical decision support systems should take this status into account.
-
INTENDED
public static final MedicationUsage.MedicationUsageStatusCodes INTENDED
The medication may be taken at some time in the future.
-
STOPPED
public static final MedicationUsage.MedicationUsageStatusCodes STOPPED
Actions implied by the usage have been permanently halted, before all of them occurred. This should not be used if the statement was entered in error.
-
ONHOLD
public static final MedicationUsage.MedicationUsageStatusCodes ONHOLD
Actions implied by the usage have been temporarily halted, but are expected to continue later. May also be called 'suspended'.
-
UNKNOWN
public static final MedicationUsage.MedicationUsageStatusCodes UNKNOWN
The state of the medication use is not currently known.
-
NOTTAKEN
public static final MedicationUsage.MedicationUsageStatusCodes NOTTAKEN
The medication was not consumed by the patient
-
NULL
public static final MedicationUsage.MedicationUsageStatusCodes NULL
added to help the parsers with the generic types
-
-
Method Detail
-
values
public static MedicationUsage.MedicationUsageStatusCodes[] 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 (MedicationUsage.MedicationUsageStatusCodes c : MedicationUsage.MedicationUsageStatusCodes.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static MedicationUsage.MedicationUsageStatusCodes 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 MedicationUsage.MedicationUsageStatusCodes fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDefinition
public String getDefinition()
-
getDisplay
public String getDisplay()
-
-