Package org.hl7.fhir.r5.model

Class SubstanceDefinition

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.SubstanceDefinition

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 SubstanceDefinition
extends DomainResource

The detailed description of a substance, typically at a level beyond what is used for prescribing.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstanceDefinition.SubstanceDefinitionCharacterizationComponent
static class	SubstanceDefinition.SubstanceDefinitionCodeComponent
static class	SubstanceDefinition.SubstanceDefinitionMoietyComponent
static class	SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent
static class	SubstanceDefinition.SubstanceDefinitionNameComponent
static class	SubstanceDefinition.SubstanceDefinitionNameOfficialComponent
static class	SubstanceDefinition.SubstanceDefinitionPropertyComponent
static class	SubstanceDefinition.SubstanceDefinitionRelationshipComponent
static class	SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent
static class	SubstanceDefinition.SubstanceDefinitionStructureComponent
static class	SubstanceDefinition.SubstanceDefinitionStructureRepresentationComponent

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<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent>	characterization	General specifications for this substance.
protected List<CodeableConcept>	classification	A high level categorization, e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CLASSIFICATION	Fluent Client search parameter constant for classification
protected List<SubstanceDefinition.SubstanceDefinitionCodeComponent>	code	Codes associated with the substance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected MarkdownType	description	Textual description of the substance.
protected CodeableConcept	domain	If the substance applies to human or veterinary use.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	DOMAIN	Fluent Client search parameter constant for domain
protected List<CodeableConcept>	grade	The quality standard, established benchmark, to which substance complies (e.g.
protected List<Identifier>	identifier	Identifier by which this substance is known.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<Reference>	informationSource	Supporting literature.
protected List<Reference>	manufacturer	The entity that creates, makes, produces or fabricates the substance.
protected List<SubstanceDefinition.SubstanceDefinitionMoietyComponent>	moiety	Moiety, for structural modifications.
protected List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent>	molecularWeight	The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.
protected List<SubstanceDefinition.SubstanceDefinitionNameComponent>	name	Names applicable to this substance.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<Annotation>	note	Textual comment about the substance's catalogue or registry record.
protected Reference	nucleicAcid	Data items specific to nucleic acids.
protected Reference	polymer	Data items specific to polymers.
protected List<SubstanceDefinition.SubstanceDefinitionPropertyComponent>	property	General specifications for this substance.
protected Reference	protein	Data items specific to proteins.
protected Reference	referenceInformation	General information detailing this substance.
protected List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent>	relationship	A link between this substance and another, with details of the relationship.
protected SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent	sourceMaterial	Material or taxonomic/anatomical source for the substance.
static final String	SP_CLASSIFICATION	Search parameter: classification
static final String	SP_CODE	Search parameter: code
static final String	SP_DOMAIN	Search parameter: domain
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_NAME	Search parameter: name
protected CodeableConcept	status	Status of substance within the catalogue e.g.
protected SubstanceDefinition.SubstanceDefinitionStructureComponent	structure	Structural information.
protected List<Reference>	supplier	An entity that is the source for the substance.
protected StringType	version	A business level version identifier of the substance.

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
SubstanceDefinition()	Constructor

Method Summary

Modifier and Type	Method	Description
SubstanceDefinition.SubstanceDefinitionCharacterizationComponent	addCharacterization()
SubstanceDefinition	addCharacterization(SubstanceDefinition.SubstanceDefinitionCharacterizationComponent t)
Base	addChild(String name)
CodeableConcept	addClassification()
SubstanceDefinition	addClassification(CodeableConcept t)
SubstanceDefinition.SubstanceDefinitionCodeComponent	addCode()
SubstanceDefinition	addCode(SubstanceDefinition.SubstanceDefinitionCodeComponent t)
CodeableConcept	addGrade()
SubstanceDefinition	addGrade(CodeableConcept t)
Identifier	addIdentifier()
SubstanceDefinition	addIdentifier(Identifier t)
Reference	addInformationSource()
SubstanceDefinition	addInformationSource(Reference t)
Reference	addManufacturer()
SubstanceDefinition	addManufacturer(Reference t)
SubstanceDefinition.SubstanceDefinitionMoietyComponent	addMoiety()
SubstanceDefinition	addMoiety(SubstanceDefinition.SubstanceDefinitionMoietyComponent t)
SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent	addMolecularWeight()
SubstanceDefinition	addMolecularWeight(SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent t)
SubstanceDefinition.SubstanceDefinitionNameComponent	addName()
SubstanceDefinition	addName(SubstanceDefinition.SubstanceDefinitionNameComponent t)
Annotation	addNote()
SubstanceDefinition	addNote(Annotation t)
SubstanceDefinition.SubstanceDefinitionPropertyComponent	addProperty()
SubstanceDefinition	addProperty(SubstanceDefinition.SubstanceDefinitionPropertyComponent t)
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	addRelationship()
SubstanceDefinition	addRelationship(SubstanceDefinition.SubstanceDefinitionRelationshipComponent t)
Reference	addSupplier()
SubstanceDefinition	addSupplier(Reference t)
SubstanceDefinition	copy()
void	copyValues(SubstanceDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent>	getCharacterization()
SubstanceDefinition.SubstanceDefinitionCharacterizationComponent	getCharacterizationFirstRep()
List<CodeableConcept>	getClassification()
CodeableConcept	getClassificationFirstRep()
List<SubstanceDefinition.SubstanceDefinitionCodeComponent>	getCode()
SubstanceDefinition.SubstanceDefinitionCodeComponent	getCodeFirstRep()
String	getDescription()
MarkdownType	getDescriptionElement()
CodeableConcept	getDomain()
List<CodeableConcept>	getGrade()
CodeableConcept	getGradeFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Reference>	getInformationSource()
Reference	getInformationSourceFirstRep()
List<Reference>	getManufacturer()
Reference	getManufacturerFirstRep()
List<SubstanceDefinition.SubstanceDefinitionMoietyComponent>	getMoiety()
SubstanceDefinition.SubstanceDefinitionMoietyComponent	getMoietyFirstRep()
List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent>	getMolecularWeight()
SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent	getMolecularWeightFirstRep()
List<SubstanceDefinition.SubstanceDefinitionNameComponent>	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
SubstanceDefinition.SubstanceDefinitionNameComponent	getNameFirstRep()
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Reference	getNucleicAcid()
Reference	getPolymer()
List<SubstanceDefinition.SubstanceDefinitionPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
SubstanceDefinition.SubstanceDefinitionPropertyComponent	getPropertyFirstRep()
Reference	getProtein()
Reference	getReferenceInformation()
List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent>	getRelationship()
SubstanceDefinition.SubstanceDefinitionRelationshipComponent	getRelationshipFirstRep()
ResourceType	getResourceType()
SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent	getSourceMaterial()
CodeableConcept	getStatus()
SubstanceDefinition.SubstanceDefinitionStructureComponent	getStructure()
List<Reference>	getSupplier()
Reference	getSupplierFirstRep()
String[]	getTypesForProperty(int hash, String name)
String	getVersion()
StringType	getVersionElement()
boolean	hasCharacterization()
boolean	hasClassification()
boolean	hasCode()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDomain()
boolean	hasGrade()
boolean	hasIdentifier()
boolean	hasInformationSource()
boolean	hasManufacturer()
boolean	hasMoiety()
boolean	hasMolecularWeight()
boolean	hasName()
boolean	hasNote()
boolean	hasNucleicAcid()
boolean	hasPolymer()
boolean	hasProperty()
boolean	hasProtein()
boolean	hasReferenceInformation()
boolean	hasRelationship()
boolean	hasSourceMaterial()
boolean	hasStatus()
boolean	hasStructure()
boolean	hasSupplier()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SubstanceDefinition	setCharacterization(List<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent> theCharacterization)
SubstanceDefinition	setClassification(List<CodeableConcept> theClassification)
SubstanceDefinition	setCode(List<SubstanceDefinition.SubstanceDefinitionCodeComponent> theCode)
SubstanceDefinition	setDescription(String value)
SubstanceDefinition	setDescriptionElement(MarkdownType value)
SubstanceDefinition	setDomain(CodeableConcept value)
SubstanceDefinition	setGrade(List<CodeableConcept> theGrade)
SubstanceDefinition	setIdentifier(List<Identifier> theIdentifier)
SubstanceDefinition	setInformationSource(List<Reference> theInformationSource)
SubstanceDefinition	setManufacturer(List<Reference> theManufacturer)
SubstanceDefinition	setMoiety(List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> theMoiety)
SubstanceDefinition	setMolecularWeight(List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent> theMolecularWeight)
SubstanceDefinition	setName(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theName)
SubstanceDefinition	setNote(List<Annotation> theNote)
SubstanceDefinition	setNucleicAcid(Reference value)
SubstanceDefinition	setPolymer(Reference value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceDefinition	setProperty(List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> theProperty)
SubstanceDefinition	setProtein(Reference value)
SubstanceDefinition	setReferenceInformation(Reference value)
SubstanceDefinition	setRelationship(List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> theRelationship)
SubstanceDefinition	setSourceMaterial(SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent value)
SubstanceDefinition	setStatus(CodeableConcept value)
SubstanceDefinition	setStructure(SubstanceDefinition.SubstanceDefinitionStructureComponent value)
SubstanceDefinition	setSupplier(List<Reference> theSupplier)
SubstanceDefinition	setVersion(String value)
SubstanceDefinition	setVersionElement(StringType value)
protected SubstanceDefinition	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

Identifier by which this substance is known.

version

protected StringType version

A business level version identifier of the substance.

status

protected CodeableConcept status

Status of substance within the catalogue e.g. active, retired.

classification

protected List<CodeableConcept> classification

A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).

domain

protected CodeableConcept domain

If the substance applies to human or veterinary use.

grade

protected List<CodeableConcept> grade

The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

description

protected MarkdownType description

Textual description of the substance.

informationSource

protected List<Reference> informationSource

Supporting literature.

note

protected List<Annotation> note

Textual comment about the substance's catalogue or registry record.

manufacturer

protected List<Reference> manufacturer

The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

supplier

protected List<Reference> supplier

An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

moiety

protected List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> moiety

Moiety, for structural modifications.

characterization

protected List<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent> characterization

General specifications for this substance.

property

protected List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> property

General specifications for this substance.

referenceInformation

protected Reference referenceInformation

General information detailing this substance.

molecularWeight

protected List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent> molecularWeight

The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.

structure

protected SubstanceDefinition.SubstanceDefinitionStructureComponent structure

Structural information.

code

protected List<SubstanceDefinition.SubstanceDefinitionCodeComponent> code

Codes associated with the substance.

name

protected List<SubstanceDefinition.SubstanceDefinitionNameComponent> name

Names applicable to this substance.

relationship

protected List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> relationship

A link between this substance and another, with details of the relationship.

nucleicAcid

protected Reference nucleicAcid

Data items specific to nucleic acids.

polymer

protected Reference polymer

Data items specific to polymers.

protein

protected Reference protein

Data items specific to proteins.

sourceMaterial

protected SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent sourceMaterial

Material or taxonomic/anatomical source for the substance.

SP_CLASSIFICATION

public static final String SP_CLASSIFICATION

Search parameter: classification

Description: High or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain
Type: token
Path: SubstanceDefinition.classification

See Also:

• Constant Field Values

CLASSIFICATION

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

Fluent Client search parameter constant for classification

Description: High or low level categorization, e.g. polymer vs. nucleic acid or linear vs. branch chain
Type: token
Path: SubstanceDefinition.classification

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: The specific code
Type: token
Path: SubstanceDefinition.code.code

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 specific code
Type: token
Path: SubstanceDefinition.code.code

SP_DOMAIN

public static final String SP_DOMAIN

Search parameter: domain

Description: If the substance applies to only human or veterinary use
Type: token
Path: SubstanceDefinition.domain

See Also:

• Constant Field Values

DOMAIN

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

Fluent Client search parameter constant for domain

Description: If the substance applies to only human or veterinary use
Type: token
Path: SubstanceDefinition.domain

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Identifier by which this substance is known
Type: token
Path: SubstanceDefinition.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: Identifier by which this substance is known
Type: token
Path: SubstanceDefinition.identifier

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: The actual name
Type: string
Path: SubstanceDefinition.name.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: The actual name
Type: string
Path: SubstanceDefinition.name.name

Constructor Details

SubstanceDefinition

public SubstanceDefinition()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifier by which this substance is known.)

setIdentifier

public SubstanceDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public SubstanceDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getVersionElement

public StringType getVersionElement()

Returns:

version (A business level version identifier of the substance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

hasVersion

public boolean hasVersion()

setVersionElement

public SubstanceDefinition setVersionElement(StringType value)

Parameters:

value - version (A business level version identifier of the substance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Returns:

A business level version identifier of the substance.

setVersion

public SubstanceDefinition setVersion(String value)

Parameters:

value - A business level version identifier of the substance.

getStatus

public CodeableConcept getStatus()

Returns:

status (Status of substance within the catalogue e.g. active, retired.)

hasStatus

public boolean hasStatus()

setStatus

public SubstanceDefinition setStatus(CodeableConcept value)

Parameters:

value - status (Status of substance within the catalogue e.g. active, retired.)

getClassification

public List<CodeableConcept> getClassification()

Returns:

classification (A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).)

setClassification

public SubstanceDefinition setClassification(List<CodeableConcept> theClassification)

Returns:

Returns a reference to this for easy method chaining

hasClassification

public boolean hasClassification()

addClassification

public CodeableConcept addClassification()

addClassification

public SubstanceDefinition addClassification(CodeableConcept t)

getClassificationFirstRep

public CodeableConcept getClassificationFirstRep()

Returns:

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

getDomain

public CodeableConcept getDomain()

Returns:

domain (If the substance applies to human or veterinary use.)

hasDomain

public boolean hasDomain()

setDomain

public SubstanceDefinition setDomain(CodeableConcept value)

Parameters:

value - domain (If the substance applies to human or veterinary use.)

getGrade

public List<CodeableConcept> getGrade()

Returns:

grade (The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).)

setGrade

public SubstanceDefinition setGrade(List<CodeableConcept> theGrade)

Returns:

Returns a reference to this for easy method chaining

hasGrade

public boolean hasGrade()

addGrade

public CodeableConcept addGrade()

addGrade

public SubstanceDefinition addGrade(CodeableConcept t)

getGradeFirstRep

public CodeableConcept getGradeFirstRep()

Returns:

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

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (Textual description of the substance.). 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 SubstanceDefinition setDescriptionElement(MarkdownType value)

Parameters:

value - description (Textual description of the substance.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Textual description of the substance.

setDescription

public SubstanceDefinition setDescription(String value)

Parameters:

value - Textual description of the substance.

getInformationSource

public List<Reference> getInformationSource()

Returns:

informationSource (Supporting literature.)

setInformationSource

public SubstanceDefinition setInformationSource(List<Reference> theInformationSource)

Returns:

Returns a reference to this for easy method chaining

hasInformationSource

public boolean hasInformationSource()

addInformationSource

public Reference addInformationSource()

addInformationSource

public SubstanceDefinition addInformationSource(Reference t)

getInformationSourceFirstRep

public Reference getInformationSourceFirstRep()

Returns:

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

getNote

public List<Annotation> getNote()

Returns:

note (Textual comment about the substance's catalogue or registry record.)

setNote

public SubstanceDefinition setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public SubstanceDefinition addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getManufacturer

public List<Reference> getManufacturer()

Returns:

manufacturer (The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.)

setManufacturer

public SubstanceDefinition setManufacturer(List<Reference> theManufacturer)

Returns:

Returns a reference to this for easy method chaining

hasManufacturer

public boolean hasManufacturer()

addManufacturer

public Reference addManufacturer()

addManufacturer

public SubstanceDefinition addManufacturer(Reference t)

getManufacturerFirstRep

public Reference getManufacturerFirstRep()

Returns:

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

getSupplier

public List<Reference> getSupplier()

Returns:

supplier (An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.)

setSupplier

public SubstanceDefinition setSupplier(List<Reference> theSupplier)

Returns:

Returns a reference to this for easy method chaining

hasSupplier

public boolean hasSupplier()

addSupplier

public Reference addSupplier()

addSupplier

public SubstanceDefinition addSupplier(Reference t)

getSupplierFirstRep

public Reference getSupplierFirstRep()

Returns:

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

getMoiety

public List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> getMoiety()

Returns:

moiety (Moiety, for structural modifications.)

setMoiety

public SubstanceDefinition setMoiety(List<SubstanceDefinition.SubstanceDefinitionMoietyComponent> theMoiety)

Returns:

Returns a reference to this for easy method chaining

hasMoiety

public boolean hasMoiety()

addMoiety

public SubstanceDefinition.SubstanceDefinitionMoietyComponent addMoiety()

addMoiety

public SubstanceDefinition addMoiety(SubstanceDefinition.SubstanceDefinitionMoietyComponent t)

getMoietyFirstRep

public SubstanceDefinition.SubstanceDefinitionMoietyComponent getMoietyFirstRep()

Returns:

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

getCharacterization

public List<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent> getCharacterization()

Returns:

characterization (General specifications for this substance.)

setCharacterization

public SubstanceDefinition setCharacterization(List<SubstanceDefinition.SubstanceDefinitionCharacterizationComponent> theCharacterization)

Returns:

Returns a reference to this for easy method chaining

hasCharacterization

public boolean hasCharacterization()

addCharacterization

public SubstanceDefinition.SubstanceDefinitionCharacterizationComponent addCharacterization()

addCharacterization

public SubstanceDefinition addCharacterization(SubstanceDefinition.SubstanceDefinitionCharacterizationComponent t)

getCharacterizationFirstRep

public SubstanceDefinition.SubstanceDefinitionCharacterizationComponent getCharacterizationFirstRep()

Returns:

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

getProperty

public List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> getProperty()

Returns:

property (General specifications for this substance.)

setProperty

public SubstanceDefinition setProperty(List<SubstanceDefinition.SubstanceDefinitionPropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public SubstanceDefinition.SubstanceDefinitionPropertyComponent addProperty()

addProperty

public SubstanceDefinition addProperty(SubstanceDefinition.SubstanceDefinitionPropertyComponent t)

getPropertyFirstRep

public SubstanceDefinition.SubstanceDefinitionPropertyComponent getPropertyFirstRep()

Returns:

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

getReferenceInformation

public Reference getReferenceInformation()

Returns:

referenceInformation (General information detailing this substance.)

hasReferenceInformation

public boolean hasReferenceInformation()

setReferenceInformation

public SubstanceDefinition setReferenceInformation(Reference value)

Parameters:

value - referenceInformation (General information detailing this substance.)

getMolecularWeight

public List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent> getMolecularWeight()

Returns:

molecularWeight (The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.)

setMolecularWeight

public SubstanceDefinition setMolecularWeight(List<SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent> theMolecularWeight)

Returns:

Returns a reference to this for easy method chaining

hasMolecularWeight

public boolean hasMolecularWeight()

addMolecularWeight

public SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent addMolecularWeight()

addMolecularWeight

public SubstanceDefinition addMolecularWeight(SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent t)

getMolecularWeightFirstRep

public SubstanceDefinition.SubstanceDefinitionMolecularWeightComponent getMolecularWeightFirstRep()

Returns:

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

getStructure

public SubstanceDefinition.SubstanceDefinitionStructureComponent getStructure()

Returns:

structure (Structural information.)

hasStructure

public boolean hasStructure()

setStructure

public SubstanceDefinition setStructure(SubstanceDefinition.SubstanceDefinitionStructureComponent value)

Parameters:

value - structure (Structural information.)

getCode

public List<SubstanceDefinition.SubstanceDefinitionCodeComponent> getCode()

Returns:

code (Codes associated with the substance.)

setCode

public SubstanceDefinition setCode(List<SubstanceDefinition.SubstanceDefinitionCodeComponent> theCode)

Returns:

Returns a reference to this for easy method chaining

hasCode

public boolean hasCode()

addCode

public SubstanceDefinition.SubstanceDefinitionCodeComponent addCode()

addCode

public SubstanceDefinition addCode(SubstanceDefinition.SubstanceDefinitionCodeComponent t)

getCodeFirstRep

public SubstanceDefinition.SubstanceDefinitionCodeComponent getCodeFirstRep()

Returns:

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

getName

public List<SubstanceDefinition.SubstanceDefinitionNameComponent> getName()

Returns:

name (Names applicable to this substance.)

setName

public SubstanceDefinition setName(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theName)

Returns:

Returns a reference to this for easy method chaining

hasName

public boolean hasName()

addName

public SubstanceDefinition.SubstanceDefinitionNameComponent addName()

addName

public SubstanceDefinition addName(SubstanceDefinition.SubstanceDefinitionNameComponent t)

getNameFirstRep

public SubstanceDefinition.SubstanceDefinitionNameComponent getNameFirstRep()

Returns:

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

getRelationship

public List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> getRelationship()

Returns:

relationship (A link between this substance and another, with details of the relationship.)

setRelationship

public SubstanceDefinition setRelationship(List<SubstanceDefinition.SubstanceDefinitionRelationshipComponent> theRelationship)

Returns:

Returns a reference to this for easy method chaining

hasRelationship

public boolean hasRelationship()

addRelationship

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent addRelationship()

addRelationship

public SubstanceDefinition addRelationship(SubstanceDefinition.SubstanceDefinitionRelationshipComponent t)

getRelationshipFirstRep

public SubstanceDefinition.SubstanceDefinitionRelationshipComponent getRelationshipFirstRep()

Returns:

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

getNucleicAcid

public Reference getNucleicAcid()

Returns:

nucleicAcid (Data items specific to nucleic acids.)

hasNucleicAcid

public boolean hasNucleicAcid()

setNucleicAcid

public SubstanceDefinition setNucleicAcid(Reference value)

Parameters:

value - nucleicAcid (Data items specific to nucleic acids.)

getPolymer

public Reference getPolymer()

Returns:

polymer (Data items specific to polymers.)

hasPolymer

public boolean hasPolymer()

setPolymer

public SubstanceDefinition setPolymer(Reference value)

Parameters:

value - polymer (Data items specific to polymers.)

getProtein

public Reference getProtein()

Returns:

protein (Data items specific to proteins.)

hasProtein

public boolean hasProtein()

setProtein

public SubstanceDefinition setProtein(Reference value)

Parameters:

value - protein (Data items specific to proteins.)

getSourceMaterial

public SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent getSourceMaterial()

Returns:

sourceMaterial (Material or taxonomic/anatomical source for the substance.)

hasSourceMaterial

public boolean hasSourceMaterial()

setSourceMaterial

public SubstanceDefinition setSourceMaterial(SubstanceDefinition.SubstanceDefinitionSourceMaterialComponent value)

Parameters:

value - sourceMaterial (Material or taxonomic/anatomical source for the substance.)

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 SubstanceDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(SubstanceDefinition dst)

typedCopy

protected SubstanceDefinition 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