ca.uhn.fhir.model.dstu.resource

Class Substance

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.Substance

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class Substance
extends BaseResource
implements IResource

HAPI/FHIR Substance Resource (A homogeneous material with a definite composition)

Definition:

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/Substance

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Substance.Ingredient Block class for child element: Substance.ingredient (Composition information about the substance)
static class	Substance.Instance Block class for child element: Substance.instance (If this describes a specific package/container of the substance)

Field Summary

Fields

Modifier and Type	Field and Description
static DateClientParam	EXPIRY Fluent Client search parameter constant for expiry
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_INGREDIENT_SUBSTANCE Constant for fluent queries to be used to add include statements.
static NumberClientParam	QUANTITY Fluent Client search parameter constant for quantity
static String	SP_EXPIRY Search parameter constant for expiry
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_QUANTITY Search parameter constant for quantity
static String	SP_SUBSTANCE Search parameter constant for substance
static String	SP_TYPE Search parameter constant for type
static ReferenceClientParam	SUBSTANCE Fluent Client search parameter constant for substance
static TokenClientParam	TYPE Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
Substance()

Method Summary

Methods

Modifier and Type	Method and Description
Substance.Ingredient	addIngredient() Adds and returns a new value for ingredient (Composition information about the substance)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
StringDt	getDescription() Gets the value(s) for description (Textual description of the substance, comments).
List<Substance.Ingredient>	getIngredient() Gets the value(s) for ingredient (Composition information about the substance).
Substance.Ingredient	getIngredientFirstRep() Gets the first repetition for ingredient (Composition information about the substance), creating it if it does not already exist.
Substance.Instance	getInstance() Gets the value(s) for instance (If this describes a specific package/container of the substance).
BoundCodeableConceptDt<SubstanceTypeEnum>	getType() Gets the value(s) for type (What kind of substance this is).
boolean	isEmpty()
Substance	setDescription(String theString) Sets the value for description (Textual description of the substance, comments)
Substance	setDescription(StringDt theValue) Sets the value(s) for description (Textual description of the substance, comments)
Substance	setIngredient(List<Substance.Ingredient> theValue) Sets the value(s) for ingredient (Composition information about the substance)
Substance	setInstance(Substance.Instance theValue) Sets the value(s) for instance (If this describes a specific package/container of the substance)
Substance	setType(BoundCodeableConceptDt<SubstanceTypeEnum> theValue) Sets the value(s) for type (What kind of substance this is)
Substance	setType(SubstanceTypeEnum theValue) Sets the value(s) for type (What kind of substance this is)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Field Detail

SP_TYPE

public static final String SP_TYPE

Search parameter constant for type

Description: The type of the substance
Type: token
Path: Substance.type

See Also:

Constant Field Values

TYPE

public static final TokenClientParam TYPE

Fluent Client search parameter constant for type

Description: The type of the substance
Type: token
Path: Substance.type

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description:
Type: token
Path: Substance.instance.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description:
Type: token
Path: Substance.instance.identifier

SP_EXPIRY

public static final String SP_EXPIRY

Search parameter constant for expiry

Description:
Type: date
Path: Substance.instance.expiry

See Also:

Constant Field Values

EXPIRY

public static final DateClientParam EXPIRY

Fluent Client search parameter constant for expiry

Description:
Type: date
Path: Substance.instance.expiry

SP_QUANTITY

public static final String SP_QUANTITY

Search parameter constant for quantity

Description:
Type: number
Path: Substance.instance.quantity

See Also:

Constant Field Values

QUANTITY

public static final NumberClientParam QUANTITY

Fluent Client search parameter constant for quantity

Description:
Type: number
Path: Substance.instance.quantity

SP_SUBSTANCE

public static final String SP_SUBSTANCE

Search parameter constant for substance

Description:
Type: reference
Path: Substance.ingredient.substance

See Also:

Constant Field Values

SUBSTANCE

public static final ReferenceClientParam SUBSTANCE

Fluent Client search parameter constant for substance

Description:
Type: reference
Path: Substance.ingredient.substance

INCLUDE_INGREDIENT_SUBSTANCE

public static final Include INCLUDE_INGREDIENT_SUBSTANCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Substance.ingredient.substance".

Constructor Detail

Substance

public Substance()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getType

public BoundCodeableConceptDt<SubstanceTypeEnum> getType()

Gets the value(s) for type (What kind of substance this is). creating it if it does not exist. Will not return null.

Definition: A code (or set of codes) that identify this substance

setType

public Substance setType(BoundCodeableConceptDt<SubstanceTypeEnum> theValue)

Sets the value(s) for type (What kind of substance this is)

Definition: A code (or set of codes) that identify this substance

setType

public Substance setType(SubstanceTypeEnum theValue)

Sets the value(s) for type (What kind of substance this is)

Definition: A code (or set of codes) that identify this substance

getDescription

public StringDt getDescription()

Gets the value(s) for description (Textual description of the substance, comments). creating it if it does not exist. Will not return null.

Definition: A description of the substance - its appearance, handling requirements, and other usage notes

setDescription

public Substance setDescription(StringDt theValue)

Sets the value(s) for description (Textual description of the substance, comments)

Definition: A description of the substance - its appearance, handling requirements, and other usage notes

setDescription

public Substance setDescription(String theString)

Sets the value for description (Textual description of the substance, comments)

Definition: A description of the substance - its appearance, handling requirements, and other usage notes

getInstance

public Substance.Instance getInstance()

Gets the value(s) for instance (If this describes a specific package/container of the substance). creating it if it does not exist. Will not return null.

Definition: Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance

setInstance

public Substance setInstance(Substance.Instance theValue)

Sets the value(s) for instance (If this describes a specific package/container of the substance)

Definition: Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance

getIngredient

public List<Substance.Ingredient> getIngredient()

Gets the value(s) for ingredient (Composition information about the substance). creating it if it does not exist. Will not return null.

Definition: A substance can be composed of other substances

setIngredient

public Substance setIngredient(List<Substance.Ingredient> theValue)

Sets the value(s) for ingredient (Composition information about the substance)

Definition: A substance can be composed of other substances

addIngredient

public Substance.Ingredient addIngredient()

Adds and returns a new value for ingredient (Composition information about the substance)

Definition: A substance can be composed of other substances

getIngredientFirstRep

public Substance.Ingredient getIngredientFirstRep()

Gets the first repetition for ingredient (Composition information about the substance), creating it if it does not already exist.

Definition: A substance can be composed of other substances