ValueSet (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.ValueSet

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class ValueSet
extends BaseResource
implements IResource
```
HAPI/FHIR ValueSet Resource (conformance.terminology)
Definition: A value set specifies a set of codes drawn from one or more code systems.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/ValueSet

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ValueSet.CodeSystem` Block class for child element: ValueSet.codeSystem ()
`static class`	`ValueSet.CodeSystemConcept` Block class for child element: ValueSet.codeSystem.concept ()
`static class`	`ValueSet.CodeSystemConceptDesignation` Block class for child element: ValueSet.codeSystem.concept.designation ()
`static class`	`ValueSet.Compose` Block class for child element: ValueSet.compose ()
`static class`	`ValueSet.ComposeInclude` Block class for child element: ValueSet.compose.include ()
`static class`	`ValueSet.ComposeIncludeConcept` Block class for child element: ValueSet.compose.include.concept ()
`static class`	`ValueSet.ComposeIncludeFilter` Block class for child element: ValueSet.compose.include.filter ()
`static class`	`ValueSet.Contact` Block class for child element: ValueSet.contact ()
`static class`	`ValueSet.Expansion` Block class for child element: ValueSet.expansion ()
`static class`	`ValueSet.ExpansionContains` Block class for child element: ValueSet.expansion.contains ()
`static class`	`ValueSet.ExpansionParameter` Block class for child element: ValueSet.expansion.parameter ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static TokenClientParam`	`CONTEXT` Fluent Client search parameter constant for context
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`static UriClientParam`	`EXPANSION` Fluent Client search parameter constant for expansion
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static StringClientParam`	`PUBLISHER` Fluent Client search parameter constant for publisher
`static UriClientParam`	`REFERENCE` Fluent Client search parameter constant for reference
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_CONTEXT` Search parameter constant for context
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DESCRIPTION` Search parameter constant for description
`static String`	`SP_EXPANSION` Search parameter constant for expansion
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_PUBLISHER` Search parameter constant for publisher
`static String`	`SP_REFERENCE` Search parameter constant for reference
`static String`	`SP_STATUS` Search parameter constant for status
`static String`	`SP_SYSTEM` Search parameter constant for system
`static String`	`SP_URL` Search parameter constant for url
`static String`	`SP_VERSION` Search parameter constant for version
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static UriClientParam`	`SYSTEM` Fluent Client search parameter constant for system
`static UriClientParam`	`URL` Fluent Client search parameter constant for url
`static TokenClientParam`	`VERSION` Fluent Client search parameter constant for version

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

ValueSet()

Constructors
Constructor and Description
`ValueSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ValueSet.Contact`	`addContact()` Adds and returns a new value for contact ()
`ValueSet`	`addContact(ValueSet.Contact theValue)` Adds a given new value for contact ()
`CodeableConceptDt`	`addUseContext()` Adds and returns a new value for useContext ()
`ValueSet`	`addUseContext(CodeableConceptDt theValue)` Adds a given new value for useContext ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ValueSet.CodeSystem`	`getCodeSystem()` Gets the value(s) for codeSystem ().
`ValueSet.Compose`	`getCompose()` Gets the value(s) for compose ().
`List<ValueSet.Contact>`	`getContact()` Gets the value(s) for contact ().
`ValueSet.Contact`	`getContactFirstRep()` Gets the first repetition for contact (), creating it if it does not already exist.
`String`	`getCopyright()` Gets the value(s) for copyright ().
`StringDt`	`getCopyrightElement()` Gets the value(s) for copyright ().
`Date`	`getDate()` Gets the value(s) for date (when.recorded).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.recorded).
`String`	`getDescription()` Gets the value(s) for description ().
`StringDt`	`getDescriptionElement()` Gets the value(s) for description ().
`ValueSet.Expansion`	`getExpansion()` Gets the value(s) for expansion ().
`Boolean`	`getExperimental()` Gets the value(s) for experimental (class).
`BooleanDt`	`getExperimentalElement()` Gets the value(s) for experimental (class).
`Boolean`	`getExtensible()` Gets the value(s) for extensible ().
`BooleanDt`	`getExtensibleElement()` Gets the value(s) for extensible ().
`IdentifierDt`	`getIdentifier()` Gets the value(s) for identifier (id).
`Boolean`	`getImmutable()` Gets the value(s) for immutable ().
`BooleanDt`	`getImmutableElement()` Gets the value(s) for immutable ().
`Date`	`getLockedDate()` Gets the value(s) for lockedDate (when.init).
`DateDt`	`getLockedDateElement()` Gets the value(s) for lockedDate (when.init).
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`String`	`getPublisher()` Gets the value(s) for publisher (who.witness).
`StringDt`	`getPublisherElement()` Gets the value(s) for publisher (who.witness).
`String`	`getRequirements()` Gets the value(s) for requirements ().
`StringDt`	`getRequirementsElement()` Gets the value(s) for requirements ().
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<ConformanceResourceStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`String`	`getUrl()` Gets the value(s) for url (id).
`UriDt`	`getUrlElement()` Gets the value(s) for url (id).
`List<CodeableConceptDt>`	`getUseContext()` Gets the value(s) for useContext ().
`CodeableConceptDt`	`getUseContextFirstRep()` Gets the first repetition for useContext (), creating it if it does not already exist.
`String`	`getVersion()` Gets the value(s) for version (id.version).
`StringDt`	`getVersionElement()` Gets the value(s) for version (id.version).
`boolean`	`isEmpty()`
`ValueSet`	`setCodeSystem(ValueSet.CodeSystem theValue)` Sets the value(s) for codeSystem ()
`ValueSet`	`setCompose(ValueSet.Compose theValue)` Sets the value(s) for compose ()
`ValueSet`	`setContact(List<ValueSet.Contact> theValue)` Sets the value(s) for contact ()
`ValueSet`	`setCopyright(String theString)` Sets the value for copyright ()
`ValueSet`	`setCopyright(StringDt theValue)` Sets the value(s) for copyright ()
`ValueSet`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.recorded)
`ValueSet`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.recorded)
`ValueSet`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.recorded)
`ValueSet`	`setDescription(String theString)` Sets the value for description ()
`ValueSet`	`setDescription(StringDt theValue)` Sets the value(s) for description ()
`ValueSet`	`setExpansion(ValueSet.Expansion theValue)` Sets the value(s) for expansion ()
`ValueSet`	`setExperimental(boolean theBoolean)` Sets the value for experimental (class)
`ValueSet`	`setExperimental(BooleanDt theValue)` Sets the value(s) for experimental (class)
`ValueSet`	`setExtensible(boolean theBoolean)` Sets the value for extensible ()
`ValueSet`	`setExtensible(BooleanDt theValue)` Sets the value(s) for extensible ()
`ValueSet`	`setIdentifier(IdentifierDt theValue)` Sets the value(s) for identifier (id)
`ValueSet`	`setImmutable(boolean theBoolean)` Sets the value for immutable ()
`ValueSet`	`setImmutable(BooleanDt theValue)` Sets the value(s) for immutable ()
`ValueSet`	`setLockedDate(DateDt theValue)` Sets the value(s) for lockedDate (when.init)
`ValueSet`	`setLockedDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for lockedDate (when.init)
`ValueSet`	`setLockedDateWithDayPrecision(Date theDate)` Sets the value for lockedDate (when.init)
`ValueSet`	`setName(String theString)` Sets the value for name ()
`ValueSet`	`setName(StringDt theValue)` Sets the value(s) for name ()
`ValueSet`	`setPublisher(String theString)` Sets the value for publisher (who.witness)
`ValueSet`	`setPublisher(StringDt theValue)` Sets the value(s) for publisher (who.witness)
`ValueSet`	`setRequirements(String theString)` Sets the value for requirements ()
`ValueSet`	`setRequirements(StringDt theValue)` Sets the value(s) for requirements ()
`ValueSet`	`setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)` Sets the value(s) for status (status)
`ValueSet`	`setStatus(ConformanceResourceStatusEnum theValue)` Sets the value(s) for status (status)
`ValueSet`	`setUrl(String theUri)` Sets the value for url (id)
`ValueSet`	`setUrl(UriDt theValue)` Sets the value(s) for url (id)
`ValueSet`	`setUseContext(List<CodeableConceptDt> theValue)` Sets the value(s) for useContext ()
`ValueSet`	`setVersion(String theString)` Sets the value for version (id.version)
`ValueSet`	`setVersion(StringDt theValue)` Sets the value(s) for version (id.version)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_URL
```
public static final String SP_URL
```
    Search parameter constant for url
    Description: The logical URL for the value set
    Type: uri
    Path: ValueSet.url
    
    See Also:
    
    Constant Field Values
  - URL
```
public static final UriClientParam URL
```
    Fluent Client search parameter constant for url
    Description: The logical URL for the value set
    Type: uri
    Path: ValueSet.url
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The identifier for the value set
    Type: token
    Path: ValueSet.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The identifier for the value set
    Type: token
    Path: ValueSet.identifier
  - SP_VERSION
```
public static final String SP_VERSION
```
    Search parameter constant for version
    Description: The version identifier of the value set
    Type: token
    Path: ValueSet.version
    
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final TokenClientParam VERSION
```
    Fluent Client search parameter constant for version
    Description: The version identifier of the value set
    Type: token
    Path: ValueSet.version
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description: The name of the value set
    Type: string
    Path: ValueSet.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: The name of the value set
    Type: string
    Path: ValueSet.name
  - SP_PUBLISHER
```
public static final String SP_PUBLISHER
```
    Search parameter constant for publisher
    Description: Name of the publisher of the value set
    Type: string
    Path: ValueSet.publisher
    
    See Also:
    
    Constant Field Values
  - PUBLISHER
```
public static final StringClientParam PUBLISHER
```
    Fluent Client search parameter constant for publisher
    Description: Name of the publisher of the value set
    Type: string
    Path: ValueSet.publisher
  - SP_DESCRIPTION
```
public static final String SP_DESCRIPTION
```
    Search parameter constant for description
    Description: Text search in the description of the value set
    Type: string
    Path: ValueSet.description
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
public static final StringClientParam DESCRIPTION
```
    Fluent Client search parameter constant for description
    Description: Text search in the description of the value set
    Type: string
    Path: ValueSet.description
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter constant for status
    Description: The status of the value set
    Type: token
    Path: ValueSet.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: The status of the value set
    Type: token
    Path: ValueSet.status
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: The value set publication date
    Type: date
    Path: ValueSet.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: The value set publication date
    Type: date
    Path: ValueSet.date
  - SP_SYSTEM
```
public static final String SP_SYSTEM
```
    Search parameter constant for system
    Description: The system for any codes defined by this value set
    Type: uri
    Path: ValueSet.codeSystem.system
    
    See Also:
    
    Constant Field Values
  - SYSTEM
```
public static final UriClientParam SYSTEM
```
    Fluent Client search parameter constant for system
    Description: The system for any codes defined by this value set
    Type: uri
    Path: ValueSet.codeSystem.system
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description: A code defined in the value set
    Type: token
    Path: ValueSet.codeSystem.concept.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: A code defined in the value set
    Type: token
    Path: ValueSet.codeSystem.concept.code
  - SP_REFERENCE
```
public static final String SP_REFERENCE
```
    Search parameter constant for reference
    Description: A code system included or excluded in the value set or an imported value set
    Type: uri
    Path: ValueSet.compose.include.system
    
    See Also:
    
    Constant Field Values
  - REFERENCE
```
public static final UriClientParam REFERENCE
```
    Fluent Client search parameter constant for reference
    Description: A code system included or excluded in the value set or an imported value set
    Type: uri
    Path: ValueSet.compose.include.system
  - SP_CONTEXT
```
public static final String SP_CONTEXT
```
    Search parameter constant for context
    Description: A use context assigned to the value set
    Type: token
    Path: ValueSet.useContext
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
public static final TokenClientParam CONTEXT
```
    Fluent Client search parameter constant for context
    Description: A use context assigned to the value set
    Type: token
    Path: ValueSet.useContext
  - SP_EXPANSION
```
public static final String SP_EXPANSION
```
    Search parameter constant for expansion
    Description:
    Type: uri
    Path: ValueSet.expansion.identifier
    
    See Also:
    
    Constant Field Values
  - EXPANSION
```
public static final UriClientParam EXPANSION
```
    Fluent Client search parameter constant for expansion
    Description:
    Type: uri
    Path: ValueSet.expansion.identifier
- Constructor Detail
  - ValueSet
```
public ValueSet()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getUrlElement
```
public UriDt getUrlElement()
```
    Gets the value(s) for url (id). creating it if it does not exist. Will not return null.
    Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published
  - getUrl
```
public String getUrl()
```
    Gets the value(s) for url (id). creating it if it does not exist. Will not return null.
    Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published
  - setUrl
```
public ValueSet setUrl(UriDt theValue)
```
    Sets the value(s) for url (id)
    Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published
  - setUrl
```
public ValueSet setUrl(String theUri)
```
    Sets the value for url (id)
    Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published
  - getIdentifier
```
public IdentifierDt getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
  - setIdentifier
```
public ValueSet setIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for identifier (id)
    Definition: Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
  - getVersionElement
```
public StringDt getVersionElement()
```
    Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.
    Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
  - getVersion
```
public String getVersion()
```
    Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.
    Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
  - setVersion
```
public ValueSet setVersion(StringDt theValue)
```
    Sets the value(s) for version (id.version)
    Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
  - setVersion
```
public ValueSet setVersion(String theString)
```
    Sets the value for version (id.version)
    Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp
  - getNameElement
```
public StringDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: A free text natural language name describing the value set
  - getName
```
public String getName()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: A free text natural language name describing the value set
  - setName
```
public ValueSet setName(StringDt theValue)
```
    Sets the value(s) for name ()
    Definition: A free text natural language name describing the value set
  - setName
```
public ValueSet setName(String theString)
```
    Sets the value for name ()
    Definition: A free text natural language name describing the value set
  - getStatusElement
```
public BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The status of the value set
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: The status of the value set
  - setStatus
```
public ValueSet setStatus(BoundCodeDt<ConformanceResourceStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: The status of the value set
  - setStatus
```
public ValueSet setStatus(ConformanceResourceStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: The status of the value set
  - getExperimentalElement
```
public BooleanDt getExperimentalElement()
```
    Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.
    Definition: This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
  - getExperimental
```
public Boolean getExperimental()
```
    Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.
    Definition: This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
  - setExperimental
```
public ValueSet setExperimental(BooleanDt theValue)
```
    Sets the value(s) for experimental (class)
    Definition: This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
  - setExperimental
```
public ValueSet setExperimental(boolean theBoolean)
```
    Sets the value for experimental (class)
    Definition: This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
  - getPublisherElement
```
public StringDt getPublisherElement()
```
    Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.
    Definition: The name of the individual or organization that published the value set
  - getPublisher
```
public String getPublisher()
```
    Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.
    Definition: The name of the individual or organization that published the value set
  - setPublisher
```
public ValueSet setPublisher(StringDt theValue)
```
    Sets the value(s) for publisher (who.witness)
    Definition: The name of the individual or organization that published the value set
  - setPublisher
```
public ValueSet setPublisher(String theString)
```
    Sets the value for publisher (who.witness)
    Definition: The name of the individual or organization that published the value set
  - getContact
```
public List<ValueSet.Contact> getContact()
```
    Gets the value(s) for contact (). creating it if it does not exist. Will not return null.
    Definition: Contacts to assist a user in finding and communicating with the publisher
  - setContact
```
public ValueSet setContact(List<ValueSet.Contact> theValue)
```
    Sets the value(s) for contact ()
    Definition: Contacts to assist a user in finding and communicating with the publisher
  - addContact
```
public ValueSet.Contact addContact()
```
    Adds and returns a new value for contact ()
    Definition: Contacts to assist a user in finding and communicating with the publisher
  - addContact
```
public ValueSet addContact(ValueSet.Contact theValue)
```
    Adds a given new value for contact ()
    Definition: Contacts to assist a user in finding and communicating with the publisher
    
    Parameters:
    
    theValue - The contact to add (must not be null)
  - getContactFirstRep
```
public ValueSet.Contact getContactFirstRep()
```
    Gets the first repetition for contact (), creating it if it does not already exist.
    Definition: Contacts to assist a user in finding and communicating with the publisher
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')
  - setDate
```
public ValueSet setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (when.recorded)
    Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')
  - setDate
```
public ValueSet setDate(Date theDate,
                        TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (when.recorded)
    Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')
  - setDateWithSecondsPrecision
```
public ValueSet setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (when.recorded)
    Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')
  - getLockedDateElement
```
public DateDt getLockedDateElement()
```
    Gets the value(s) for lockedDate (when.init). creating it if it does not exist. Will not return null.
    Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date
  - getLockedDate
```
public Date getLockedDate()
```
    Gets the value(s) for lockedDate (when.init). creating it if it does not exist. Will not return null.
    Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date
  - setLockedDate
```
public ValueSet setLockedDate(DateDt theValue)
```
    Sets the value(s) for lockedDate (when.init)
    Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date
  - setLockedDate
```
public ValueSet setLockedDate(Date theDate,
                              TemporalPrecisionEnum thePrecision)
```
    Sets the value for lockedDate (when.init)
    Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date
  - setLockedDateWithDayPrecision
```
public ValueSet setLockedDateWithDayPrecision(Date theDate)
```
    Sets the value for lockedDate (when.init)
    Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date
  - getDescriptionElement
```
public StringDt getDescriptionElement()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
  - getDescription
```
public String getDescription()
```
    Gets the value(s) for description (). creating it if it does not exist. Will not return null.
    Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
  - setDescription
```
public ValueSet setDescription(StringDt theValue)
```
    Sets the value(s) for description ()
    Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
  - setDescription
```
public ValueSet setDescription(String theString)
```
    Sets the value for description ()
    Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.
  - getUseContext
```
public List<CodeableConceptDt> getUseContext()
```
    Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.
    Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
  - setUseContext
```
public ValueSet setUseContext(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for useContext ()
    Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
  - addUseContext
```
public CodeableConceptDt addUseContext()
```
    Adds and returns a new value for useContext ()
    Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
  - addUseContext
```
public ValueSet addUseContext(CodeableConceptDt theValue)
```
    Adds a given new value for useContext ()
    Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
    
    Parameters:
    
    theValue - The useContext to add (must not be null)
  - getUseContextFirstRep
```
public CodeableConceptDt getUseContextFirstRep()
```
    Gets the first repetition for useContext (), creating it if it does not already exist.
    Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.
  - getImmutableElement
```
public BooleanDt getImmutableElement()
```
    Gets the value(s) for immutable (). creating it if it does not exist. Will not return null.
    Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change
  - getImmutable
```
public Boolean getImmutable()
```
    Gets the value(s) for immutable (). creating it if it does not exist. Will not return null.
    Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change
  - setImmutable
```
public ValueSet setImmutable(BooleanDt theValue)
```
    Sets the value(s) for immutable ()
    Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change
  - setImmutable
```
public ValueSet setImmutable(boolean theBoolean)
```
    Sets the value for immutable ()
    Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change
  - getRequirementsElement
```
public StringDt getRequirementsElement()
```
    Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.
    Definition: Explains why this value set is needed and why it has been constrained as it has
  - getRequirements
```
public String getRequirements()
```
    Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.
    Definition: Explains why this value set is needed and why it has been constrained as it has
  - setRequirements
```
public ValueSet setRequirements(StringDt theValue)
```
    Sets the value(s) for requirements ()
    Definition: Explains why this value set is needed and why it has been constrained as it has
  - setRequirements
```
public ValueSet setRequirements(String theString)
```
    Sets the value for requirements ()
    Definition: Explains why this value set is needed and why it has been constrained as it has
  - getCopyrightElement
```
public StringDt getCopyrightElement()
```
    Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.
    Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set
  - getCopyright
```
public String getCopyright()
```
    Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.
    Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set
  - setCopyright
```
public ValueSet setCopyright(StringDt theValue)
```
    Sets the value(s) for copyright ()
    Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set
  - setCopyright
```
public ValueSet setCopyright(String theString)
```
    Sets the value for copyright ()
    Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set
  - getExtensibleElement
```
public BooleanDt getExtensibleElement()
```
    Gets the value(s) for extensible (). creating it if it does not exist. Will not return null.
    Definition: Whether this is intended to be used with an extensible binding or not
  - getExtensible
```
public Boolean getExtensible()
```
    Gets the value(s) for extensible (). creating it if it does not exist. Will not return null.
    Definition: Whether this is intended to be used with an extensible binding or not
  - setExtensible
```
public ValueSet setExtensible(BooleanDt theValue)
```
    Sets the value(s) for extensible ()
    Definition: Whether this is intended to be used with an extensible binding or not
  - setExtensible
```
public ValueSet setExtensible(boolean theBoolean)
```
    Sets the value for extensible ()
    Definition: Whether this is intended to be used with an extensible binding or not
  - getCodeSystem
```
public ValueSet.CodeSystem getCodeSystem()
```
    Gets the value(s) for codeSystem (). creating it if it does not exist. Will not return null.
    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
  - setCodeSystem
```
public ValueSet setCodeSystem(ValueSet.CodeSystem theValue)
```
    Sets the value(s) for 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
  - getCompose
```
public ValueSet.Compose getCompose()
```
    Gets the value(s) for compose (). creating it if it does not exist. Will not return null.
    Definition: A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set
  - setCompose
```
public ValueSet setCompose(ValueSet.Compose theValue)
```
    Sets the value(s) for compose ()
    Definition: A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set
  - getExpansion
```
public ValueSet.Expansion getExpansion()
```
    Gets the value(s) for expansion (). creating it if it does not exist. Will not return null.
    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
  - setExpansion
```
public ValueSet setExpansion(ValueSet.Expansion theValue)
```
    Sets the value(s) for 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
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class ValueSet

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_URL

URL

SP_IDENTIFIER

IDENTIFIER

SP_VERSION

VERSION

SP_NAME

NAME

SP_PUBLISHER

PUBLISHER

SP_DESCRIPTION

DESCRIPTION

SP_STATUS

STATUS

SP_DATE

DATE

SP_SYSTEM

SYSTEM

SP_CODE

CODE

SP_REFERENCE

REFERENCE

SP_CONTEXT

CONTEXT

SP_EXPANSION

EXPANSION

Constructor Detail

ValueSet

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getUrlElement

getUrl

setUrl

setUrl

getIdentifier

setIdentifier

getVersionElement

getVersion

setVersion

setVersion

getNameElement

getName

setName

setName

getStatusElement

getStatus

setStatus

setStatus

getExperimentalElement

getExperimental

setExperimental

setExperimental

getPublisherElement

getPublisher

setPublisher

setPublisher

getContact

setContact

addContact

addContact

getContactFirstRep

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision