org.hl7.fhir.dstu3.model.ValueSet

All Implemented Interfaces:: ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class ValueSet extends MetadataResource

A value set specifies a set of codes drawn from one or more code systems.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

ValueSet.ConceptReferenceComponent

static class

ValueSet.ConceptReferenceDesignationComponent

static class

ValueSet.ConceptSetComponent

static class

ValueSet.ConceptSetFilterComponent

static enum

ValueSet.FilterOperator

static class

ValueSet.FilterOperatorEnumFactory

static class

ValueSet.ValueSetComposeComponent

static class

ValueSet.ValueSetExpansionComponent

static class

ValueSet.ValueSetExpansionContainsComponent

static class

ValueSet.ValueSetExpansionParameterComponent
Field Summary

Fields

Modifier and Type

Field

Description

protected ValueSet.ValueSetComposeComponent

compose

A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set.

protected MarkdownType

copyright

A copyright statement relating to the value set and/or its contents.

static final ca.uhn.fhir.rest.gclient.DateClientParam

DATE

Fluent Client search parameter constant for date

static final ca.uhn.fhir.rest.gclient.StringClientParam

DESCRIPTION

Fluent Client search parameter constant for description

protected ValueSet.ValueSetExpansionComponent

expansion

A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes.

static final ca.uhn.fhir.rest.gclient.UriClientParam

EXPANSION

Fluent Client search parameter constant for expansion

protected BooleanType

extensible

Whether this is intended to be used with an extensible binding or not.

protected List<Identifier>

identifier

A 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.

static final ca.uhn.fhir.rest.gclient.TokenClientParam

IDENTIFIER

Fluent Client search parameter constant for identifier

protected BooleanType

immutable

If this is set to 'true', then no new versions of the content logical definition can be created.

static final ca.uhn.fhir.rest.gclient.TokenClientParam

JURISDICTION

Fluent Client search parameter constant for jurisdiction

static final ca.uhn.fhir.rest.gclient.StringClientParam

NAME

Fluent Client search parameter constant for name

static final ca.uhn.fhir.rest.gclient.StringClientParam

PUBLISHER

Fluent Client search parameter constant for publisher

protected MarkdownType

purpose

Explaination of why this value set is needed and why it has been designed as it has.

static final ca.uhn.fhir.rest.gclient.UriClientParam

REFERENCE

Fluent Client search parameter constant for reference

static final String

SP_DATE

Search parameter: date

static final String

SP_DESCRIPTION

Search parameter: description

static final String

SP_EXPANSION

Search parameter: expansion

static final String

SP_IDENTIFIER

Search parameter: identifier

static final String

SP_JURISDICTION

Search parameter: jurisdiction

static final String

SP_NAME

Search parameter: name

static final String

SP_PUBLISHER

Search parameter: publisher

static final String

SP_REFERENCE

Search parameter: reference

static final String

SP_STATUS

Search parameter: status

static final String

SP_TITLE

Search parameter: title

static final String

SP_URL

Search parameter: url

static final String

SP_VERSION

Search parameter: version

static final ca.uhn.fhir.rest.gclient.TokenClientParam

STATUS

Fluent Client search parameter constant for status

static final ca.uhn.fhir.rest.gclient.StringClientParam

TITLE

Fluent Client search parameter constant for title

static final ca.uhn.fhir.rest.gclient.UriClientParam

URL

Fluent Client search parameter constant for url

static final ca.uhn.fhir.rest.gclient.TokenClientParam

VERSION

Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

Constructors

Constructor

Description

ValueSet()

Constructor

ValueSet(Enumeration<Enumerations.PublicationStatus> status)

Constructor
Method Summary

Modifier and Type

Method

Description

Base

addChild(String name)

ContactDetail

addContact()

ValueSet

addContact(ContactDetail t)

Identifier

addIdentifier()

ValueSet

addIdentifier(Identifier t)

CodeableConcept

addJurisdiction()

ValueSet

addJurisdiction(CodeableConcept t)

UsageContext

addUseContext()

ValueSet

addUseContext(UsageContext t)

ValueSet

copy()

boolean

equalsDeep(Base other_)

boolean

equalsShallow(Base other_)

String

fhirType()

ValueSet.ValueSetComposeComponent

getCompose()

List<ContactDetail>

getContact()

ContactDetail

getContactFirstRep()

String

getCopyright()

MarkdownType

getCopyrightElement()

Date

getDate()

DateTimeType

getDateElement()

String

getDescription()

MarkdownType

getDescriptionElement()

ValueSet.ValueSetExpansionComponent

getExpansion()

boolean

getExperimental()

BooleanType

getExperimentalElement()

boolean

getExtensible()

BooleanType

getExtensibleElement()

List<Identifier>

getIdentifier()

Identifier

getIdentifierFirstRep()

boolean

getImmutable()

BooleanType

getImmutableElement()

List<CodeableConcept>

getJurisdiction()

CodeableConcept

getJurisdictionFirstRep()

String

getName()

Property

getNamedProperty(int _hash, String _name, boolean _checkValid)

StringType

getNameElement()

Base[]

getProperty(int hash, String name, boolean checkValid)

String

getPublisher()

StringType

getPublisherElement()

String

getPurpose()

MarkdownType

getPurposeElement()

ResourceType

getResourceType()

Enumerations.PublicationStatus

getStatus()

Enumeration<Enumerations.PublicationStatus>

getStatusElement()

String

getTitle()

StringType

getTitleElement()

String[]

getTypesForProperty(int hash, String name)

String

getUrl()

UriType

getUrlElement()

List<UsageContext>

getUseContext()

UsageContext

getUseContextFirstRep()

String

getVersion()

StringType

getVersionElement()

boolean

hasCompose()

boolean

hasContact()

boolean

hasCopyright()

boolean

hasCopyrightElement()

boolean

hasDate()

boolean

hasDateElement()

boolean

hasDescription()

boolean

hasDescriptionElement()

boolean

hasExpansion()

boolean

hasExperimental()

boolean

hasExperimentalElement()

boolean

hasExtensible()

boolean

hasExtensibleElement()

boolean

hasIdentifier()

boolean

hasImmutable()

boolean

hasImmutableElement()

boolean

hasJurisdiction()

boolean

hasName()

boolean

hasNameElement()

boolean

hasPublisher()

boolean

hasPublisherElement()

boolean

hasPurpose()

boolean

hasPurposeElement()

boolean

hasStatus()

boolean

hasStatusElement()

boolean

hasTitle()

boolean

hasTitleElement()

boolean

hasUrl()

boolean

hasUrlElement()

boolean

hasUseContext()

boolean

hasVersion()

boolean

hasVersionElement()

boolean

isEmpty()

protected void

listChildren(List<Property> children)

Base

makeProperty(int hash, String name)

ValueSet

setCompose(ValueSet.ValueSetComposeComponent value)

ValueSet

setContact(List<ContactDetail> theContact)

ValueSet

setCopyright(String value)

ValueSet

setCopyrightElement(MarkdownType value)

ValueSet

setDate(Date value)

ValueSet

setDateElement(DateTimeType value)

ValueSet

setDescription(String value)

ValueSet

setDescriptionElement(MarkdownType value)

ValueSet

setExpansion(ValueSet.ValueSetExpansionComponent value)

ValueSet

setExperimental(boolean value)

ValueSet

setExperimentalElement(BooleanType value)

ValueSet

setExtensible(boolean value)

ValueSet

setExtensibleElement(BooleanType value)

ValueSet

setIdentifier(List<Identifier> theIdentifier)

ValueSet

setImmutable(boolean value)

ValueSet

setImmutableElement(BooleanType value)

ValueSet

setJurisdiction(List<CodeableConcept> theJurisdiction)

ValueSet

setName(String value)

ValueSet

setNameElement(StringType value)

Base

setProperty(int hash, String name, Base value)

Base

setProperty(String name, Base value)

ValueSet

setPublisher(String value)

ValueSet

setPublisherElement(StringType value)

ValueSet

setPurpose(String value)

ValueSet

setPurposeElement(MarkdownType value)

ValueSet

setStatus(Enumerations.PublicationStatus value)

ValueSet

setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

ValueSet

setTitle(String value)

ValueSet

setTitleElement(StringType value)

ValueSet

setUrl(String value)

ValueSet

setUrlElement(UriType value)

ValueSet

setUseContext(List<UsageContext> theUseContext)

ValueSet

setVersion(String value)

ValueSet

setVersionElement(StringType value)

protected ValueSet

typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details
- identifier
  
  protected List<Identifier> identifier
  
  A 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.
- immutable
  
  protected BooleanType immutable
  
  If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
- purpose
  
  protected MarkdownType purpose
  
  Explaination of why this value set is needed and why it has been designed as it has.
- copyright
  
  protected MarkdownType copyright
  
  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.
- extensible
  
  protected BooleanType extensible
  
  Whether this is intended to be used with an extensible binding or not.
- compose
  
  protected ValueSet.ValueSetComposeComponent compose
  
  A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
- expansion
  
  protected ValueSet.ValueSetExpansionComponent expansion
  
  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.
- SP_DATE
  
  public static final String SP_DATE
  
  Search parameter: date
  Description: The value set publication date
  Type: date
  Path: ValueSet.date
  See Also:
  
  Constant Field Values
- DATE
  
  public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
  
  Fluent Client search parameter constant for date
  Description: The value set publication date
  Type: date
  Path: ValueSet.date
- SP_REFERENCE
  
  public static final String SP_REFERENCE
  
  Search parameter: 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 ca.uhn.fhir.rest.gclient.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_IDENTIFIER
  
  public static final String SP_IDENTIFIER
  
  Search parameter: identifier
  Description: External identifier for the value set
  Type: token
  Path: ValueSet.identifier
  See Also:
  
  Constant Field Values
- IDENTIFIER
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
  
  Fluent Client search parameter constant for identifier
  Description: External identifier for the value set
  Type: token
  Path: ValueSet.identifier
- SP_JURISDICTION
  
  public static final String SP_JURISDICTION
  
  Search parameter: jurisdiction
  Description: Intended jurisdiction for the value set
  Type: token
  Path: ValueSet.jurisdiction
  See Also:
  
  Constant Field Values
- JURISDICTION
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
  
  Fluent Client search parameter constant for jurisdiction
  Description: Intended jurisdiction for the value set
  Type: token
  Path: ValueSet.jurisdiction
- SP_NAME
  
  public static final String SP_NAME
  
  Search parameter: name
  Description: Computationally friendly name of the value set
  Type: string
  Path: ValueSet.name
  See Also:
  
  Constant Field Values
- NAME
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
  
  Fluent Client search parameter constant for name
  Description: Computationally friendly name of the value set
  Type: string
  Path: ValueSet.name
- SP_DESCRIPTION
  
  public static final String SP_DESCRIPTION
  
  Search parameter: description
  Description: The description of the value set
  Type: string
  Path: ValueSet.description
  See Also:
  
  Constant Field Values
- DESCRIPTION
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
  
  Fluent Client search parameter constant for description
  Description: The description of the value set
  Type: string
  Path: ValueSet.description
- SP_PUBLISHER
  
  public static final String SP_PUBLISHER
  
  Search parameter: publisher
  Description: Name of the publisher of the value set
  Type: string
  Path: ValueSet.publisher
  See Also:
  
  Constant Field Values
- PUBLISHER
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
  
  Fluent Client search parameter constant for publisher
  Description: Name of the publisher of the value set
  Type: string
  Path: ValueSet.publisher
- SP_TITLE
  
  public static final String SP_TITLE
  
  Search parameter: title
  Description: The human-friendly name of the value set
  Type: string
  Path: ValueSet.title
  See Also:
  
  Constant Field Values
- TITLE
  
  public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
  
  Fluent Client search parameter constant for title
  Description: The human-friendly name of the value set
  Type: string
  Path: ValueSet.title
- SP_VERSION
  
  public static final String SP_VERSION
  
  Search parameter: version
  Description: The business version of the value set
  Type: token
  Path: ValueSet.version
  See Also:
  
  Constant Field Values
- VERSION
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
  
  Fluent Client search parameter constant for version
  Description: The business version of the value set
  Type: token
  Path: ValueSet.version
- SP_URL
  
  public static final String SP_URL
  
  Search parameter: url
  Description: The uri that identifies the value set
  Type: uri
  Path: ValueSet.url
  See Also:
  
  Constant Field Values
- URL
  
  public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
  
  Fluent Client search parameter constant for url
  Description: The uri that identifies the value set
  Type: uri
  Path: ValueSet.url
- SP_STATUS
  
  public static final String SP_STATUS
  
  Search parameter: status
  Description: The current status of the value set
  Type: token
  Path: ValueSet.status
  See Also:
  
  Constant Field Values
- STATUS
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
  
  Fluent Client search parameter constant for status
  Description: The current status of the value set
  Type: token
  Path: ValueSet.status
- SP_EXPANSION
  
  public static final String SP_EXPANSION
  
  Search parameter: expansion
  Description: Uniquely identifies this expansion
  Type: uri
  Path: ValueSet.expansion.identifier
  See Also:
  
  Constant Field Values
- EXPANSION
  
  public static final ca.uhn.fhir.rest.gclient.UriClientParam EXPANSION
  
  Fluent Client search parameter constant for expansion
  Description: Uniquely identifies this expansion
  Type: uri
  Path: ValueSet.expansion.identifier
Constructor Details
- ValueSet
  
  public ValueSet()
  
  Constructor
- ValueSet
  
  public ValueSet(Enumeration<Enumerations.PublicationStatus> status)
  
  Constructor
Method Details
- getUrlElement
  
  public UriType getUrlElement()
  
  Overrides:
  
  getUrlElement in class MetadataResource
  
  Returns:
  
  MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- hasUrlElement
  
  public boolean hasUrlElement()
  
  Overrides:
  
  hasUrlElement in class MetadataResource
- hasUrl
  
  public boolean hasUrl()
  
  Overrides:
  
  hasUrl in class MetadataResource
- setUrlElement
  
  public ValueSet setUrlElement(UriType value)
  
  Overrides:
  
  setUrlElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.url (An absolute URI 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. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
- getUrl
  
  public String getUrl()
  
  Overrides:
  
  getUrl in class MetadataResource
  
  Returns:
  
  An absolute URI 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. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
- setUrl
  
  public ValueSet setUrl(String value)
  
  Overrides:
  
  setUrl in class MetadataResource
  
  Parameters:
  
  value - An absolute URI 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. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
- getIdentifier
  
  public List<Identifier> getIdentifier()
  
  Returns:
  
  identifier (A 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(List<Identifier> theIdentifier)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasIdentifier
  
  public boolean hasIdentifier()
- addIdentifier
  
  public Identifier addIdentifier()
- addIdentifier
  
  public ValueSet addIdentifier(Identifier t)
- getIdentifierFirstRep
  
  public Identifier getIdentifierFirstRep()
  
  Returns:
  
  The first repetition of repeating field identifier, creating it if it does not already exist
- getVersionElement
  
  public StringType getVersionElement()
  
  Overrides:
  
  getVersionElement in class MetadataResource
  
  Returns:
  
  MetadataResource.version (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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
- hasVersionElement
  
  public boolean hasVersionElement()
  
  Overrides:
  
  hasVersionElement in class MetadataResource
- hasVersion
  
  public boolean hasVersion()
  
  Overrides:
  
  hasVersion in class MetadataResource
- setVersionElement
  
  public ValueSet setVersionElement(StringType value)
  
  Overrides:
  
  setVersionElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.version (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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
- getVersion
  
  public String getVersion()
  
  Overrides:
  
  getVersion in class MetadataResource
  
  Returns:
  
  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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- setVersion
  
  public ValueSet setVersion(String value)
  
  Overrides:
  
  setVersion in class MetadataResource
  
  Parameters:
  
  value - 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 value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
- getNameElement
  
  public StringType getNameElement()
  
  Overrides:
  
  getNameElement in class MetadataResource
  
  Returns:
  
  MetadataResource.name (A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- hasNameElement
  
  public boolean hasNameElement()
  
  Overrides:
  
  hasNameElement in class MetadataResource
- hasName
  
  public boolean hasName()
  
  Overrides:
  
  hasName in class MetadataResource
- setNameElement
  
  public ValueSet setNameElement(StringType value)
  
  Overrides:
  
  setNameElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.name (A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
- getName
  
  public String getName()
  
  Overrides:
  
  getName in class MetadataResource
  
  Returns:
  
  A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- setName
  
  public ValueSet setName(String value)
  
  Overrides:
  
  setName in class MetadataResource
  
  Parameters:
  
  value - A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
- getTitleElement
  
  public StringType getTitleElement()
  
  Overrides:
  
  getTitleElement in class MetadataResource
  
  Returns:
  
  MetadataResource.title (A short, descriptive, user-friendly title for the value set.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- hasTitleElement
  
  public boolean hasTitleElement()
  
  Overrides:
  
  hasTitleElement in class MetadataResource
- hasTitle
  
  public boolean hasTitle()
  
  Overrides:
  
  hasTitle in class MetadataResource
- setTitleElement
  
  public ValueSet setTitleElement(StringType value)
  
  Overrides:
  
  setTitleElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.title (A short, descriptive, user-friendly title for the value set.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
- getTitle
  
  public String getTitle()
  
  Overrides:
  
  getTitle in class MetadataResource
  
  Returns:
  
  A short, descriptive, user-friendly title for the value set.
- setTitle
  
  public ValueSet setTitle(String value)
  
  Overrides:
  
  setTitle in class MetadataResource
  
  Parameters:
  
  value - A short, descriptive, user-friendly title for the value set.
- getStatusElement
  
  public Enumeration<Enumerations.PublicationStatus> getStatusElement()
  
  Overrides:
  
  getStatusElement in class MetadataResource
  
  Returns:
  
  MetadataResource.status (The status of this value set. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- hasStatusElement
  
  public boolean hasStatusElement()
  
  Overrides:
  
  hasStatusElement in class MetadataResource
- hasStatus
  
  public boolean hasStatus()
  
  Overrides:
  
  hasStatus in class MetadataResource
- setStatusElement
  
  public ValueSet setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
  
  Overrides:
  
  setStatusElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.status (The status of this value set. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
- getStatus
  
  public Enumerations.PublicationStatus getStatus()
  
  Overrides:
  
  getStatus in class MetadataResource
  
  Returns:
  
  The status of this value set. Enables tracking the life-cycle of the content.
- setStatus
  
  public ValueSet setStatus(Enumerations.PublicationStatus value)
  
  Overrides:
  
  setStatus in class MetadataResource
  
  Parameters:
  
  value - The status of this value set. Enables tracking the life-cycle of the content.
- getExperimentalElement
  
  public BooleanType getExperimentalElement()
  
  Overrides:
  
  getExperimentalElement in class MetadataResource
  
  Returns:
  
  MetadataResource.experimental (A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
- hasExperimentalElement
  
  public boolean hasExperimentalElement()
  
  Overrides:
  
  hasExperimentalElement in class MetadataResource
- hasExperimental
  
  public boolean hasExperimental()
  
  Overrides:
  
  hasExperimental in class MetadataResource
- setExperimentalElement
  
  public ValueSet setExperimentalElement(BooleanType value)
  
  Overrides:
  
  setExperimentalElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.experimental (A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
- getExperimental
  
  public boolean getExperimental()
  
  Overrides:
  
  getExperimental in class MetadataResource
  
  Returns:
  
  A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
- setExperimental
  
  public ValueSet setExperimental(boolean value)
  
  Overrides:
  
  setExperimental in class MetadataResource
  
  Parameters:
  
  value - A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
- getDateElement
  
  public DateTimeType getDateElement()
  
  Overrides:
  
  getDateElement in class MetadataResource
  
  Returns:
  
  MetadataResource.date (The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
- hasDateElement
  
  public boolean hasDateElement()
  
  Overrides:
  
  hasDateElement in class MetadataResource
- hasDate
  
  public boolean hasDate()
  
  Overrides:
  
  hasDate in class MetadataResource
- setDateElement
  
  public ValueSet setDateElement(DateTimeType value)
  
  Overrides:
  
  setDateElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.date (The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
- getDate
  
  public Date getDate()
  
  Overrides:
  
  getDate in class MetadataResource
  
  Returns:
  
  The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').
- setDate
  
  public ValueSet setDate(Date value)
  
  Overrides:
  
  setDate in class MetadataResource
  
  Parameters:
  
  value - The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').
- getPublisherElement
  
  public StringType getPublisherElement()
  
  Overrides:
  
  getPublisherElement in class MetadataResource
  
  Returns:
  
  MetadataResource.publisher (The name of the individual or organization that published the value set.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
- hasPublisherElement
  
  public boolean hasPublisherElement()
  
  Overrides:
  
  hasPublisherElement in class MetadataResource
- hasPublisher
  
  public boolean hasPublisher()
  
  Overrides:
  
  hasPublisher in class MetadataResource
- setPublisherElement
  
  public ValueSet setPublisherElement(StringType value)
  
  Overrides:
  
  setPublisherElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.publisher (The name of the individual or organization that published the value set.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
- getPublisher
  
  public String getPublisher()
  
  Overrides:
  
  getPublisher in class MetadataResource
  
  Returns:
  
  The name of the individual or organization that published the value set.
- setPublisher
  
  public ValueSet setPublisher(String value)
  
  Overrides:
  
  setPublisher in class MetadataResource
  
  Parameters:
  
  value - The name of the individual or organization that published the value set.
- getContact
  
  public List<ContactDetail> getContact()
  
  Overrides:
  
  getContact in class MetadataResource
  
  Returns:
  
  MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
- setContact
  
  public ValueSet setContact(List<ContactDetail> theContact)
  
  Overrides:
  
  setContact in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasContact
  
  public boolean hasContact()
  
  Overrides:
  
  hasContact in class MetadataResource
- addContact
  
  public ContactDetail addContact()
  
  Overrides:
  
  addContact in class MetadataResource
- addContact
  
  public ValueSet addContact(ContactDetail t)
  
  Overrides:
  
  addContact in class MetadataResource
- getContactFirstRep
  
  public ContactDetail getContactFirstRep()
  
  Overrides:
  
  getContactFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
- getDescriptionElement
  
  public MarkdownType getDescriptionElement()
  
  Overrides:
  
  getDescriptionElement in class MetadataResource
  
  Returns:
  
  MetadataResource.description (A free text natural language description of the value set from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- hasDescriptionElement
  
  public boolean hasDescriptionElement()
  
  Overrides:
  
  hasDescriptionElement in class MetadataResource
- hasDescription
  
  public boolean hasDescription()
  
  Overrides:
  
  hasDescription in class MetadataResource
- setDescriptionElement
  
  public ValueSet setDescriptionElement(MarkdownType value)
  
  Overrides:
  
  setDescriptionElement in class MetadataResource
  
  Parameters:
  
  value - MetadataResource.description (A free text natural language description of the value set from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
- getDescription
  
  public String getDescription()
  
  Overrides:
  
  getDescription in class MetadataResource
  
  Returns:
  
  A free text natural language description of the value set from a consumer's perspective.
- setDescription
  
  public ValueSet setDescription(String value)
  
  Overrides:
  
  setDescription in class MetadataResource
  
  Parameters:
  
  value - A free text natural language description of the value set from a consumer's perspective.
- getUseContext
  
  public List<UsageContext> getUseContext()
  
  Overrides:
  
  getUseContext in class MetadataResource
  
  Returns:
  
  MetadataResource.useContext (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 for appropriate value set instances.)
- setUseContext
  
  public ValueSet setUseContext(List<UsageContext> theUseContext)
  
  Overrides:
  
  setUseContext in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasUseContext
  
  public boolean hasUseContext()
  
  Overrides:
  
  hasUseContext in class MetadataResource
- addUseContext
  
  public UsageContext addUseContext()
  
  Overrides:
  
  addUseContext in class MetadataResource
- addUseContext
  
  public ValueSet addUseContext(UsageContext t)
  
  Overrides:
  
  addUseContext in class MetadataResource
- getUseContextFirstRep
  
  public UsageContext getUseContextFirstRep()
  
  Overrides:
  
  getUseContextFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
- getJurisdiction
  
  public List<CodeableConcept> getJurisdiction()
  
  Overrides:
  
  getJurisdiction in class MetadataResource
  
  Returns:
  
  MetadataResource.jurisdiction (A legal or geographic region in which the value set is intended to be used.)
- setJurisdiction
  
  public ValueSet setJurisdiction(List<CodeableConcept> theJurisdiction)
  
  Overrides:
  
  setJurisdiction in class MetadataResource
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasJurisdiction
  
  public boolean hasJurisdiction()
  
  Overrides:
  
  hasJurisdiction in class MetadataResource
- addJurisdiction
  
  public CodeableConcept addJurisdiction()
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- addJurisdiction
  
  public ValueSet addJurisdiction(CodeableConcept t)
  
  Overrides:
  
  addJurisdiction in class MetadataResource
- getJurisdictionFirstRep
  
  public CodeableConcept getJurisdictionFirstRep()
  
  Overrides:
  
  getJurisdictionFirstRep in class MetadataResource
  
  Returns:
  
  The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
- getImmutableElement
  
  public BooleanType getImmutableElement()
  
  Returns:
  
  immutable (If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.). This is the underlying object with id, value and extensions. The accessor "getImmutable" gives direct access to the value
- hasImmutableElement
  
  public boolean hasImmutableElement()
- hasImmutable
  
  public boolean hasImmutable()
- setImmutableElement
  
  public ValueSet setImmutableElement(BooleanType value)
  
  Parameters:
  
  value - immutable (If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.). This is the underlying object with id, value and extensions. The accessor "getImmutable" gives direct access to the value
- getImmutable
  
  public boolean getImmutable()
  
  Returns:
  
  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 value)
  
  Parameters:
  
  value - If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
- getPurposeElement
  
  public MarkdownType getPurposeElement()
  
  Returns:
  
  purpose (Explaination of why this value set is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
- hasPurposeElement
  
  public boolean hasPurposeElement()
- hasPurpose
  
  public boolean hasPurpose()
- setPurposeElement
  
  public ValueSet setPurposeElement(MarkdownType value)
  
  Parameters:
  
  value - purpose (Explaination of why this value set is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
- getPurpose
  
  public String getPurpose()
  
  Returns:
  
  Explaination of why this value set is needed and why it has been designed as it has.
- setPurpose
  
  public ValueSet setPurpose(String value)
  
  Parameters:
  
  value - Explaination of why this value set is needed and why it has been designed as it has.
- getCopyrightElement
  
  public MarkdownType getCopyrightElement()
  
  Returns:
  
  copyright (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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
- hasCopyrightElement
  
  public boolean hasCopyrightElement()
- hasCopyright
  
  public boolean hasCopyright()
- setCopyrightElement
  
  public ValueSet setCopyrightElement(MarkdownType value)
  
  Parameters:
  
  value - copyright (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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
- getCopyright
  
  public String getCopyright()
  
  Returns:
  
  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 value)
  
  Parameters:
  
  value - 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 BooleanType getExtensibleElement()
  
  Returns:
  
  extensible (Whether this is intended to be used with an extensible binding or not.). This is the underlying object with id, value and extensions. The accessor "getExtensible" gives direct access to the value
- hasExtensibleElement
  
  public boolean hasExtensibleElement()
- hasExtensible
  
  public boolean hasExtensible()
- setExtensibleElement
  
  public ValueSet setExtensibleElement(BooleanType value)
  
  Parameters:
  
  value - extensible (Whether this is intended to be used with an extensible binding or not.). This is the underlying object with id, value and extensions. The accessor "getExtensible" gives direct access to the value
- getExtensible
  
  public boolean getExtensible()
  
  Returns:
  
  Whether this is intended to be used with an extensible binding or not.
- setExtensible
  
  public ValueSet setExtensible(boolean value)
  
  Parameters:
  
  value - Whether this is intended to be used with an extensible binding or not.
- getCompose
  
  public ValueSet.ValueSetComposeComponent getCompose()
  
  Returns:
  
  compose (A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).)
- hasCompose
  
  public boolean hasCompose()
- setCompose
  
  public ValueSet setCompose(ValueSet.ValueSetComposeComponent value)
  
  Parameters:
  
  value - compose (A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).)
- getExpansion
  
  public ValueSet.ValueSetExpansionComponent getExpansion()
  
  Returns:
  
  expansion (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.)
- hasExpansion
  
  public boolean hasExpansion()
- setExpansion
  
  public ValueSet setExpansion(ValueSet.ValueSetExpansionComponent value)
  
  Parameters:
  
  value - expansion (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.)
- listChildren
  
  protected void listChildren(List<Property> children)
  
  Overrides:
  
  listChildren in class MetadataResource
- getNamedProperty
  
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getNamedProperty in class MetadataResource
  
  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 MetadataResource
  
  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 MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- makeProperty
  
  public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  makeProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getTypesForProperty
  
  public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getTypesForProperty in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- addChild
  
  public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  addChild in class MetadataResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fhirType
  
  public String fhirType()
  
  Specified by:
  
  fhirType in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  fhirType in class MetadataResource
- copy
  
  public ValueSet copy()
  
  Specified by:
  
  copy in class MetadataResource
- typedCopy
  
  protected ValueSet typedCopy()
- equalsDeep
  
  public boolean equalsDeep(Base other_)
  
  Overrides:
  
  equalsDeep in class MetadataResource
- equalsShallow
  
  public boolean equalsShallow(Base other_)
  
  Overrides:
  
  equalsShallow in class MetadataResource
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  isEmpty in class MetadataResource
- getResourceType
  
  public ResourceType getResourceType()
  
  Specified by:
  
  getResourceType in class Resource

Class ValueSet

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

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

Methods inherited from class java.lang.Object

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

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

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

Field Details

identifier

immutable

purpose

copyright

extensible

compose

expansion

SP_DATE

DATE

SP_REFERENCE

REFERENCE

SP_IDENTIFIER

IDENTIFIER

SP_JURISDICTION

JURISDICTION

SP_NAME

NAME

SP_DESCRIPTION

DESCRIPTION

SP_PUBLISHER

PUBLISHER

SP_TITLE

TITLE

SP_VERSION

VERSION

SP_URL

URL

SP_STATUS

STATUS

SP_EXPANSION

EXPANSION

Constructor Details

ValueSet

ValueSet

Method Details

getUrlElement

hasUrlElement

hasUrl

setUrlElement

getUrl

setUrl

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getVersionElement

hasVersionElement

hasVersion

setVersionElement

getVersion

setVersion

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getTitleElement