org.hl7.fhir.r4.model

Class SubstanceMoiety

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.Type

org.hl7.fhir.r4.model.BackboneType

org.hl7.fhir.r4.model.SubstanceMoiety

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class SubstanceMoiety
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType

Chemical substances are a single substance type whose primary defining element is the molecular structure. Chemical substances shall be defined on the basis of their complete covalent molecular structure; the presence of a salt (counter-ion) and/or solvates (water, alcohols) is also captured. Purity, grade, physical form or particle size are not taken into account in the definition of a chemical substance or in the assignment of a Substance ID.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SubstanceAmount	amount Used to capture quantitative values for a variety of elements.
protected Identifier	identifier The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.
protected StringType	molecularFormula Molecular formula shall be captured as described in 4.7.3.
protected StringType	name The name of the moiety shall be provided.
protected CodeableConcept	opticalActivity Optical activity shall be captured as described in 4.7.2.
protected CodeableConcept	role The role of the moiety should be specified if there is a specific role the moiety is playing.
protected CodeableConcept	stereochemistry Stereochemistry shall be captured as described in 4.7.1.

Fields inherited from class org.hl7.fhir.r4.model.BackboneType

modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
SubstanceMoiety() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
SubstanceMoiety	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
SubstanceAmount	getAmount()
Identifier	getIdentifier()
String	getMolecularFormula()
StringType	getMolecularFormulaElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
CodeableConcept	getOpticalActivity()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getRole()
CodeableConcept	getStereochemistry()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAmount()
boolean	hasIdentifier()
boolean	hasMolecularFormula()
boolean	hasMolecularFormulaElement()
boolean	hasName()
boolean	hasNameElement()
boolean	hasOpticalActivity()
boolean	hasRole()
boolean	hasStereochemistry()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
SubstanceMoiety	setAmount(SubstanceAmount value)
SubstanceMoiety	setIdentifier(Identifier value)
SubstanceMoiety	setMolecularFormula(String value)
SubstanceMoiety	setMolecularFormulaElement(StringType value)
SubstanceMoiety	setName(String value)
SubstanceMoiety	setNameElement(StringType value)
SubstanceMoiety	setOpticalActivity(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceMoiety	setRole(CodeableConcept value)
SubstanceMoiety	setStereochemistry(CodeableConcept value)
protected SubstanceMoiety	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.BackboneType

addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

addExtension, getExtension, hasExtension

Field Detail

role

protected CodeableConcept role

The role of the moiety should be specified if there is a specific role the moiety is playing.

identifier

protected Identifier identifier

The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.

name

protected StringType name

The name of the moiety shall be provided.

stereochemistry

protected CodeableConcept stereochemistry

Stereochemistry shall be captured as described in 4.7.1.

opticalActivity

protected CodeableConcept opticalActivity

Optical activity shall be captured as described in 4.7.2.

molecularFormula

protected StringType molecularFormula

Molecular formula shall be captured as described in 4.7.3.

amount

protected SubstanceAmount amount

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

Constructor Detail

SubstanceMoiety

public SubstanceMoiety()

Constructor

Method Detail

getRole

public CodeableConcept getRole()

Returns:

role (The role of the moiety should be specified if there is a specific role the moiety is playing.)

hasRole

public boolean hasRole()

setRole

public SubstanceMoiety setRole(CodeableConcept value)

Parameters:

value - role (The role of the moiety should be specified if there is a specific role the moiety is playing.)

getIdentifier

public Identifier getIdentifier()

Returns:

identifier (The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.)

hasIdentifier

public boolean hasIdentifier()

setIdentifier

public SubstanceMoiety setIdentifier(Identifier value)

Parameters:

value - identifier (The unique identifier assigned to the substance representing the moiety based on the ISO 11238 substance controlled vocabulary.)

getNameElement

public StringType getNameElement()

Returns:

name (The name of the moiety shall be provided.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public SubstanceMoiety setNameElement(StringType value)

Parameters:

value - name (The name of the moiety shall be provided.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

The name of the moiety shall be provided.

setName

public SubstanceMoiety setName(String value)

Parameters:

value - The name of the moiety shall be provided.

getStereochemistry

public CodeableConcept getStereochemistry()

Returns:

stereochemistry (Stereochemistry shall be captured as described in 4.7.1.)

hasStereochemistry

public boolean hasStereochemistry()

setStereochemistry

public SubstanceMoiety setStereochemistry(CodeableConcept value)

Parameters:

value - stereochemistry (Stereochemistry shall be captured as described in 4.7.1.)

getOpticalActivity

public CodeableConcept getOpticalActivity()

Returns:

opticalActivity (Optical activity shall be captured as described in 4.7.2.)

hasOpticalActivity

public boolean hasOpticalActivity()

setOpticalActivity

public SubstanceMoiety setOpticalActivity(CodeableConcept value)

Parameters:

value - opticalActivity (Optical activity shall be captured as described in 4.7.2.)

getMolecularFormulaElement

public StringType getMolecularFormulaElement()

Returns:

molecularFormula (Molecular formula shall be captured as described in 4.7.3.). This is the underlying object with id, value and extensions. The accessor "getMolecularFormula" gives direct access to the value

hasMolecularFormulaElement

public boolean hasMolecularFormulaElement()

hasMolecularFormula

public boolean hasMolecularFormula()

setMolecularFormulaElement

public SubstanceMoiety setMolecularFormulaElement(StringType value)

Parameters:

value - molecularFormula (Molecular formula shall be captured as described in 4.7.3.). This is the underlying object with id, value and extensions. The accessor "getMolecularFormula" gives direct access to the value

getMolecularFormula

public String getMolecularFormula()

Returns:

Molecular formula shall be captured as described in 4.7.3.

setMolecularFormula

public SubstanceMoiety setMolecularFormula(String value)

Parameters:

value - Molecular formula shall be captured as described in 4.7.3.

getAmount

public SubstanceAmount getAmount()

Returns:

amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

hasAmount

public boolean hasAmount()

setAmount

public SubstanceMoiety setAmount(SubstanceAmount value)

Parameters:

value - amount (Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneType

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneType

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 BackboneType

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 BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class BackboneType

copy

public SubstanceMoiety copy()

Specified by:

copy in class BackboneType

typedCopy

protected SubstanceMoiety typedCopy()

Specified by:

typedCopy in class Type

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneType

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneType

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneType