Class CodeSystem.Concept
- 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.CodeSystem.Concept
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- CodeSystem
public static class CodeSystem.Concept extends BackboneElement
Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CodeSystem.Concept.Builder
static class
CodeSystem.Concept.Designation
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.static class
CodeSystem.Concept.Property
A property value for this concept.
-
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 CodeSystem.Concept.Builder
builder()
boolean
equals(java.lang.Object obj)
Code
getCode()
A code - a text symbol - that uniquely identifies the concept within the code system.java.util.List<CodeSystem.Concept>
getConcept()
Defines children of a concept to produce a hierarchy of concepts.String
getDefinition()
The formal definition of the concept.java.util.List<CodeSystem.Concept.Designation>
getDesignation()
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.String
getDisplay()
A human readable string that is the recommended default way to present this concept to a user.java.util.List<CodeSystem.Concept.Property>
getProperty()
A property value for this concept.boolean
hasChildren()
int
hashCode()
CodeSystem.Concept.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
-
getCode
public Code getCode()
A code - a text symbol - that uniquely identifies the concept within the code system.- Returns:
- An immutable object of type
Code
that is non-null.
-
getDisplay
public String getDisplay()
A human readable string that is the recommended default way to present this concept to a user.- Returns:
- An immutable object of type
String
that may be null.
-
getDefinition
public String getDefinition()
The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.- Returns:
- An immutable object of type
String
that may be null.
-
getDesignation
public java.util.List<CodeSystem.Concept.Designation> getDesignation()
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.- Returns:
- An unmodifiable list containing immutable objects of type
CodeSystem.Concept.Designation
that may be empty.
-
getProperty
public java.util.List<CodeSystem.Concept.Property> getProperty()
A property value for this concept.- Returns:
- An unmodifiable list containing immutable objects of type
CodeSystem.Concept.Property
that may be empty.
-
getConcept
public java.util.List<CodeSystem.Concept> getConcept()
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is- a/contains/categorizes) - see hierarchyMeaning.- Returns:
- An unmodifiable list containing immutable objects of type
CodeSystem.Concept
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 CodeSystem.Concept.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 CodeSystem.Concept.Builder builder()
-
-