Package org.hl7.fhir.r5.model

Class Substance

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.Substance

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Substance
extends DomainResource

A homogeneous material with a definite composition.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Substance.FHIRSubstanceStatus
static class	Substance.FHIRSubstanceStatusEnumFactory
static class	Substance.SubstanceIngredientComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	category	A code that classifies the general type of substance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected CodeableReference	code	A code (or set of codes) that identify this substance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CODE_REFERENCE	Fluent Client search parameter constant for code-reference
protected MarkdownType	description	A description of the substance - its appearance, handling requirements, and other usage notes.
protected DateTimeType	expiry	When the substance is no longer valid to use.
static final ca.uhn.fhir.rest.gclient.DateClientParam	EXPIRY	Fluent Client search parameter constant for expiry
protected List<Identifier>	identifier	Unique identifier for the substance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_CODE_REFERENCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBSTANCE_REFERENCE	Constant for fluent queries to be used to add include statements.
protected List<Substance.SubstanceIngredientComponent>	ingredient	A substance can be composed of other substances.
protected BooleanType	instance	A boolean to indicate if this an instance of a substance or a kind of one (a definition).
protected Quantity	quantity	The amount of the substance.
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	QUANTITY	Fluent Client search parameter constant for quantity
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CODE	Search parameter: code
static final String	SP_CODE_REFERENCE	Search parameter: code-reference
static final String	SP_EXPIRY	Search parameter: expiry
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_QUANTITY	Search parameter: quantity
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBSTANCE_REFERENCE	Search parameter: substance-reference
protected Enumeration<Substance.FHIRSubstanceStatus>	status	A code to indicate if the substance is actively used.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBSTANCE_REFERENCE	Fluent Client search parameter constant for substance-reference

Fields inherited from class org.hl7.fhir.r5.model.DomainResource

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Substance()	Constructor
Substance(boolean instance, CodeableReference code)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addCategory()
Substance	addCategory(CodeableConcept t)
Base	addChild(String name)
Identifier	addIdentifier()
Substance	addIdentifier(Identifier t)
Substance.SubstanceIngredientComponent	addIngredient()
Substance	addIngredient(Substance.SubstanceIngredientComponent t)
Substance	copy()
void	copyValues(Substance dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
CodeableReference	getCode()
String	getDescription()
MarkdownType	getDescriptionElement()
Date	getExpiry()
DateTimeType	getExpiryElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Substance.SubstanceIngredientComponent>	getIngredient()
Substance.SubstanceIngredientComponent	getIngredientFirstRep()
boolean	getInstance()
BooleanType	getInstanceElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
ResourceType	getResourceType()
Substance.FHIRSubstanceStatus	getStatus()
Enumeration<Substance.FHIRSubstanceStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCategory()
boolean	hasCode()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExpiry()
boolean	hasExpiryElement()
boolean	hasIdentifier()
boolean	hasIngredient()
boolean	hasInstance()
boolean	hasInstanceElement()
boolean	hasQuantity()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Substance	setCategory(List<CodeableConcept> theCategory)
Substance	setCode(CodeableReference value)
Substance	setDescription(String value)
Substance	setDescriptionElement(MarkdownType value)
Substance	setExpiry(Date value)
Substance	setExpiryElement(DateTimeType value)
Substance	setIdentifier(List<Identifier> theIdentifier)
Substance	setIngredient(List<Substance.SubstanceIngredientComponent> theIngredient)
Substance	setInstance(boolean value)
Substance	setInstanceElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Substance	setQuantity(Quantity value)
Substance	setStatus(Substance.FHIRSubstanceStatus value)
Substance	setStatusElement(Enumeration<Substance.FHIRSubstanceStatus> value)
protected Substance	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText

Methods inherited from class org.hl7.fhir.r5.model.Resource

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).

instance

protected BooleanType instance

A boolean to indicate if this an instance of a substance or a kind of one (a definition).

status

protected Enumeration<Substance.FHIRSubstanceStatus> status

A code to indicate if the substance is actively used.

category

protected List<CodeableConcept> category

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

code

protected CodeableReference code

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

description

protected MarkdownType description

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

expiry

protected DateTimeType expiry

When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

quantity

protected Quantity quantity

The amount of the substance.

ingredient

protected List<Substance.SubstanceIngredientComponent> ingredient

A substance can be composed of other substances.

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

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

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

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

SP_CODE_REFERENCE

public static final String SP_CODE_REFERENCE

Search parameter: code-reference

Description: A reference to the defining substance
Type: reference
Path: Substance.code.reference

See Also:

• Constant Field Values

CODE_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CODE_REFERENCE

Fluent Client search parameter constant for code-reference

Description: A reference to the defining substance
Type: reference
Path: Substance.code.reference

INCLUDE_CODE_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_CODE_REFERENCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "Substance:code-reference".

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: The code of the substance or ingredient
Type: token
Path: Substance.code.concept | (Substance.ingredient.substance.ofType(CodeableConcept))

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: The code of the substance or ingredient
Type: token
Path: Substance.code.concept | (Substance.ingredient.substance.ofType(CodeableConcept))

SP_EXPIRY

public static final String SP_EXPIRY

Search parameter: expiry

Description: Expiry date of package or container of substance
Type: date
Path: Substance.expiry

See Also:

• Constant Field Values

EXPIRY

public static final ca.uhn.fhir.rest.gclient.DateClientParam EXPIRY

Fluent Client search parameter constant for expiry

Description: Expiry date of package or container of substance
Type: date
Path: Substance.expiry

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Unique identifier for the substance
Type: token
Path: Substance.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Unique identifier for the substance
Type: token
Path: Substance.identifier

SP_QUANTITY

public static final String SP_QUANTITY

Search parameter: quantity

Description: Amount of substance in the package
Type: quantity
Path: Substance.quantity

See Also:

• Constant Field Values

QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam QUANTITY

Fluent Client search parameter constant for quantity

Description: Amount of substance in the package
Type: quantity
Path: Substance.quantity

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: active | inactive | entered-in-error
Type: token
Path: Substance.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: active | inactive | entered-in-error
Type: token
Path: Substance.status

SP_SUBSTANCE_REFERENCE

public static final String SP_SUBSTANCE_REFERENCE

Search parameter: substance-reference

Description: A component of the substance
Type: reference
Path: (Substance.ingredient.substance.ofType(Reference))

See Also:

• Constant Field Values

SUBSTANCE_REFERENCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBSTANCE_REFERENCE

Fluent Client search parameter constant for substance-reference

Description: A component of the substance
Type: reference
Path: (Substance.ingredient.substance.ofType(Reference))

INCLUDE_SUBSTANCE_REFERENCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSTANCE_REFERENCE

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

Constructor Details

Substance

public Substance()

Constructor

Substance

public Substance(boolean instance,
 CodeableReference code)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).)

setIdentifier

public Substance setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Substance addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getInstanceElement

public BooleanType getInstanceElement()

Returns:

instance (A boolean to indicate if this an instance of a substance or a kind of one (a definition).). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value

hasInstanceElement

public boolean hasInstanceElement()

hasInstance

public boolean hasInstance()

setInstanceElement

public Substance setInstanceElement(BooleanType value)

Parameters:

value - instance (A boolean to indicate if this an instance of a substance or a kind of one (a definition).). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value

getInstance

public boolean getInstance()

Returns:

A boolean to indicate if this an instance of a substance or a kind of one (a definition).

setInstance

public Substance setInstance(boolean value)

Parameters:

value - A boolean to indicate if this an instance of a substance or a kind of one (a definition).

getStatusElement

public Enumeration<Substance.FHIRSubstanceStatus> getStatusElement()

Returns:

status (A code to indicate if the substance is actively used.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Substance setStatusElement(Enumeration<Substance.FHIRSubstanceStatus> value)

Parameters:

value - status (A code to indicate if the substance is actively used.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Substance.FHIRSubstanceStatus getStatus()

Returns:

A code to indicate if the substance is actively used.

setStatus

public Substance setStatus(Substance.FHIRSubstanceStatus value)

Parameters:

value - A code to indicate if the substance is actively used.

getCategory

public List<CodeableConcept> getCategory()

Returns:

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

setCategory

public Substance setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public Substance addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

The first repetition of repeating field category, creating it if it does not already exist {3}

getCode

public CodeableReference getCode()

Returns:

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

hasCode

public boolean hasCode()

setCode

public Substance setCode(CodeableReference value)

Parameters:

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

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (A description of the substance - its appearance, handling requirements, and other usage notes.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public Substance setDescriptionElement(MarkdownType value)

Parameters:

value - description (A description of the substance - its appearance, handling requirements, and other usage notes.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

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

setDescription

public Substance setDescription(String value)

Parameters:

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

getExpiryElement

public DateTimeType getExpiryElement()

Returns:

expiry (When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.). This is the underlying object with id, value and extensions. The accessor "getExpiry" gives direct access to the value

hasExpiryElement

public boolean hasExpiryElement()

hasExpiry

public boolean hasExpiry()

setExpiryElement

public Substance setExpiryElement(DateTimeType value)

Parameters:

value - expiry (When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.). This is the underlying object with id, value and extensions. The accessor "getExpiry" gives direct access to the value

getExpiry

public Date getExpiry()

Returns:

When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

setExpiry

public Substance setExpiry(Date value)

Parameters:

value - When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.

getQuantity

public Quantity getQuantity()

Returns:

quantity (The amount of the substance.)

hasQuantity

public boolean hasQuantity()

setQuantity

public Substance setQuantity(Quantity value)

Parameters:

value - quantity (The amount of the substance.)

getIngredient

public List<Substance.SubstanceIngredientComponent> getIngredient()

Returns:

ingredient (A substance can be composed of other substances.)

setIngredient

public Substance setIngredient(List<Substance.SubstanceIngredientComponent> theIngredient)

Returns:

Returns a reference to this for easy method chaining

hasIngredient

public boolean hasIngredient()

addIngredient

public Substance.SubstanceIngredientComponent addIngredient()

addIngredient

public Substance addIngredient(Substance.SubstanceIngredientComponent t)

getIngredientFirstRep

public Substance.SubstanceIngredientComponent getIngredientFirstRep()

Returns:

The first repetition of repeating field ingredient, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Substance copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Substance dst)

typedCopy

protected Substance typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource