Package org.hl7.fhir.dstu2.model

Class ValueSet

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.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 DomainResource
A value set specifies a set of codes drawn from one or more code systems.
See Also:

  • Field Details

    • url

      protected UriType url
      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.

    • identifier

      protected Identifier identifier
      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.

    • version

      protected StringType version
      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.

    • name

      protected StringType name
      A free text natural language name describing the value set.

    • status

      protected Enumeration<Enumerations.ConformanceResourceStatus> status
      The status of the value set.

    • experimental

      protected BooleanType experimental
      This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • publisher

      protected StringType publisher
      The name of the individual or organization that published the value set.

    • contact

      protected List<ValueSet.ValueSetContactComponent> contact
      Contacts to assist a user in finding and communicating with the publisher.

    • date

      protected DateTimeType date
      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').

    • lockedDate

      protected DateType lockedDate
      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.

    • description

      protected StringType description
      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.

    • useContext

      protected List<CodeableConcept> 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 of value set definitions.

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

    • requirements

      protected StringType requirements
      Explains why this value set is needed and why it has been constrained as it has.

    • extensible

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

    • codeSystem

      protected ValueSet.ValueSetCodeSystemComponent codeSystem
      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.

    • compose

      protected ValueSet.ValueSetComposeComponent compose
      A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.

    • 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
      See Also:

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      See Also:

    • SP_CODE

      public static final String SP_CODE
      See Also:

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      See Also:

    • SP_VERSION

      public static final String SP_VERSION
      See Also:

    • SP_URL

      public static final String SP_URL
      See Also:

    • SP_EXPANSION

      public static final String SP_EXPANSION
      See Also:

    • SP_REFERENCE

      public static final String SP_REFERENCE
      See Also:

    • SP_SYSTEM

      public static final String SP_SYSTEM
      See Also:

    • SP_NAME

      public static final String SP_NAME
      See Also:

    • SP_CONTEXT

      public static final String SP_CONTEXT
      See Also:

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      See Also:

    • SP_STATUS

      public static final String SP_STATUS
      See Also:

  • Constructor Details

  • Method Details

    • getUrlElement

      public UriType getUrlElement()
      Returns:
      url (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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public ValueSet setUrlElement(UriType value)
      Parameters:
      value - url (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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • getUrl

      public String getUrl()
      Returns:
      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 value)
      Parameters:
      value - 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 Identifier getIdentifier()
      Returns:
      identifier (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.)

    • hasIdentifier

      public boolean hasIdentifier()

    • setIdentifier

      public ValueSet setIdentifier(Identifier value)
      Parameters:
      value - identifier (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 StringType getVersionElement()
      Returns:
      version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • setVersionElement

      public ValueSet setVersionElement(StringType value)
      Parameters:
      value - version (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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • getVersion

      public String getVersion()
      Returns:
      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 value)
      Parameters:
      value - 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 StringType getNameElement()
      Returns:
      name (A free text natural language name describing the value set.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • hasNameElement

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public ValueSet setNameElement(StringType value)
      Parameters:
      value - name (A free text natural language name describing the value set.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • getName

      public String getName()
      Returns:
      A free text natural language name describing the value set.

    • setName

      public ValueSet setName(String value)
      Parameters:
      value - A free text natural language name describing the value set.

    • getStatusElement

      public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
      Returns:
      status (The status of the value set.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public ValueSet setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
      Parameters:
      value - status (The status of the value set.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.ConformanceResourceStatus getStatus()
      Returns:
      The status of the value set.

    • setStatus

      public ValueSet setStatus(Enumerations.ConformanceResourceStatus value)
      Parameters:
      value - The status of the value set.

    • getExperimentalElement

      public BooleanType getExperimentalElement()
      Returns:
      experimental (This valueset was 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()

    • hasExperimental

      public boolean hasExperimental()

    • setExperimentalElement

      public ValueSet setExperimentalElement(BooleanType value)
      Parameters:
      value - experimental (This valueset was 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()
      Returns:
      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 value)
      Parameters:
      value - This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • getPublisherElement

      public StringType getPublisherElement()
      Returns:
      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()

    • hasPublisher

      public boolean hasPublisher()

    • setPublisherElement

      public ValueSet setPublisherElement(StringType value)
      Parameters:
      value - 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()
      Returns:
      The name of the individual or organization that published the value set.

    • setPublisher

      public ValueSet setPublisher(String value)
      Parameters:
      value - The name of the individual or organization that published the value set.

    • getContact

      public List<ValueSet.ValueSetContactComponent> getContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • hasContact

      public boolean hasContact()

    • addContact

      public ValueSet.ValueSetContactComponent addContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • addContact

      public ValueSet addContact(ValueSet.ValueSetContactComponent t)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      date (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').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public ValueSet setDateElement(DateTimeType value)
      Parameters:
      value - date (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').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • getDate

      public Date getDate()
      Returns:
      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 value)
      Parameters:
      value - 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 DateType getLockedDateElement()
      Returns:
      lockedDate (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.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value

    • hasLockedDateElement

      public boolean hasLockedDateElement()

    • hasLockedDate

      public boolean hasLockedDate()

    • setLockedDateElement

      public ValueSet setLockedDateElement(DateType value)
      Parameters:
      value - lockedDate (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.). This is the underlying object with id, value and extensions. The accessor "getLockedDate" gives direct access to the value

    • getLockedDate

      public Date getLockedDate()
      Returns:
      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 value)
      Parameters:
      value - 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 StringType getDescriptionElement()
      Returns:
      description (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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public ValueSet setDescriptionElement(StringType value)
      Parameters:
      value - description (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.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • getDescription

      public String getDescription()
      Returns:
      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 value)
      Parameters:
      value - 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<CodeableConcept> getUseContext()
      Returns:
      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 of value set definitions.)

    • hasUseContext

      public boolean hasUseContext()

    • addUseContext

      public CodeableConcept addUseContext()
      Returns:
      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 of value set definitions.)

    • addUseContext

      public ValueSet addUseContext(CodeableConcept t)

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

    • getRequirementsElement

      public StringType getRequirementsElement()
      Returns:
      requirements (Explains why this value set is needed and why it has been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

    • hasRequirementsElement

      public boolean hasRequirementsElement()

    • hasRequirements

      public boolean hasRequirements()

    • setRequirementsElement

      public ValueSet setRequirementsElement(StringType value)
      Parameters:
      value - requirements (Explains why this value set is needed and why it has been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

    • getRequirements

      public String getRequirements()
      Returns:
      Explains why this value set is needed and why it has been constrained as it has.

    • setRequirements

      public ValueSet setRequirements(String value)
      Parameters:
      value - Explains why this value set is needed and why it has been constrained as it has.

    • getCopyrightElement

      public StringType 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(StringType 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.

    • getCodeSystem

      public ValueSet.ValueSetCodeSystemComponent getCodeSystem()
      Returns:
      codeSystem (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.)

    • hasCodeSystem

      public boolean hasCodeSystem()

    • setCodeSystem

      public ValueSet setCodeSystem(ValueSet.ValueSetCodeSystemComponent value)
      Parameters:
      value - codeSystem (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.ValueSetComposeComponent getCompose()
      Returns:
      compose (A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.)

    • hasCompose

      public boolean hasCompose()

    • setCompose

      public ValueSet setCompose(ValueSet.ValueSetComposeComponent value)
      Parameters:
      value - compose (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.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> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      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 DomainResource

    • copy

      public ValueSet copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected ValueSet typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource