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 class
SubstanceDefinition.Name.Builder
static class
SubstanceDefinition.Name.Official
Details 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 void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static SubstanceDefinition.Name.Builder
builder()
boolean
equals(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.String
getName()
The actual name.java.util.List<SubstanceDefinition.Name.Official>
getOfficial()
Details of the official nature of this name.Boolean
getPreferred()
If this is the preferred name for this substance.java.util.List<Reference>
getSource()
Supporting literature.CodeableConcept
getStatus()
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.CodeableConcept
getType()
Name type, for example 'systematic', 'scientific, 'brand'.boolean
hasChildren()
int
hashCode()
SubstanceDefinition.Name.Builder
toBuilder()
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
String
that is non-null.
-
getType
public CodeableConcept getType()
Name type, for example 'systematic', 'scientific, 'brand'.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStatus
public CodeableConcept getStatus()
The status of the name, for example 'current', 'proposed'.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getPreferred
public Boolean getPreferred()
If this is the preferred name for this substance.- Returns:
- An immutable object of type
Boolean
that 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
CodeableConcept
that 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
CodeableConcept
that 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
CodeableConcept
that 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.Name
that 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.Name
that 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.Official
that may be empty.
-
getSource
public java.util.List<Reference> getSource()
Supporting literature.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept 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:
accept
in interfaceVisitable
- Specified by:
accept
in 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:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public SubstanceDefinition.Name.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static SubstanceDefinition.Name.Builder builder()
-
-