Class SubstanceDefinition.Name
- java.lang.Object
 - 
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
 - 
- org.linuxforhealth.fhir.model.type.Element
 - 
- org.linuxforhealth.fhir.model.type.BackboneElement
 - 
- org.linuxforhealth.fhir.model.resource.SubstanceDefinition.Name
 
 
 
 
 
- 
- All Implemented Interfaces:
 Visitable
- Enclosing class:
 - SubstanceDefinition
 
public static class SubstanceDefinition.Name extends BackboneElement
Names applicable to this substance. 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSubstanceDefinition.Name.Builderstatic classSubstanceDefinition.Name.OfficialDetails of the official nature of this name. 
- 
Field Summary
- 
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension 
 - 
 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static SubstanceDefinition.Name.Builderbuilder()booleanequals(java.lang.Object obj)java.util.List<CodeableConcept>getDomain()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.java.util.List<CodeableConcept>getJurisdiction()The jurisdiction where this name applies.java.util.List<CodeableConcept>getLanguage()Human language that the name is written in.StringgetName()The actual name.java.util.List<SubstanceDefinition.Name.Official>getOfficial()Details of the official nature of this name.BooleangetPreferred()If this is the preferred name for this substance.java.util.List<Reference>getSource()Supporting literature.CodeableConceptgetStatus()The status of the name, for example 'current', 'proposed'.java.util.List<SubstanceDefinition.Name>getSynonym()A synonym of this particular name, by which the substance is also known.java.util.List<SubstanceDefinition.Name>getTranslation()A translation for this name into another human language.CodeableConceptgetType()Name type, for example 'systematic', 'scientific, 'brand'.booleanhasChildren()inthashCode()SubstanceDefinition.Name.BuildertoBuilder()Create a new Builder from the contents of this Element- 
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension 
- 
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is 
 - 
 
 - 
 
- 
- 
Method Detail
- 
getName
public String getName()
The actual name.- Returns:
 - An immutable object of type 
Stringthat is non-null. 
 
- 
getType
public CodeableConcept getType()
Name type, for example 'systematic', 'scientific, 'brand'.- Returns:
 - An immutable object of type 
CodeableConceptthat may be null. 
 
- 
getStatus
public CodeableConcept getStatus()
The status of the name, for example 'current', 'proposed'.- Returns:
 - An immutable object of type 
CodeableConceptthat may be null. 
 
- 
getPreferred
public Boolean getPreferred()
If this is the preferred name for this substance.- Returns:
 - An immutable object of type 
Booleanthat may be null. 
 
- 
getLanguage
public java.util.List<CodeableConcept> getLanguage()
Human language that the name is written in.- Returns:
 - An unmodifiable list containing immutable objects of type 
CodeableConceptthat may be empty. 
 
- 
getDomain
public java.util.List<CodeableConcept> getDomain()
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.- Returns:
 - An unmodifiable list containing immutable objects of type 
CodeableConceptthat may be empty. 
 
- 
getJurisdiction
public java.util.List<CodeableConcept> getJurisdiction()
The jurisdiction where this name applies.- Returns:
 - An unmodifiable list containing immutable objects of type 
CodeableConceptthat may be empty. 
 
- 
getSynonym
public java.util.List<SubstanceDefinition.Name> getSynonym()
A synonym of this particular name, by which the substance is also known.- Returns:
 - An unmodifiable list containing immutable objects of type 
SubstanceDefinition.Namethat may be empty. 
 
- 
getTranslation
public java.util.List<SubstanceDefinition.Name> getTranslation()
A translation for this name into another human language.- Returns:
 - An unmodifiable list containing immutable objects of type 
SubstanceDefinition.Namethat may be empty. 
 
- 
getOfficial
public java.util.List<SubstanceDefinition.Name.Official> getOfficial()
Details of the official nature of this name.- Returns:
 - An unmodifiable list containing immutable objects of type 
SubstanceDefinition.Name.Officialthat may be empty. 
 
- 
getSource
public java.util.List<Reference> getSource()
Supporting literature.- Returns:
 - An unmodifiable list containing immutable objects of type 
Referencethat may be empty. 
 
- 
hasChildren
public boolean hasChildren()
- Overrides:
 hasChildrenin classBackboneElement
 
- 
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
 acceptin interfaceVisitable- Specified by:
 acceptin classAbstractVisitable- Parameters:
 elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
 
- 
equals
public boolean equals(java.lang.Object obj)
- Overrides:
 equalsin classjava.lang.Object
 
- 
hashCode
public int hashCode()
- Overrides:
 hashCodein classjava.lang.Object
 
- 
toBuilder
public SubstanceDefinition.Name.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
 toBuilderin classBackboneElement
 
- 
builder
public static SubstanceDefinition.Name.Builder builder()
 
 - 
 
 -