Package org.hl7.fhir.r5.model

Class SubstanceDefinition.SubstanceDefinitionNameComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.SubstanceDefinition.SubstanceDefinitionNameComponent

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:

SubstanceDefinition

public static class SubstanceDefinition.SubstanceDefinitionNameComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

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>	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	Human language that the name is written in.
protected StringType	name	The actual name.
protected List<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent>	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 CodeableConcept	status	The status of the name, for example 'current', 'proposed'.
protected List<SubstanceDefinition.SubstanceDefinitionNameComponent>	synonym	A synonym of this particular name, by which the substance is also known.
protected List<SubstanceDefinition.SubstanceDefinitionNameComponent>	translation	A translation for this name into another human language.
protected CodeableConcept	type	Name type, for example 'systematic', 'scientific, 'brand'.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
SubstanceDefinitionNameComponent()	Constructor
SubstanceDefinitionNameComponent(String name)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addDomain()
SubstanceDefinition.SubstanceDefinitionNameComponent	addDomain(CodeableConcept t)
CodeableConcept	addJurisdiction()
SubstanceDefinition.SubstanceDefinitionNameComponent	addJurisdiction(CodeableConcept t)
CodeableConcept	addLanguage()
SubstanceDefinition.SubstanceDefinitionNameComponent	addLanguage(CodeableConcept t)
SubstanceDefinition.SubstanceDefinitionNameOfficialComponent	addOfficial()
SubstanceDefinition.SubstanceDefinitionNameComponent	addOfficial(SubstanceDefinition.SubstanceDefinitionNameOfficialComponent t)
Reference	addSource()
SubstanceDefinition.SubstanceDefinitionNameComponent	addSource(Reference t)
SubstanceDefinition.SubstanceDefinitionNameComponent	addSynonym()
SubstanceDefinition.SubstanceDefinitionNameComponent	addSynonym(SubstanceDefinition.SubstanceDefinitionNameComponent t)
SubstanceDefinition.SubstanceDefinitionNameComponent	addTranslation()
SubstanceDefinition.SubstanceDefinitionNameComponent	addTranslation(SubstanceDefinition.SubstanceDefinitionNameComponent t)
SubstanceDefinition.SubstanceDefinitionNameComponent	copy()
void	copyValues(SubstanceDefinition.SubstanceDefinitionNameComponent 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<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent>	getOfficial()
SubstanceDefinition.SubstanceDefinitionNameOfficialComponent	getOfficialFirstRep()
boolean	getPreferred()
BooleanType	getPreferredElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<Reference>	getSource()
Reference	getSourceFirstRep()
CodeableConcept	getStatus()
List<SubstanceDefinition.SubstanceDefinitionNameComponent>	getSynonym()
SubstanceDefinition.SubstanceDefinitionNameComponent	getSynonymFirstRep()
List<SubstanceDefinition.SubstanceDefinitionNameComponent>	getTranslation()
SubstanceDefinition.SubstanceDefinitionNameComponent	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)
SubstanceDefinition.SubstanceDefinitionNameComponent	setDomain(List<CodeableConcept> theDomain)
SubstanceDefinition.SubstanceDefinitionNameComponent	setJurisdiction(List<CodeableConcept> theJurisdiction)
SubstanceDefinition.SubstanceDefinitionNameComponent	setLanguage(List<CodeableConcept> theLanguage)
SubstanceDefinition.SubstanceDefinitionNameComponent	setName(String value)
SubstanceDefinition.SubstanceDefinitionNameComponent	setNameElement(StringType value)
SubstanceDefinition.SubstanceDefinitionNameComponent	setOfficial(List<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent> theOfficial)
SubstanceDefinition.SubstanceDefinitionNameComponent	setPreferred(boolean value)
SubstanceDefinition.SubstanceDefinitionNameComponent	setPreferredElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceDefinition.SubstanceDefinitionNameComponent	setSource(List<Reference> theSource)
SubstanceDefinition.SubstanceDefinitionNameComponent	setStatus(CodeableConcept value)
SubstanceDefinition.SubstanceDefinitionNameComponent	setSynonym(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theSynonym)
SubstanceDefinition.SubstanceDefinitionNameComponent	setTranslation(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theTranslation)
SubstanceDefinition.SubstanceDefinitionNameComponent	setType(CodeableConcept value)

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

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

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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, executeFunction, 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, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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, for example 'systematic', 'scientific, 'brand'.

status

protected CodeableConcept status

The status of the name, for example 'current', 'proposed'.

preferred

protected BooleanType preferred

If this is the preferred name for this substance.

language

protected List<CodeableConcept> language

Human language that the name is written in.

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

A synonym of this particular name, by which the substance is also known.

translation

protected List<SubstanceDefinition.SubstanceDefinitionNameComponent> translation

A translation for this name into another human language.

official

protected List<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent> official

Details of the official nature of this name.

source

protected List<Reference> source

Supporting literature.

Constructor Details

SubstanceDefinitionNameComponent

public SubstanceDefinitionNameComponent()

Constructor

SubstanceDefinitionNameComponent

public SubstanceDefinitionNameComponent(String 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 SubstanceDefinition.SubstanceDefinitionNameComponent 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 SubstanceDefinition.SubstanceDefinitionNameComponent setName(String value)

Parameters:

value - The actual name.

getType

public CodeableConcept getType()

Returns:

type (Name type, for example 'systematic', 'scientific, 'brand'.)

hasType

public boolean hasType()

setType

public SubstanceDefinition.SubstanceDefinitionNameComponent setType(CodeableConcept value)

Parameters:

value - type (Name type, for example 'systematic', 'scientific, 'brand'.)

getStatus

public CodeableConcept getStatus()

Returns:

status (The status of the name, for example 'current', 'proposed'.)

hasStatus

public boolean hasStatus()

setStatus

public SubstanceDefinition.SubstanceDefinitionNameComponent setStatus(CodeableConcept value)

Parameters:

value - status (The status of the name, for example 'current', 'proposed'.)

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 SubstanceDefinition.SubstanceDefinitionNameComponent 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 SubstanceDefinition.SubstanceDefinitionNameComponent setPreferred(boolean value)

Parameters:

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

getLanguage

public List<CodeableConcept> getLanguage()

Returns:

language (Human language that the name is written in.)

setLanguage

public SubstanceDefinition.SubstanceDefinitionNameComponent setLanguage(List<CodeableConcept> theLanguage)

Returns:

Returns a reference to this for easy method chaining

hasLanguage

public boolean hasLanguage()

addLanguage

public CodeableConcept addLanguage()

addLanguage

public SubstanceDefinition.SubstanceDefinitionNameComponent addLanguage(CodeableConcept t)

getLanguageFirstRep

public CodeableConcept getLanguageFirstRep()

Returns:

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

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 SubstanceDefinition.SubstanceDefinitionNameComponent setDomain(List<CodeableConcept> theDomain)

Returns:

Returns a reference to this for easy method chaining

hasDomain

public boolean hasDomain()

addDomain

public CodeableConcept addDomain()

addDomain

public SubstanceDefinition.SubstanceDefinitionNameComponent addDomain(CodeableConcept t)

getDomainFirstRep

public CodeableConcept getDomainFirstRep()

Returns:

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

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Returns:

jurisdiction (The jurisdiction where this name applies.)

setJurisdiction

public SubstanceDefinition.SubstanceDefinitionNameComponent setJurisdiction(List<CodeableConcept> theJurisdiction)

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

addJurisdiction

public CodeableConcept addJurisdiction()

addJurisdiction

public SubstanceDefinition.SubstanceDefinitionNameComponent addJurisdiction(CodeableConcept t)

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Returns:

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

getSynonym

public List<SubstanceDefinition.SubstanceDefinitionNameComponent> getSynonym()

Returns:

synonym (A synonym of this particular name, by which the substance is also known.)

setSynonym

public SubstanceDefinition.SubstanceDefinitionNameComponent setSynonym(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theSynonym)

Returns:

Returns a reference to this for easy method chaining

hasSynonym

public boolean hasSynonym()

addSynonym

public SubstanceDefinition.SubstanceDefinitionNameComponent addSynonym()

addSynonym

public SubstanceDefinition.SubstanceDefinitionNameComponent addSynonym(SubstanceDefinition.SubstanceDefinitionNameComponent t)

getSynonymFirstRep

public SubstanceDefinition.SubstanceDefinitionNameComponent getSynonymFirstRep()

Returns:

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

getTranslation

public List<SubstanceDefinition.SubstanceDefinitionNameComponent> getTranslation()

Returns:

translation (A translation for this name into another human language.)

setTranslation

public SubstanceDefinition.SubstanceDefinitionNameComponent setTranslation(List<SubstanceDefinition.SubstanceDefinitionNameComponent> theTranslation)

Returns:

Returns a reference to this for easy method chaining

hasTranslation

public boolean hasTranslation()

addTranslation

public SubstanceDefinition.SubstanceDefinitionNameComponent addTranslation()

addTranslation

public SubstanceDefinition.SubstanceDefinitionNameComponent addTranslation(SubstanceDefinition.SubstanceDefinitionNameComponent t)

getTranslationFirstRep

public SubstanceDefinition.SubstanceDefinitionNameComponent getTranslationFirstRep()

Returns:

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

getOfficial

public List<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent> getOfficial()

Returns:

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

setOfficial

public SubstanceDefinition.SubstanceDefinitionNameComponent setOfficial(List<SubstanceDefinition.SubstanceDefinitionNameOfficialComponent> theOfficial)

Returns:

Returns a reference to this for easy method chaining

hasOfficial

public boolean hasOfficial()

addOfficial

public SubstanceDefinition.SubstanceDefinitionNameOfficialComponent addOfficial()

addOfficial

public SubstanceDefinition.SubstanceDefinitionNameComponent addOfficial(SubstanceDefinition.SubstanceDefinitionNameOfficialComponent t)

getOfficialFirstRep

public SubstanceDefinition.SubstanceDefinitionNameOfficialComponent getOfficialFirstRep()

Returns:

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

getSource

public List<Reference> getSource()

Returns:

source (Supporting literature.)

setSource

public SubstanceDefinition.SubstanceDefinitionNameComponent setSource(List<Reference> theSource)

Returns:

Returns a reference to this for easy method chaining

hasSource

public boolean hasSource()

addSource

public Reference addSource()

addSource

public SubstanceDefinition.SubstanceDefinitionNameComponent addSource(Reference t)

getSourceFirstRep

public Reference getSourceFirstRep()

Returns:

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

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

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(SubstanceDefinition.SubstanceDefinitionNameComponent 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

Returns:

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