Package ca.uhn.fhir.model.dstu2.resource

Class ValueSet.CodeSystemConcept

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.resource.ValueSet.CodeSystemConcept
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
Enclosing class:
ValueSet
public static class ValueSet.CodeSystemConcept
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.IResourceBlock
Block class for child element: ValueSet.codeSystem.concept ()

Definition: Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are

See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getCodeElement

      public ca.uhn.fhir.model.primitive.CodeDt getCodeElement()
      Gets the value(s) for code (). creating it if it does not exist. Will not return null.

      Definition: A code - a text symbol - that uniquely identifies the concept within the code system

    • getCode

      public String getCode()
      Gets the value(s) for code (). creating it if it does not exist. This method may return null.

      Definition: A code - a text symbol - that uniquely identifies the concept within the code system

    • setCode

      public ValueSet.CodeSystemConcept setCode​(ca.uhn.fhir.model.primitive.CodeDt theValue)
      Sets the value(s) for code ()

      Definition: A code - a text symbol - that uniquely identifies the concept within the code system

    • setCode

      public ValueSet.CodeSystemConcept setCode​(String theCode)
      Sets the value for code ()

      Definition: A code - a text symbol - that uniquely identifies the concept within the code system

    • getAbstractElement

      public ca.uhn.fhir.model.primitive.BooleanDt getAbstractElement()
      Gets the value(s) for abstract (). creating it if it does not exist. Will not return null.

      Definition: If this code is not for use as a real concept

    • getAbstract

      public Boolean getAbstract()
      Gets the value(s) for abstract (). creating it if it does not exist. This method may return null.

      Definition: If this code is not for use as a real concept

    • setAbstract

      public ValueSet.CodeSystemConcept setAbstract​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for abstract ()

      Definition: If this code is not for use as a real concept

    • setAbstract

      public ValueSet.CodeSystemConcept setAbstract​(boolean theBoolean)
      Sets the value for abstract ()

      Definition: If this code is not for use as a real concept

    • getDisplayElement

      public ca.uhn.fhir.model.primitive.StringDt getDisplayElement()
      Gets the value(s) for display (). creating it if it does not exist. Will not return null.

      Definition: A human readable string that is the recommended default way to present this concept to a user

    • getDisplay

      public String getDisplay()
      Gets the value(s) for display (). creating it if it does not exist. This method may return null.

      Definition: A human readable string that is the recommended default way to present this concept to a user

    • setDisplay

      public ValueSet.CodeSystemConcept setDisplay​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for display ()

      Definition: A human readable string that is the recommended default way to present this concept to a user

    • setDisplay

      public ValueSet.CodeSystemConcept setDisplay​(String theString)
      Sets the value for display ()

      Definition: A human readable string that is the recommended default way to present this concept to a user

    • getDefinitionElement

      public ca.uhn.fhir.model.primitive.StringDt getDefinitionElement()
      Gets the value(s) for definition (). creating it if it does not exist. Will not return null.

      Definition: The formal definition of the concept. The value set 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

    • getDefinition

      public String getDefinition()
      Gets the value(s) for definition (). creating it if it does not exist. This method may return null.

      Definition: The formal definition of the concept. The value set 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

    • setDefinition

      public ValueSet.CodeSystemConcept setDefinition​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for definition ()

      Definition: The formal definition of the concept. The value set 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

    • setDefinition

      public ValueSet.CodeSystemConcept setDefinition​(String theString)
      Sets the value for definition ()

      Definition: The formal definition of the concept. The value set 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

    • getDesignation

      public List<ValueSet.CodeSystemConceptDesignation> getDesignation()
      Gets the value(s) for designation (). creating it if it does not exist. Will not return null.

      Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

    • setDesignation

      public ValueSet.CodeSystemConcept setDesignation​(List<ValueSet.CodeSystemConceptDesignation> theValue)
      Sets the value(s) for designation ()

      Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

    • addDesignation

      public ValueSet.CodeSystemConceptDesignation addDesignation()
      Adds and returns a new value for designation ()

      Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

    • addDesignation

      public ValueSet.CodeSystemConcept addDesignation​(ValueSet.CodeSystemConceptDesignation theValue)
      Adds a given new value for designation ()

      Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

      Parameters:
      theValue - The designation to add (must not be null)

    • getDesignationFirstRep

      public ValueSet.CodeSystemConceptDesignation getDesignationFirstRep()
      Gets the first repetition for designation (), creating it if it does not already exist.

      Definition: Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

    • getConcept

      public List<ValueSet.CodeSystemConcept> getConcept()
      Gets the value(s) for concept (). creating it if it does not exist. Will not return null.

      Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts

    • setConcept

      public ValueSet.CodeSystemConcept setConcept​(List<ValueSet.CodeSystemConcept> theValue)
      Sets the value(s) for concept ()

      Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts

    • addConcept

      public ValueSet.CodeSystemConcept addConcept()
      Adds and returns a new value for concept ()

      Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts

    • addConcept

      public ValueSet.CodeSystemConcept addConcept​(ValueSet.CodeSystemConcept theValue)
      Adds a given new value for concept ()

      Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts

      Parameters:
      theValue - The concept to add (must not be null)

    • getConceptFirstRep

      public ValueSet.CodeSystemConcept getConceptFirstRep()
      Gets the first repetition for concept (), creating it if it does not already exist.

      Definition: Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts