Package org.linuxforhealth.fhir.model.resource

Class Substance

java.lang.Object

org.linuxforhealth.fhir.model.visitor.AbstractVisitable

org.linuxforhealth.fhir.model.resource.Resource

org.linuxforhealth.fhir.model.resource.DomainResource

org.linuxforhealth.fhir.model.resource.Substance

All Implemented Interfaces:

Visitable

@Generated("org.linuxforhealth.fhir.tools.CodeGenerator")
public class Substance
extends DomainResource

A homogeneous material with a definite composition.

Maturity level: FMM2 (Trial Use)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Substance.Builder
static class	Substance.Ingredient	A substance can be composed of other substances.
static class	Substance.Instance	Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.

Field Summary

Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource

hashCode, id, implicitRules, language, meta

Method Summary

Modifier and Type	Method	Description
void	accept(java.lang.String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static Substance.Builder	builder()
boolean	equals(java.lang.Object obj)
java.util.List<CodeableConcept>	getCategory()	A code that classifies the general type of substance.
CodeableConcept	getCode()	A code (or set of codes) that identify this substance.
String	getDescription()	A description of the substance - its appearance, handling requirements, and other usage notes.
java.util.List<Identifier>	getIdentifier()	Unique identifier for the substance.
java.util.List<Substance.Ingredient>	getIngredient()	A substance can be composed of other substances.
java.util.List<Substance.Instance>	getInstance()	Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
FHIRSubstanceStatus	getStatus()	A code to indicate if the substance is actively used.
boolean	hasChildren()
int	hashCode()
Substance.Builder	toBuilder()	Create a new Builder from the contents of this Resource

Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource

getContained, getExtension, getModifierExtension, getText

Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource

as, getId, getImplicitRules, getLanguage, getMeta, is

Methods inherited from class org.linuxforhealth.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.linuxforhealth.fhir.model.visitor.Visitable

accept, accept

Method Detail

getIdentifier

public java.util.List<Identifier> getIdentifier()

Unique identifier for the substance.

Returns:

An unmodifiable list containing immutable objects of type Identifier that may be empty.

getStatus

public FHIRSubstanceStatus getStatus()

A code to indicate if the substance is actively used.

Returns:

An immutable object of type FHIRSubstanceStatus that may be null.

getCategory

public java.util.List<CodeableConcept> getCategory()

A code that classifies the general type of substance. This is used for searching, sorting and display purposes.

Returns:

An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

getCode

public CodeableConcept getCode()

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

Returns:

An immutable object of type CodeableConcept that is non-null.

getDescription

public String getDescription()

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

Returns:

An immutable object of type String that may be null.

getInstance

public java.util.List<Substance.Instance> getInstance()

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

Returns:

An unmodifiable list containing immutable objects of type Substance.Instance that may be empty.

getIngredient

public java.util.List<Substance.Ingredient> getIngredient()

A substance can be composed of other substances.

Returns:

An unmodifiable list containing immutable objects of type Substance.Ingredient that may be empty.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class DomainResource

accept

public void accept(java.lang.String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toBuilder

public Substance.Builder toBuilder()

Description copied from class: Resource

Create a new Builder from the contents of this Resource

Specified by:

toBuilder in class DomainResource

builder

public static Substance.Builder builder()