org.hl7.fhir.r4.model.codesystems

Enum SubstanceCategory

java.lang.Object

java.lang.Enum<SubstanceCategory>

org.hl7.fhir.r4.model.codesystems.SubstanceCategory

All Implemented Interfaces:

Serializable, Comparable<SubstanceCategory>

public enum SubstanceCategory
extends Enum<SubstanceCategory>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLERGEN A substance that causes an allergic reaction.
BIOLOGICAL A substance that is produced by or extracted from a biological source.
BODY A substance that comes directly from a human or an animal (e.g.
CHEMICAL Any organic or inorganic substance of a particular molecular identity, including -- (i) any combination of such substances occurring in whole or in part as a result of a chemical reaction or occurring in nature and (ii) any element or uncombined radical (http://www.epa.gov/opptintr/import-export/pubs/importguide.pdf).
DRUG A substance intended for use in the diagnosis, cure, mitigation, treatment, or prevention of disease in man or other animals (Federal Food Drug and Cosmetic Act).
FOOD A food, dietary ingredient, or dietary supplement for human or animal.
MATERIAL A finished product which is not normally ingested, absorbed or injected (e.g.
NULL added to help the parsers

Method Summary

Modifier and Type	Method and Description
static SubstanceCategory	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static SubstanceCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubstanceCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLERGEN

public static final SubstanceCategory ALLERGEN

A substance that causes an allergic reaction.

BIOLOGICAL

public static final SubstanceCategory BIOLOGICAL

A substance that is produced by or extracted from a biological source.

BODY

public static final SubstanceCategory BODY

A substance that comes directly from a human or an animal (e.g. blood, urine, feces, tears, etc.).

CHEMICAL

public static final SubstanceCategory CHEMICAL

Any organic or inorganic substance of a particular molecular identity, including -- (i) any combination of such substances occurring in whole or in part as a result of a chemical reaction or occurring in nature and (ii) any element or uncombined radical (http://www.epa.gov/opptintr/import-export/pubs/importguide.pdf).

FOOD

public static final SubstanceCategory FOOD

A food, dietary ingredient, or dietary supplement for human or animal.

DRUG

public static final SubstanceCategory DRUG

A substance intended for use in the diagnosis, cure, mitigation, treatment, or prevention of disease in man or other animals (Federal Food Drug and Cosmetic Act).

MATERIAL

public static final SubstanceCategory MATERIAL

A finished product which is not normally ingested, absorbed or injected (e.g. steel, iron, wood, plastic and paper).

NULL

public static final SubstanceCategory NULL

added to help the parsers

Method Detail

values

public static SubstanceCategory[] 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 (SubstanceCategory c : SubstanceCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubstanceCategory 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 name

NullPointerException - if the argument is null

fromCode

public static SubstanceCategory fromCode(String codeString)
                                  throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()