Class ValueSet.CodeSystem

  • 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.CodeSystem
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: ValueSet.codeSystem ()

    Definition: A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly

    See Also:
    Serialized Form
    • Method Detail

      • 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
      • getSystemElement

        public ca.uhn.fhir.model.primitive.UriDt getSystemElement()
        Gets the value(s) for system (). creating it if it does not exist. Will not return null.

        Definition: An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system

      • getSystem

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

        Definition: An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system

      • setSystem

        public ValueSet.CodeSystem setSystem​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for system ()

        Definition: An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system

      • setSystem

        public ValueSet.CodeSystem setSystem​(String theUri)
        Sets the value for system ()

        Definition: An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system

      • getVersionElement

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

        Definition: The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked

      • getVersion

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

        Definition: The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked

      • setVersion

        public ValueSet.CodeSystem setVersion​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for version ()

        Definition: The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked

      • setVersion

        public ValueSet.CodeSystem setVersion​(String theString)
        Sets the value for version ()

        Definition: The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked

      • getCaseSensitiveElement

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

        Definition: If code comparison is case sensitive when codes within this system are compared to each other

      • getCaseSensitive

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

        Definition: If code comparison is case sensitive when codes within this system are compared to each other

      • setCaseSensitive

        public ValueSet.CodeSystem setCaseSensitive​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for caseSensitive ()

        Definition: If code comparison is case sensitive when codes within this system are compared to each other

      • setCaseSensitive

        public ValueSet.CodeSystem setCaseSensitive​(boolean theBoolean)
        Sets the value for caseSensitive ()

        Definition: If code comparison is case sensitive when codes within this system are compared to each other

      • getConcept

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

        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

      • setConcept

        public ValueSet.CodeSystem setConcept​(List<ValueSet.CodeSystemConcept> theValue)
        Sets the value(s) for 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

      • addConcept

        public ValueSet.CodeSystemConcept addConcept()
        Adds and returns a new value for 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

      • addConcept

        public ValueSet.CodeSystem addConcept​(ValueSet.CodeSystemConcept theValue)
        Adds a given new value for 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

        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: 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