ValueSet (HAPI FHIR - Core Library 0.7 API)

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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class ValueSet
extends BaseResource
implements IResource
```
HAPI/FHIR ValueSet Resource (A set of codes drawn from one or more code systems)
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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ValueSet.Compose` Block class for child element: ValueSet.compose (When value set includes codes from elsewhere)
`static class`	`ValueSet.ComposeInclude` Block class for child element: ValueSet.compose.include (Include one or more codes from a code system)
`static class`	`ValueSet.ComposeIncludeFilter` Block class for child element: ValueSet.compose.include.filter (Select codes/concepts by their properties (including relationships))
`static class`	`ValueSet.Define` Block class for child element: ValueSet.define (When value set defines its own codes)
`static class`	`ValueSet.DefineConcept` Block class for child element: ValueSet.define.concept (Concepts in the code system)
`static class`	`ValueSet.Expansion` Block class for child element: ValueSet.expansion (When value set is an expansion)
`static class`	`ValueSet.ExpansionContains` Block class for child element: ValueSet.expansion.contains (Codes in the value set)

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static StringClientParam`	`DESCRIPTION` Fluent Client search parameter constant for description
`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 TokenClientParam`	`REFERENCE` Fluent Client search parameter constant for reference
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DESCRIPTION` Search parameter constant for description
`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_VERSION` Search parameter constant for version
`static TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`static TokenClientParam`	`SYSTEM` Fluent Client search parameter constant for system
`static TokenClientParam`	`VERSION` Fluent Client search parameter constant for version

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

ValueSet()

Constructors
Constructor and Description
`ValueSet()`

Method Summary

Methods
Modifier and Type	Method and Description
`ContactDt`	`addTelecom()` Adds and returns a new value for telecom (Contact information of the publisher)
`ValueSet`	`addTelecom(ContactUseEnum theContactUse, String theValue)` Adds a new value for telecom (Contact information of the publisher)
`ValueSet`	`addTelecom(String theValue)` Adds a new value for telecom (Contact information of the publisher)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`ValueSet.Compose`	`getCompose()` Gets the value(s) for compose (When value set includes codes from elsewhere).
`StringDt`	`getCopyright()` Gets the value(s) for copyright (About the value set or its content).
`DateTimeDt`	`getDate()` Gets the value(s) for date (Date for given status).
`ValueSet.Define`	`getDefine()` Gets the value(s) for define (When value set defines its own codes).
`StringDt`	`getDescription()` Gets the value(s) for description (Human language description of the value set).
`ValueSet.Expansion`	`getExpansion()` Gets the value(s) for expansion (When value set is an expansion).
`BooleanDt`	`getExperimental()` Gets the value(s) for experimental (If for testing purposes, not real usage).
`BooleanDt`	`getExtensible()` Gets the value(s) for extensible (Whether this is intended to be used with an extensible binding).
`StringDt`	`getIdentifier()` Gets the value(s) for identifier (Logical id to reference this value set).
`StringDt`	`getName()` Gets the value(s) for name (Informal name for this value set).
`StringDt`	`getPublisher()` Gets the value(s) for publisher (Name of the publisher (Organization or individual)).
`BoundCodeDt<ValueSetStatusEnum>`	`getStatus()` Gets the value(s) for status (draft \| active \| retired).
`List<ContactDt>`	`getTelecom()` Gets the value(s) for telecom (Contact information of the publisher).
`ContactDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (Contact information of the publisher), creating it if it does not already exist.
`StringDt`	`getVersion()` Gets the value(s) for version (Logical id for this version of the value set).
`boolean`	`isEmpty()`
`ValueSet`	`setCompose(ValueSet.Compose theValue)` Sets the value(s) for compose (When value set includes codes from elsewhere)
`ValueSet`	`setCopyright(String theString)` Sets the value for copyright (About the value set or its content)
`ValueSet`	`setCopyright(StringDt theValue)` Sets the value(s) for copyright (About the value set or its content)
`ValueSet`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (Date for given status)
`ValueSet`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (Date for given status)
`ValueSet`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (Date for given status)
`ValueSet`	`setDefine(ValueSet.Define theValue)` Sets the value(s) for define (When value set defines its own codes)
`ValueSet`	`setDescription(String theString)` Sets the value for description (Human language description of the value set)
`ValueSet`	`setDescription(StringDt theValue)` Sets the value(s) for description (Human language description of the value set)
`ValueSet`	`setExpansion(ValueSet.Expansion theValue)` Sets the value(s) for expansion (When value set is an expansion)
`ValueSet`	`setExperimental(boolean theBoolean)` Sets the value for experimental (If for testing purposes, not real usage)
`ValueSet`	`setExperimental(BooleanDt theValue)` Sets the value(s) for experimental (If for testing purposes, not real usage)
`ValueSet`	`setExtensible(boolean theBoolean)` Sets the value for extensible (Whether this is intended to be used with an extensible binding)
`ValueSet`	`setExtensible(BooleanDt theValue)` Sets the value(s) for extensible (Whether this is intended to be used with an extensible binding)
`ValueSet`	`setIdentifier(String theString)` Sets the value for identifier (Logical id to reference this value set)
`ValueSet`	`setIdentifier(StringDt theValue)` Sets the value(s) for identifier (Logical id to reference this value set)
`ValueSet`	`setName(String theString)` Sets the value for name (Informal name for this value set)
`ValueSet`	`setName(StringDt theValue)` Sets the value(s) for name (Informal name for this value set)
`ValueSet`	`setPublisher(String theString)` Sets the value for publisher (Name of the publisher (Organization or individual))
`ValueSet`	`setPublisher(StringDt theValue)` Sets the value(s) for publisher (Name of the publisher (Organization or individual))
`ValueSet`	`setStatus(BoundCodeDt<ValueSetStatusEnum> theValue)` Sets the value(s) for status (draft \| active \| retired)
`ValueSet`	`setStatus(ValueSetStatusEnum theValue)` Sets the value(s) for status (draft \| active \| retired)
`ValueSet`	`setTelecom(List<ContactDt> theValue)` Sets the value(s) for telecom (Contact information of the publisher)
`ValueSet`	`setVersion(String theString)` Sets the value for version (Logical id for this version of the value set)
`ValueSet`	`setVersion(StringDt theValue)` Sets the value(s) for version (Logical id for this version of the value set)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The identifier of 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 of 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: token
    Path: ValueSet.define.system
    
    See Also:
    Constant Field Values
  - SYSTEM
```
public static final TokenClientParam SYSTEM
```
    Fluent Client search parameter constant for system
    Description: The system for any codes defined by this value set
    Type: token
    Path: ValueSet.define.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.define.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.define.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: token
    Path: ValueSet.compose.include.system
    
    See Also:
    Constant Field Values
  - REFERENCE
```
public static final TokenClientParam 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: token
    Path: ValueSet.compose.include.system
- Constructor Detail
  - ValueSet
```
public ValueSet()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public StringDt getIdentifier()
```
    Gets the value(s) for identifier (Logical id to reference this value set). creating it if it does not exist. Will not return null.
    Definition: The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
  - setIdentifier
```
public ValueSet setIdentifier(StringDt theValue)
```
    Sets the value(s) for identifier (Logical id to reference this value set)
    Definition: The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
  - setIdentifier
```
public ValueSet setIdentifier(String theString)
```
    Sets the value for identifier (Logical id to reference this value set)
    Definition: The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI)
  - getVersion
```
public StringDt getVersion()
```
    Gets the value(s) for version (Logical id for this version of the value set). creating it if it does not exist. Will not return null.
    Definition: The identifier that is 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 (Logical id for this version of the value set)
    Definition: The identifier that is 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 (Logical id for this version of the value set)
    Definition: The identifier that is 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
  - getName
```
public StringDt getName()
```
    Gets the value(s) for name (Informal name for this value set). 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 (Informal name for this value set)
    Definition: A free text natural language name describing the value set
  - setName
```
public ValueSet setName(String theString)
```
    Sets the value for name (Informal name for this value set)
    Definition: A free text natural language name describing the value set
  - getPublisher
```
public StringDt getPublisher()
```
    Gets the value(s) for publisher (Name of the publisher (Organization or individual)). 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 (Name of the publisher (Organization or individual))
    Definition: The name of the individual or organization that published the value set
  - setPublisher
```
public ValueSet setPublisher(String theString)
```
    Sets the value for publisher (Name of the publisher (Organization or individual))
    Definition: The name of the individual or organization that published the value set
  - getTelecom
```
public List<ContactDt> getTelecom()
```
    Gets the value(s) for telecom (Contact information of the publisher). creating it if it does not exist. Will not return null.
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
  - setTelecom
```
public ValueSet setTelecom(List<ContactDt> theValue)
```
    Sets the value(s) for telecom (Contact information of the publisher)
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
  - addTelecom
```
public ContactDt addTelecom()
```
    Adds and returns a new value for telecom (Contact information of the publisher)
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
  - getTelecomFirstRep
```
public ContactDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (Contact information of the publisher), creating it if it does not already exist.
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
  - addTelecom
```
public ValueSet addTelecom(ContactUseEnum theContactUse,
                  String theValue)
```
    Adds a new value for telecom (Contact information of the publisher)
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addTelecom
```
public ValueSet addTelecom(String theValue)
```
    Adds a new value for telecom (Contact information of the publisher)
    Definition: Contacts of the publisher to assist a user in finding and communicating with the publisher
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getDescription
```
public StringDt getDescription()
```
    Gets the value(s) for description (Human language description of the value set). 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, conditions of use, etc.
  - setDescription
```
public ValueSet setDescription(StringDt theValue)
```
    Sets the value(s) for description (Human language description of the value set)
    Definition: A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.
  - setDescription
```
public ValueSet setDescription(String theString)
```
    Sets the value for description (Human language description of the value set)
    Definition: A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.
  - getCopyright
```
public StringDt getCopyright()
```
    Gets the value(s) for copyright (About the value set or its content). creating it if it does not exist. Will not return null.
    Definition: A copyright statement relating to the value set and/or its contents
  - setCopyright
```
public ValueSet setCopyright(StringDt theValue)
```
    Sets the value(s) for copyright (About the value set or its content)
    Definition: A copyright statement relating to the value set and/or its contents
  - setCopyright
```
public ValueSet setCopyright(String theString)
```
    Sets the value for copyright (About the value set or its content)
    Definition: A copyright statement relating to the value set and/or its contents
  - getStatus
```
public BoundCodeDt<ValueSetStatusEnum> getStatus()
```
    Gets the value(s) for status (draft | active | retired). creating it if it does not exist. Will not return null.
    Definition: The status of the value set
  - setStatus
```
public ValueSet setStatus(BoundCodeDt<ValueSetStatusEnum> theValue)
```
    Sets the value(s) for status (draft | active | retired)
    Definition: The status of the value set
  - setStatus
```
public ValueSet setStatus(ValueSetStatusEnum theValue)
```
    Sets the value(s) for status (draft | active | retired)
    Definition: The status of the value set
  - getExperimental
```
public BooleanDt getExperimental()
```
    Gets the value(s) for experimental (If for testing purposes, not real usage). 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 (If for testing purposes, not real usage)
    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 (If for testing purposes, not real usage)
    Definition: This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage
  - getExtensible
```
public BooleanDt getExtensible()
```
    Gets the value(s) for extensible (Whether this is intended to be used with an extensible binding). 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 (Whether this is intended to be used with an extensible binding)
    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 (Whether this is intended to be used with an extensible binding)
    Definition: Whether this is intended to be used with an extensible binding or not
  - getDate
```
public DateTimeDt getDate()
```
    Gets the value(s) for date (Date for given status). creating it if it does not exist. Will not return null.
    Definition: The date that the value set status was last changed
  - setDate
```
public ValueSet setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (Date for given status)
    Definition: The date that the value set status was last changed
  - setDateWithSecondsPrecision
```
public ValueSet setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (Date for given status)
    Definition: The date that the value set status was last changed
  - setDate
```
public ValueSet setDate(Date theDate,
               TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (Date for given status)
    Definition: The date that the value set status was last changed
  - getDefine
```
public ValueSet.Define getDefine()
```
    Gets the value(s) for define (When value set defines its own codes). creating it if it does not exist. Will not return null.
    Definition:
  - setDefine
```
public ValueSet setDefine(ValueSet.Define theValue)
```
    Sets the value(s) for define (When value set defines its own codes)
    Definition:
  - getCompose
```
public ValueSet.Compose getCompose()
```
    Gets the value(s) for compose (When value set includes codes from elsewhere). creating it if it does not exist. Will not return null.
    Definition:
  - setCompose
```
public ValueSet setCompose(ValueSet.Compose theValue)
```
    Sets the value(s) for compose (When value set includes codes from elsewhere)
    Definition:
  - getExpansion
```
public ValueSet.Expansion getExpansion()
```
    Gets the value(s) for expansion (When value set is an expansion). creating it if it does not exist. Will not return null.
    Definition:
  - setExpansion
```
public ValueSet setExpansion(ValueSet.Expansion theValue)
```
    Sets the value(s) for expansion (When value set is an expansion)
    Definition:

Class ValueSet

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

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

Constructor Detail

ValueSet

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

setIdentifier

getVersion

setVersion

setVersion

getName

setName

setName

getPublisher

setPublisher

setPublisher

getTelecom

setTelecom

addTelecom

getTelecomFirstRep

addTelecom

addTelecom

getDescription

setDescription

setDescription

getCopyright

setCopyright

setCopyright

getStatus

setStatus

setStatus

getExperimental

setExperimental

setExperimental

getExtensible

setExtensible

setExtensible

getDate

setDate

setDateWithSecondsPrecision

setDate

getDefine

setDefine

getCompose

setCompose

getExpansion

setExpansion