Package org.hl7.fhir.r4.model

Class SubstanceSpecification.SubstanceSpecificationNameComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.model.SubstanceSpecification.SubstanceSpecificationNameComponent

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.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

SubstanceSpecification

public static class SubstanceSpecification.SubstanceSpecificationNameComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	domain	The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.
protected List<CodeableConcept>	jurisdiction	The jurisdiction where this name applies.
protected List<CodeableConcept>	language	Language of the name.
protected StringType	name	The actual name.
protected List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent>	official	Details of the official nature of this name.
protected BooleanType	preferred	If this is the preferred name for this substance.
protected List<Reference>	source	Supporting literature.
protected List<DocumentReference>	sourceTarget	The actual objects that are the target of the reference (Supporting literature.)
protected CodeableConcept	status	The status of the name.
protected List<SubstanceSpecification.SubstanceSpecificationNameComponent>	synonym	A synonym of this name.
protected List<SubstanceSpecification.SubstanceSpecificationNameComponent>	translation	A translation for this name.
protected CodeableConcept	type	Name type.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SubstanceSpecificationNameComponent()	Constructor
SubstanceSpecificationNameComponent(StringType name)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addDomain()
SubstanceSpecification.SubstanceSpecificationNameComponent	addDomain(CodeableConcept t)
CodeableConcept	addJurisdiction()
SubstanceSpecification.SubstanceSpecificationNameComponent	addJurisdiction(CodeableConcept t)
CodeableConcept	addLanguage()
SubstanceSpecification.SubstanceSpecificationNameComponent	addLanguage(CodeableConcept t)
SubstanceSpecification.SubstanceSpecificationNameOfficialComponent	addOfficial()
SubstanceSpecification.SubstanceSpecificationNameComponent	addOfficial(SubstanceSpecification.SubstanceSpecificationNameOfficialComponent t)
Reference	addSource()
SubstanceSpecification.SubstanceSpecificationNameComponent	addSource(Reference t)
DocumentReference	addSourceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
SubstanceSpecification.SubstanceSpecificationNameComponent	addSynonym()
SubstanceSpecification.SubstanceSpecificationNameComponent	addSynonym(SubstanceSpecification.SubstanceSpecificationNameComponent t)
SubstanceSpecification.SubstanceSpecificationNameComponent	addTranslation()
SubstanceSpecification.SubstanceSpecificationNameComponent	addTranslation(SubstanceSpecification.SubstanceSpecificationNameComponent t)
SubstanceSpecification.SubstanceSpecificationNameComponent	copy()
void	copyValues(SubstanceSpecification.SubstanceSpecificationNameComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getDomain()
CodeableConcept	getDomainFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
List<CodeableConcept>	getLanguage()
CodeableConcept	getLanguageFirstRep()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent>	getOfficial()
SubstanceSpecification.SubstanceSpecificationNameOfficialComponent	getOfficialFirstRep()
boolean	getPreferred()
BooleanType	getPreferredElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getSource()
Reference	getSourceFirstRep()
List<DocumentReference>	getSourceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
CodeableConcept	getStatus()
List<SubstanceSpecification.SubstanceSpecificationNameComponent>	getSynonym()
SubstanceSpecification.SubstanceSpecificationNameComponent	getSynonymFirstRep()
List<SubstanceSpecification.SubstanceSpecificationNameComponent>	getTranslation()
SubstanceSpecification.SubstanceSpecificationNameComponent	getTranslationFirstRep()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDomain()
boolean	hasJurisdiction()
boolean	hasLanguage()
boolean	hasName()
boolean	hasNameElement()
boolean	hasOfficial()
boolean	hasPreferred()
boolean	hasPreferredElement()
boolean	hasSource()
boolean	hasStatus()
boolean	hasSynonym()
boolean	hasTranslation()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setDomain(List<CodeableConcept> theDomain)
SubstanceSpecification.SubstanceSpecificationNameComponent	setJurisdiction(List<CodeableConcept> theJurisdiction)
SubstanceSpecification.SubstanceSpecificationNameComponent	setLanguage(List<CodeableConcept> theLanguage)
SubstanceSpecification.SubstanceSpecificationNameComponent	setName(String value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setNameElement(StringType value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setOfficial(List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent> theOfficial)
SubstanceSpecification.SubstanceSpecificationNameComponent	setPreferred(boolean value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setPreferredElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setSource(List<Reference> theSource)
SubstanceSpecification.SubstanceSpecificationNameComponent	setStatus(CodeableConcept value)
SubstanceSpecification.SubstanceSpecificationNameComponent	setSynonym(List<SubstanceSpecification.SubstanceSpecificationNameComponent> theSynonym)
SubstanceSpecification.SubstanceSpecificationNameComponent	setTranslation(List<SubstanceSpecification.SubstanceSpecificationNameComponent> theTranslation)
SubstanceSpecification.SubstanceSpecificationNameComponent	setType(CodeableConcept value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, 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, castToPopulation, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

name

protected StringType name

The actual name.

type

protected CodeableConcept type

Name type.

status

protected CodeableConcept status

The status of the name.

preferred

protected BooleanType preferred

If this is the preferred name for this substance.

language

protected List<CodeableConcept> language

Language of the name.

domain

protected List<CodeableConcept> domain

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

jurisdiction

protected List<CodeableConcept> jurisdiction

The jurisdiction where this name applies.

synonym

protected List<SubstanceSpecification.SubstanceSpecificationNameComponent> synonym

A synonym of this name.

translation

protected List<SubstanceSpecification.SubstanceSpecificationNameComponent> translation

A translation for this name.

official

protected List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent> official

Details of the official nature of this name.

source

protected List<Reference> source

Supporting literature.

sourceTarget

protected List<DocumentReference> sourceTarget

The actual objects that are the target of the reference (Supporting literature.)

Constructor Details

SubstanceSpecificationNameComponent

public SubstanceSpecificationNameComponent()

Constructor

SubstanceSpecificationNameComponent

public SubstanceSpecificationNameComponent(StringType name)

Constructor

Method Details

getNameElement

public StringType getNameElement()

Returns:

name (The actual name.). 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 SubstanceSpecification.SubstanceSpecificationNameComponent setNameElement(StringType value)

Parameters:

value - name (The actual name.). 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 actual name.

setName

public SubstanceSpecification.SubstanceSpecificationNameComponent setName(String value)

Parameters:

value - The actual name.

getType

public CodeableConcept getType()

Returns:

type (Name type.)

hasType

public boolean hasType()

setType

public SubstanceSpecification.SubstanceSpecificationNameComponent setType(CodeableConcept value)

Parameters:

value - type (Name type.)

getStatus

public CodeableConcept getStatus()

Returns:

status (The status of the name.)

hasStatus

public boolean hasStatus()

setStatus

public SubstanceSpecification.SubstanceSpecificationNameComponent setStatus(CodeableConcept value)

Parameters:

value - status (The status of the name.)

getPreferredElement

public BooleanType getPreferredElement()

Returns:

preferred (If this is the preferred name for this substance.). This is the underlying object with id, value and extensions. The accessor "getPreferred" gives direct access to the value

hasPreferredElement

public boolean hasPreferredElement()

hasPreferred

public boolean hasPreferred()

setPreferredElement

public SubstanceSpecification.SubstanceSpecificationNameComponent setPreferredElement(BooleanType value)

Parameters:

value - preferred (If this is the preferred name for this substance.). This is the underlying object with id, value and extensions. The accessor "getPreferred" gives direct access to the value

getPreferred

public boolean getPreferred()

Returns:

If this is the preferred name for this substance.

setPreferred

public SubstanceSpecification.SubstanceSpecificationNameComponent setPreferred(boolean value)

Parameters:

value - If this is the preferred name for this substance.

getLanguage

public List<CodeableConcept> getLanguage()

Returns:

language (Language of the name.)

setLanguage

public SubstanceSpecification.SubstanceSpecificationNameComponent setLanguage(List<CodeableConcept> theLanguage)

Returns:

Returns a reference to this for easy method chaining

hasLanguage

public boolean hasLanguage()

addLanguage

public CodeableConcept addLanguage()

addLanguage

public SubstanceSpecification.SubstanceSpecificationNameComponent addLanguage(CodeableConcept t)

getLanguageFirstRep

public CodeableConcept getLanguageFirstRep()

Returns:

The first repetition of repeating field language, creating it if it does not already exist

getDomain

public List<CodeableConcept> getDomain()

Returns:

domain (The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.)

setDomain

public SubstanceSpecification.SubstanceSpecificationNameComponent setDomain(List<CodeableConcept> theDomain)

Returns:

Returns a reference to this for easy method chaining

hasDomain

public boolean hasDomain()

addDomain

public CodeableConcept addDomain()

addDomain

public SubstanceSpecification.SubstanceSpecificationNameComponent addDomain(CodeableConcept t)

getDomainFirstRep

public CodeableConcept getDomainFirstRep()

Returns:

The first repetition of repeating field domain, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Returns:

jurisdiction (The jurisdiction where this name applies.)

setJurisdiction

public SubstanceSpecification.SubstanceSpecificationNameComponent setJurisdiction(List<CodeableConcept> theJurisdiction)

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

addJurisdiction

public CodeableConcept addJurisdiction()

addJurisdiction

public SubstanceSpecification.SubstanceSpecificationNameComponent addJurisdiction(CodeableConcept t)

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Returns:

The first repetition of repeating field jurisdiction, creating it if it does not already exist

getSynonym

public List<SubstanceSpecification.SubstanceSpecificationNameComponent> getSynonym()

Returns:

synonym (A synonym of this name.)

setSynonym

public SubstanceSpecification.SubstanceSpecificationNameComponent setSynonym(List<SubstanceSpecification.SubstanceSpecificationNameComponent> theSynonym)

Returns:

Returns a reference to this for easy method chaining

hasSynonym

public boolean hasSynonym()

addSynonym

public SubstanceSpecification.SubstanceSpecificationNameComponent addSynonym()

addSynonym

public SubstanceSpecification.SubstanceSpecificationNameComponent addSynonym(SubstanceSpecification.SubstanceSpecificationNameComponent t)

getSynonymFirstRep

public SubstanceSpecification.SubstanceSpecificationNameComponent getSynonymFirstRep()

Returns:

The first repetition of repeating field synonym, creating it if it does not already exist

getTranslation

public List<SubstanceSpecification.SubstanceSpecificationNameComponent> getTranslation()

Returns:

translation (A translation for this name.)

setTranslation

public SubstanceSpecification.SubstanceSpecificationNameComponent setTranslation(List<SubstanceSpecification.SubstanceSpecificationNameComponent> theTranslation)

Returns:

Returns a reference to this for easy method chaining

hasTranslation

public boolean hasTranslation()

addTranslation

public SubstanceSpecification.SubstanceSpecificationNameComponent addTranslation()

addTranslation

public SubstanceSpecification.SubstanceSpecificationNameComponent addTranslation(SubstanceSpecification.SubstanceSpecificationNameComponent t)

getTranslationFirstRep

public SubstanceSpecification.SubstanceSpecificationNameComponent getTranslationFirstRep()

Returns:

The first repetition of repeating field translation, creating it if it does not already exist

getOfficial

public List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent> getOfficial()

Returns:

official (Details of the official nature of this name.)

setOfficial

public SubstanceSpecification.SubstanceSpecificationNameComponent setOfficial(List<SubstanceSpecification.SubstanceSpecificationNameOfficialComponent> theOfficial)

Returns:

Returns a reference to this for easy method chaining

hasOfficial

public boolean hasOfficial()

addOfficial

public SubstanceSpecification.SubstanceSpecificationNameOfficialComponent addOfficial()

addOfficial

public SubstanceSpecification.SubstanceSpecificationNameComponent addOfficial(SubstanceSpecification.SubstanceSpecificationNameOfficialComponent t)

getOfficialFirstRep

public SubstanceSpecification.SubstanceSpecificationNameOfficialComponent getOfficialFirstRep()

Returns:

The first repetition of repeating field official, creating it if it does not already exist

getSource

public List<Reference> getSource()

Returns:

source (Supporting literature.)

setSource

public SubstanceSpecification.SubstanceSpecificationNameComponent setSource(List<Reference> theSource)

Returns:

Returns a reference to this for easy method chaining

hasSource

public boolean hasSource()

addSource

public Reference addSource()

addSource

public SubstanceSpecification.SubstanceSpecificationNameComponent addSource(Reference t)

getSourceFirstRep

public Reference getSourceFirstRep()

Returns:

The first repetition of repeating field source, creating it if it does not already exist

getSourceTarget

@Deprecated
public List<DocumentReference> getSourceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addSourceTarget

@Deprecated
public DocumentReference addSourceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public SubstanceSpecification.SubstanceSpecificationNameComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(SubstanceSpecification.SubstanceSpecificationNameComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement