Class ValueSet

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.ValueSet
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class ValueSet extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR ValueSet Resource (conformance.terminology)

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

Requirements:

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

See Also:
  • Field Details

    • SP_URL

      public static final String SP_URL
      Search parameter constant for url

      Description: The logical URL for the value set
      Type: uri
      Path: ValueSet.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The logical URL for the value set
      Type: uri
      Path: ValueSet.url

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The identifier for the value set
      Type: token
      Path: ValueSet.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The identifier for the value set
      Type: token
      Path: ValueSet.identifier

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter constant for version

      Description: The version identifier of the value set
      Type: token
      Path: ValueSet.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.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:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.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:
    • 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_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:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.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:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.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:
    • 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_SYSTEM

      public static final String SP_SYSTEM
      Search parameter constant for system

      Description: The system for any codes defined by this value set
      Type: uri
      Path: ValueSet.codeSystem.system

      See Also:
    • SYSTEM

      public static final ca.uhn.fhir.rest.gclient.UriClientParam SYSTEM
      Fluent Client search parameter constant for system

      Description: The system for any codes defined by this value set
      Type: uri
      Path: ValueSet.codeSystem.system

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description: A code defined in the value set
      Type: token
      Path: ValueSet.codeSystem.concept.code

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: A code defined in the value set
      Type: token
      Path: ValueSet.codeSystem.concept.code

    • SP_REFERENCE

      public static final String SP_REFERENCE
      Search parameter constant for reference

      Description: A code system included or excluded in the value set or an imported value set
      Type: uri
      Path: ValueSet.compose.include.system

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

      public static final String SP_CONTEXT
      Search parameter constant for context

      Description: A use context assigned to the value set
      Type: token
      Path: ValueSet.useContext

      See Also:
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the value set
      Type: token
      Path: ValueSet.useContext

    • SP_EXPANSION

      public static final String SP_EXPANSION
      Search parameter constant for expansion

      Description:
      Type: uri
      Path: ValueSet.expansion.identifier

      See Also:
    • EXPANSION

      public static final ca.uhn.fhir.rest.gclient.UriClientParam EXPANSION
      Fluent Client search parameter constant for expansion

      Description:
      Type: uri
      Path: ValueSet.expansion.identifier

  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (id). creating it if it does not exist. Will not return null.

      Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published

    • getUrl

      public String getUrl()
      Gets the value(s) for url (id). creating it if it does not exist. This method may return null.

      Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published

    • setUrl

      public ValueSet setUrl(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for url (id)

      Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published

    • setUrl

      public ValueSet setUrl(String theUri)
      Sets the value for url (id)

      Definition: An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published

    • getIdentifier

      Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

      Definition: Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

    • setIdentifier

      public ValueSet setIdentifier(IdentifierDt theValue)
      Sets the value(s) for identifier (id)

      Definition: Formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

    • getVersionElement

      public ca.uhn.fhir.model.primitive.StringDt getVersionElement()
      Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.

      Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp

    • getVersion

      public String getVersion()
      Gets the value(s) for version (id.version). creating it if it does not exist. This method may return null.

      Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp

    • setVersion

      public ValueSet setVersion(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for version (id.version)

      Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp

    • setVersion

      public ValueSet setVersion(String theString)
      Sets the value for version (id.version)

      Definition: Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp

    • getNameElement

      public ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language name describing the value set

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language name describing the value set

    • setName

      public ValueSet setName(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: A free text natural language name describing the value set

    • setName

      public ValueSet setName(String theString)
      Sets the value for name ()

      Definition: A free text natural language name describing the value set

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the value set

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the value set

    • setStatus

      public ValueSet setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the value set

    • setStatus

      Sets the value(s) for status (status)

      Definition: The status of the value set

    • getExperimentalElement

      public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
      Gets the value(s) for experimental (class). creating it if it does not exist. Will not return null.

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

    • getExperimental

      Gets the value(s) for experimental (class). creating it if it does not exist. This method may 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for experimental (class)

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

    • setExperimental

      public ValueSet setExperimental(boolean theBoolean)
      Sets the value for experimental (class)

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

    • getPublisherElement

      public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

      Definition: The name of the individual or organization that published the value set

    • getPublisher

      public String getPublisher()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

      Definition: The name of the individual or organization that published the value set

    • setPublisher

      public ValueSet setPublisher(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for publisher (who.witness)

      Definition: The name of the individual or organization that published the value set

    • setPublisher

      public ValueSet setPublisher(String theString)
      Sets the value for publisher (who.witness)

      Definition: The name of the individual or organization that published the value set

    • getContact

      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • setContact

      Sets the value(s) for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds and returns a new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds a given new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

      Parameters:
      theValue - The contact to add (must not be null)
    • getContactFirstRep

      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • getDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

      Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')

    • getDate

      public Date getDate()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

      Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')

    • setDate

      public ValueSet setDate(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for date (when.recorded)

      Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')

    • setDateWithSecondsPrecision

      Sets the value for date (when.recorded)

      Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')

    • setDate

      public ValueSet setDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for date (when.recorded)

      Definition: The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')

    • getLockedDateElement

      public ca.uhn.fhir.model.primitive.DateDt getLockedDateElement()
      Gets the value(s) for lockedDate (when.init). creating it if it does not exist. Will not return null.

      Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date

    • getLockedDate

      public Date getLockedDate()
      Gets the value(s) for lockedDate (when.init). creating it if it does not exist. This method may return null.

      Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date

    • setLockedDate

      public ValueSet setLockedDate(ca.uhn.fhir.model.primitive.DateDt theValue)
      Sets the value(s) for lockedDate (when.init)

      Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date

    • setLockedDateWithDayPrecision

      Sets the value for lockedDate (when.init)

      Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date

    • setLockedDate

      public ValueSet setLockedDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for lockedDate (when.init)

      Definition: If a locked date is defined, then the Content Logical Definition must be evaluated using the current version of all referenced code system(s) and value set instances as of the locked date

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.

    • setDescription

      public ValueSet setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.

    • setDescription

      public ValueSet setDescription(String theString)
      Sets the value for description ()

      Definition: A free text natural language description of the use of the value set - reason for definition, \"the semantic space\" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set.

    • getUseContext

      Gets the value(s) for useContext (). creating it if it does not exist. Will not return null.

      Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.

    • setUseContext

      Sets the value(s) for useContext ()

      Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.

    • addUseContext

      Adds and returns a new value for useContext ()

      Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.

    • addUseContext

      Adds a given new value for useContext ()

      Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.

      Parameters:
      theValue - The useContext to add (must not be null)
    • getUseContextFirstRep

      Gets the first repetition for useContext (), creating it if it does not already exist.

      Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of value set definitions.

    • getImmutableElement

      public ca.uhn.fhir.model.primitive.BooleanDt getImmutableElement()
      Gets the value(s) for immutable (). creating it if it does not exist. Will not return null.

      Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change

    • getImmutable

      Gets the value(s) for immutable (). creating it if it does not exist. This method may return null.

      Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change

    • setImmutable

      public ValueSet setImmutable(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for immutable ()

      Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change

    • setImmutable

      public ValueSet setImmutable(boolean theBoolean)
      Sets the value for immutable ()

      Definition: If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change

    • getRequirementsElement

      public ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
      Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.

      Definition: Explains why this value set is needed and why it has been constrained as it has

    • getRequirements

      Gets the value(s) for requirements (). creating it if it does not exist. This method may return null.

      Definition: Explains why this value set is needed and why it has been constrained as it has

    • setRequirements

      public ValueSet setRequirements(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for requirements ()

      Definition: Explains why this value set is needed and why it has been constrained as it has

    • setRequirements

      public ValueSet setRequirements(String theString)
      Sets the value for requirements ()

      Definition: Explains why this value set is needed and why it has been constrained as it has

    • getCopyrightElement

      public ca.uhn.fhir.model.primitive.StringDt getCopyrightElement()
      Gets the value(s) for copyright (). creating it if it does not exist. Will not return null.

      Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set

    • getCopyright

      public String getCopyright()
      Gets the value(s) for copyright (). creating it if it does not exist. This method may return null.

      Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set

    • setCopyright

      public ValueSet setCopyright(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for copyright ()

      Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set

    • setCopyright

      public ValueSet setCopyright(String theString)
      Sets the value for copyright ()

      Definition: A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set

    • getExtensibleElement

      public ca.uhn.fhir.model.primitive.BooleanDt getExtensibleElement()
      Gets the value(s) for extensible (). creating it if it does not exist. Will not return null.

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

    • getExtensible

      Gets the value(s) for extensible (). creating it if it does not exist. This method may return null.

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

    • setExtensible

      public ValueSet setExtensible(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for extensible ()

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

    • setExtensible

      public ValueSet setExtensible(boolean theBoolean)
      Sets the value for extensible ()

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

    • getCodeSystem

      Gets the value(s) for codeSystem (). creating it if it does not exist. Will not return null.

      Definition: A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly

    • setCodeSystem

      Sets the value(s) for codeSystem ()

      Definition: A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to its (codeSystem.system) directly

    • getCompose

      Gets the value(s) for compose (). creating it if it does not exist. Will not return null.

      Definition: A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set

    • setCompose

      Sets the value(s) for compose ()

      Definition: A set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set

    • getExpansion

      Gets the value(s) for expansion (). creating it if it does not exist. Will not return null.

      Definition: A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed

    • setExpansion

      Sets the value(s) for expansion ()

      Definition: A value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource