java.lang.Object
- org.hl7.fhir.r5.model.Base
- - org.hl7.fhir.r5.model.Element
  - - org.hl7.fhir.r5.model.BackboneElement
    - - org.hl7.fhir.r5.model.ValueSet.ValueSetComposeComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

ValueSet
```
public static class ValueSet.ValueSetComposeComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected List<ValueSet.ConceptSetComponent>`	`exclude`	Exclude one or more codes from the value set based on code system filters and/or other value sets.
`protected BooleanType`	`inactive`	Whether inactive codes - codes that are not approved for current use - are in the value set.
`protected List<ValueSet.ConceptSetComponent>`	`include`	Include one or more codes from a code system or other value set(s).
`protected DateType`	`lockedDate`	The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
`protected List<StringType>`	`property`	A property to return in the expansion, if the client doesn't ask for any particular properties.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element
extension, id

Constructor Summary

Constructors
Constructor Description

ValueSetComposeComponent()
Constructor

ValueSetComposeComponent(ValueSet.ConceptSetComponent include)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`ValueSet.ConceptSetComponent`	`addExclude()`
`ValueSet.ValueSetComposeComponent`	`addExclude(ValueSet.ConceptSetComponent t)`
`ValueSet.ConceptSetComponent`	`addInclude()`
`ValueSet.ValueSetComposeComponent`	`addInclude(ValueSet.ConceptSetComponent t)`
`ValueSet.ValueSetComposeComponent`	`addProperty(String value)`
`StringType`	`addPropertyElement()`
`ValueSet.ValueSetComposeComponent`	`copy()`
`void`	`copyValues(ValueSet.ValueSetComposeComponent dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<ValueSet.ConceptSetComponent>`	`getExclude()`
`ValueSet.ConceptSetComponent`	`getExcludeFirstRep()`
`boolean`	`getInactive()`
`BooleanType`	`getInactiveElement()`
`List<ValueSet.ConceptSetComponent>`	`getInclude()`
`ValueSet.ConceptSetComponent`	`getIncludeFirstRep()`
`Date`	`getLockedDate()`
`DateType`	`getLockedDateElement()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`List<StringType>`	`getProperty()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasExclude()`
`boolean`	`hasInactive()`
`boolean`	`hasInactiveElement()`
`boolean`	`hasInclude()`
`boolean`	`hasLockedDate()`
`boolean`	`hasLockedDateElement()`
`boolean`	`hasProperty()`
`boolean`	`hasProperty(String value)`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`ValueSet.ValueSetComposeComponent`	`setExclude(List<ValueSet.ConceptSetComponent> theExclude)`
`ValueSet.ValueSetComposeComponent`	`setInactive(boolean value)`
`ValueSet.ValueSetComposeComponent`	`setInactiveElement(BooleanType value)`
`ValueSet.ValueSetComposeComponent`	`setInclude(List<ValueSet.ConceptSetComponent> theInclude)`
`ValueSet.ValueSetComposeComponent`	`setLockedDate(Date value)`
`ValueSet.ValueSetComposeComponent`	`setLockedDateElement(DateType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ValueSet.ValueSetComposeComponent`	`setProperty(List<StringType> theProperty)`

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - lockedDate
```
protected DateType lockedDate
```
    The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
  - inactive
```
protected BooleanType inactive
```
    Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
  - include
```
protected List<ValueSet.ConceptSetComponent> include
```
    Include one or more codes from a code system or other value set(s).
  - exclude
```
protected List<ValueSet.ConceptSetComponent> exclude
```
    Exclude one or more codes from the value set based on code system filters and/or other value sets.
  - property
```
protected List<StringType> property
```
    A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.
- Constructor Detail
  - ValueSetComposeComponent
```
public ValueSetComposeComponent()
```
    Constructor
  - ValueSetComposeComponent
```
public ValueSetComposeComponent(ValueSet.ConceptSetComponent include)
```
    Constructor
- Method Detail
  - getLockedDateElement
```
public DateType getLockedDateElement()
```
    Returns:
    
    lockedDate (The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value
  - hasLockedDateElement
```
public boolean hasLockedDateElement()
```
  - hasLockedDate
```
public boolean hasLockedDate()
```
  - setLockedDateElement
```
public ValueSet.ValueSetComposeComponent setLockedDateElement(DateType value)
```
    Parameters:
    
    value - lockedDate (The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value
  - getLockedDate
```
public Date getLockedDate()
```
    Returns:
    
    The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
  - setLockedDate
```
public ValueSet.ValueSetComposeComponent setLockedDate(Date value)
```
    Parameters:
    
    value - The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
  - getInactiveElement
```
public BooleanType getInactiveElement()
```
    Returns:
    
    inactive (Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).). This is the underlying object with id, value and extensions. The accessor "getInactive" gives direct access to the value
  - hasInactiveElement
```
public boolean hasInactiveElement()
```
  - hasInactive
```
public boolean hasInactive()
```
  - setInactiveElement
```
public ValueSet.ValueSetComposeComponent setInactiveElement(BooleanType value)
```
    Parameters:
    
    value - inactive (Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).). This is the underlying object with id, value and extensions. The accessor "getInactive" gives direct access to the value
  - getInactive
```
public boolean getInactive()
```
    Returns:
    
    Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
  - setInactive
```
public ValueSet.ValueSetComposeComponent setInactive(boolean value)
```
    Parameters:
    
    value - Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
  - getInclude
```
public List<ValueSet.ConceptSetComponent> getInclude()
```
    Returns:
    
    include (Include one or more codes from a code system or other value set(s).)
  - setInclude
```
public ValueSet.ValueSetComposeComponent setInclude(List<ValueSet.ConceptSetComponent> theInclude)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasInclude
```
public boolean hasInclude()
```
  - addInclude
```
public ValueSet.ConceptSetComponent addInclude()
```
  - addInclude
```
public ValueSet.ValueSetComposeComponent addInclude(ValueSet.ConceptSetComponent t)
```
  - getIncludeFirstRep
```
public ValueSet.ConceptSetComponent getIncludeFirstRep()
```
    Returns:
    
    The first repetition of repeating field include, creating it if it does not already exist {3}
  - getExclude
```
public List<ValueSet.ConceptSetComponent> getExclude()
```
    Returns:
    
    exclude (Exclude one or more codes from the value set based on code system filters and/or other value sets.)
  - setExclude
```
public ValueSet.ValueSetComposeComponent setExclude(List<ValueSet.ConceptSetComponent> theExclude)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasExclude
```
public boolean hasExclude()
```
  - addExclude
```
public ValueSet.ConceptSetComponent addExclude()
```
  - addExclude
```
public ValueSet.ValueSetComposeComponent addExclude(ValueSet.ConceptSetComponent t)
```
  - getExcludeFirstRep
```
public ValueSet.ConceptSetComponent getExcludeFirstRep()
```
    Returns:
    
    The first repetition of repeating field exclude, creating it if it does not already exist {3}
  - getProperty
```
public List<StringType> getProperty()
```
    Returns:
    
    property (A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.)
  - setProperty
```
public ValueSet.ValueSetComposeComponent setProperty(List<StringType> theProperty)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasProperty
```
public boolean hasProperty()
```
  - addPropertyElement
```
public StringType addPropertyElement()
```
    Returns:
    
    property (A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.)
  - addProperty
```
public ValueSet.ValueSetComposeComponent addProperty(String value)
```
    Parameters:
    
    value - property (A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.)
  - hasProperty
```
public boolean hasProperty(String value)
```
    Parameters:
    
    value - property (A property to return in the expansion, if the client doesn't ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value '*' means all properties known to the server.)
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public ValueSet.ValueSetComposeComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - copyValues
```
public void copyValues(ValueSet.ValueSetComposeComponent dst)
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class BackboneElement

Constructor	Description
`ValueSetComposeComponent()`	Constructor
`ValueSetComposeComponent(ValueSet.ConceptSetComponent include)`	Constructor

Class ValueSet.ValueSetComposeComponent

Field Summary

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

Fields inherited from class org.hl7.fhir.r5.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

Methods inherited from class org.hl7.fhir.r5.model.Element

Methods inherited from class org.hl7.fhir.r5.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

lockedDate

inactive

include

exclude

property

Constructor Detail

ValueSetComposeComponent

ValueSetComposeComponent

Method Detail

getLockedDateElement

hasLockedDateElement

hasLockedDate

setLockedDateElement

getLockedDate

setLockedDate

getInactiveElement

hasInactiveElement

hasInactive

setInactiveElement

getInactive

setInactive

getInclude

setInclude

hasInclude

addInclude

addInclude

getIncludeFirstRep

getExclude

setExclude

hasExclude

addExclude

addExclude

getExcludeFirstRep

getProperty

setProperty

hasProperty

addPropertyElement

addProperty

hasProperty

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

copyValues

equalsDeep

equalsShallow

isEmpty

fhirType