Class ValueSet
- java.lang.Object
-
- org.hl7.fhir.dstu2016may.model.Base
-
- org.hl7.fhir.dstu2016may.model.BaseResource
-
- org.hl7.fhir.dstu2016may.model.Resource
-
- org.hl7.fhir.dstu2016may.model.DomainResource
-
- org.hl7.fhir.dstu2016may.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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classValueSet.ConceptReferenceComponentstatic classValueSet.ConceptReferenceDesignationComponentstatic classValueSet.ConceptSetComponentstatic classValueSet.ConceptSetFilterComponentstatic classValueSet.FilterOperatorstatic classValueSet.FilterOperatorEnumFactorystatic classValueSet.ValueSetComposeComponentstatic classValueSet.ValueSetContactComponentstatic classValueSet.ValueSetExpansionComponentstatic classValueSet.ValueSetExpansionContainsComponentstatic classValueSet.ValueSetExpansionParameterComponent
-
Field Summary
Fields Modifier and Type Field Description protected ValueSet.ValueSetComposeComponentcomposeA set of criteria that provide the content logical definition of the value set by including or excluding codes from outside this value set.protected List<ValueSet.ValueSetContactComponent>contactContacts to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextprotected StringTypecopyrightA copyright statement relating to the value set and/or its contents.protected DateTimeTypedateThe date that the value set status was last changed.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected StringTypedescriptionA 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.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected ValueSet.ValueSetExpansionComponentexpansionA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes.static ca.uhn.fhir.rest.gclient.UriClientParamEXPANSIONFluent Client search parameter constant for expansionprotected BooleanTypeexperimentalThis valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.protected BooleanTypeextensibleWhether this is intended to be used with an extensible binding or not.protected IdentifieridentifierFormal 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 ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierprotected BooleanTypeimmutableIf this is set to 'true', then no new versions of the content logical definition can be created.protected DateTypelockedDateIf 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.protected StringTypenameA free text natural language name describing the value set.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected StringTypepublisherThe name of the individual or organization that published the value set.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherstatic ca.uhn.fhir.rest.gclient.UriClientParamREFERENCEFluent Client search parameter constant for referenceprotected StringTyperequirementsExplains why this value set is needed and why it has been constrained as it has.static StringSP_CONTEXTSearch parameter: contextstatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EXPANSIONSearch parameter: expansionstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_REFERENCESearch parameter: referencestatic StringSP_STATUSSearch parameter: statusstatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.ConformanceResourceStatus>statusThe status of the value set.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected UriTypeurlAn absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<CodeableConcept>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionUsed to identify this version of the value set when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ValueSet()ConstructorValueSet(Enumeration<Enumerations.ConformanceResourceStatus> status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
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.
-
copyright
protected StringType 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 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_EXPANSION
public static final String SP_EXPANSION
Search parameter: expansionDescription: 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 expansionDescription: Uniquely identifies this expansion
Type: uri
Path: ValueSet.expansion.identifier
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The 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 statusDescription: The status of the value set
Type: token
Path: ValueSet.status
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: Text search in 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 descriptionDescription: Text search in the description of the value set
Type: string
Path: ValueSet.description
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: The 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 nameDescription: The name of the value set
Type: string
Path: ValueSet.name
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the value set
Type: token
Path: ValueSet.useContext
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the value set
Type: token
Path: ValueSet.useContext
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: 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 dateDescription: The value set publication date
Type: date
Path: ValueSet.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: The 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 identifierDescription: The identifier for the value set
Type: token
Path: ValueSet.identifier
-
SP_REFERENCE
public static final String SP_REFERENCE
Search parameter: referenceDescription: 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 referenceDescription: A code system included or excluded in the value set or an imported value set
Type: uri
Path: ValueSet.compose.include.system
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The logical URL for 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 urlDescription: The logical URL for the value set
Type: uri
Path: ValueSet.url
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: 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 publisherDescription: Name of the publisher of the value set
Type: string
Path: ValueSet.publisher
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The version identifier 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 versionDescription: The version identifier of the value set
Type: token
Path: ValueSet.version
-
-
Constructor Detail
-
ValueSet
public ValueSet()
Constructor
-
ValueSet
public ValueSet(Enumeration<Enumerations.ConformanceResourceStatus> status)
Constructor
-
-
Method Detail
-
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.
-
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:
listChildrenin classDomainResource
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
Description copied from class:Basemake an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property- Overrides:
makePropertyin classDomainResource- Returns:
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ValueSet copy()
- Specified by:
copyin classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-