Class ValueSet.Expansion

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

    Definition: A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed

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

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

        Definition: An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so

      • getIdentifier

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

        Definition: An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so

      • setIdentifier

        public ValueSet.Expansion setIdentifier​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for identifier ()

        Definition: An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so

      • setIdentifier

        public ValueSet.Expansion setIdentifier​(String theUri)
        Sets the value for identifier ()

        Definition: An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so

      • getTimestampElement

        public ca.uhn.fhir.model.primitive.DateTimeDt getTimestampElement()
        Gets the value(s) for timestamp (). creating it if it does not exist. Will not return null.

        Definition: The time at which the expansion was produced by the expanding system.

      • getTimestamp

        public Date getTimestamp()
        Gets the value(s) for timestamp (). creating it if it does not exist. This method may return null.

        Definition: The time at which the expansion was produced by the expanding system.

      • setTimestamp

        public ValueSet.Expansion setTimestamp​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for timestamp ()

        Definition: The time at which the expansion was produced by the expanding system.

      • setTimestamp

        public ValueSet.Expansion setTimestamp​(Date theDate,
                                               ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for timestamp ()

        Definition: The time at which the expansion was produced by the expanding system.

      • getTotalElement

        public ca.uhn.fhir.model.primitive.IntegerDt getTotalElement()
        Gets the value(s) for total (). creating it if it does not exist. Will not return null.

        Definition: The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter

      • getTotal

        public Integer getTotal()
        Gets the value(s) for total (). creating it if it does not exist. This method may return null.

        Definition: The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter

      • setTotal

        public ValueSet.Expansion setTotal​(ca.uhn.fhir.model.primitive.IntegerDt theValue)
        Sets the value(s) for total ()

        Definition: The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter

      • setTotal

        public ValueSet.Expansion setTotal​(int theInteger)
        Sets the value for total ()

        Definition: The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter

      • getOffsetElement

        public ca.uhn.fhir.model.primitive.IntegerDt getOffsetElement()
        Gets the value(s) for offset (). creating it if it does not exist. Will not return null.

        Definition: If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present

      • getOffset

        public Integer getOffset()
        Gets the value(s) for offset (). creating it if it does not exist. This method may return null.

        Definition: If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present

      • setOffset

        public ValueSet.Expansion setOffset​(ca.uhn.fhir.model.primitive.IntegerDt theValue)
        Sets the value(s) for offset ()

        Definition: If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present

      • setOffset

        public ValueSet.Expansion setOffset​(int theInteger)
        Sets the value for offset ()

        Definition: If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present

      • getParameter

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

        Definition: A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion

      • setParameter

        public ValueSet.Expansion setParameter​(List<ValueSet.ExpansionParameter> theValue)
        Sets the value(s) for parameter ()

        Definition: A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion

      • addParameter

        public ValueSet.ExpansionParameter addParameter()
        Adds and returns a new value for parameter ()

        Definition: A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion

      • addParameter

        public ValueSet.Expansion addParameter​(ValueSet.ExpansionParameter theValue)
        Adds a given new value for parameter ()

        Definition: A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion

        Parameters:
        theValue - The parameter to add (must not be null)
      • getParameterFirstRep

        public ValueSet.ExpansionParameter getParameterFirstRep()
        Gets the first repetition for parameter (), creating it if it does not already exist.

        Definition: A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion

      • getContains

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

        Definition: The codes that are contained in the value set expansion

      • getContainsFirstRep

        public ValueSet.ExpansionContains getContainsFirstRep()
        Gets the first repetition for contains (), creating it if it does not already exist.

        Definition: The codes that are contained in the value set expansion