Class ValueSet
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class ValueSet extends MetadataResource
A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [[[CodeSystem]]] definitions and their use in [coded elements](terminologies.html).- 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.ValueSetExpansionComponentstatic classValueSet.ValueSetExpansionContainsComponentstatic classValueSet.ValueSetExpansionParameterComponent
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected ValueSet.ValueSetComposeComponentcomposeA set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the value set and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic 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 List<Identifier>identifierA formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.static 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.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionstatic ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this value set is needed and why it has been designed as it has.static ca.uhn.fhir.rest.gclient.UriClientParamREFERENCEFluent Client search parameter constant for referencestatic StringSP_CODESearch parameter: codestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EXPANSIONSearch parameter: expansionstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_REFERENCESearch parameter: referencestatic StringSP_STATUSSearch parameter: statusstatic StringSP_TITLESearch parameter: titlestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titlestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ValueSet()ConstructorValueSet(Enumeration<Enumerations.PublicationStatus> status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
immutable
protected BooleanType immutable
If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
-
purpose
protected MarkdownType purpose
Explanation of why this value set is needed and why it has been designed as it has.
-
copyright
protected MarkdownType copyright
A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
-
compose
protected ValueSet.ValueSetComposeComponent compose
A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
-
expansion
protected ValueSet.ValueSetExpansionComponent expansion
A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
-
SP_DATE
public static final String SP_DATE
Search parameter: 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: External identifier for the value set
Type: token
Path: ValueSet.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the value set
Type: token
Path: ValueSet.identifier
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
Type: token
Path: ValueSet.expansion.contains.code, ValueSet.compose.include.concept.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: This special parameter searches for codes in the value set. See additional notes on the ValueSet resource
Type: token
Path: ValueSet.expansion.contains.code, ValueSet.compose.include.concept.code
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the value set
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the value set
Type: composite
Path:
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the value set
Type: token
Path: ValueSet.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the value set
Type: token
Path: ValueSet.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: 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: The description of the value set
Type: string
Path: ValueSet.description
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the value set
Type: token
Path: ValueSet.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the value set
Type: token
Path: ValueSet.useContext.code
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the value set
Type: string
Path: ValueSet.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the value set
Type: string
Path: ValueSet.title
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the value set
Type: token
Path: ValueSet.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the value set
Type: token
Path: ValueSet.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the value set
Type: uri
Path: ValueSet.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the value set
Type: uri
Path: ValueSet.url
-
SP_EXPANSION
public static final String SP_EXPANSION
Search parameter: expansionDescription: Identifies the value set expansion (business identifier)
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: Identifies the value set expansion (business identifier)
Type: uri
Path: ValueSet.expansion.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_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: ValueSet.useContext.valueQuantity, ValueSet.useContext.valueRange
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the value set
Type: quantity
Path: ValueSet.useContext.valueQuantity, ValueSet.useContext.valueRange
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the value set
Type: string
Path: ValueSet.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly 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.valueCodeableConcept
- 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.valueCodeableConcept
-
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_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path:
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the value set
Type: composite
Path:
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the value set
Type: token
Path: ValueSet.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the value set
Type: token
Path: ValueSet.status
-
-
Constructor Detail
-
ValueSet
public ValueSet()
Constructor
-
ValueSet
public ValueSet(Enumeration<Enumerations.PublicationStatus> status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElementin classMetadataResource- Returns:
MetadataResource.url(An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public ValueSet setUrlElement(UriType value)
- Overrides:
setUrlElementin classMetadataResource- Parameters:
value-MetadataResource.url(An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrlin classMetadataResource- Returns:
- An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
-
setUrl
public ValueSet setUrl(String value)
- Overrides:
setUrlin classMetadataResource- Parameters:
value- An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
public ValueSet setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ValueSet addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElementin classMetadataResource- Returns:
MetadataResource.version(The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Overrides:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public ValueSet setVersionElement(StringType value)
- Overrides:
setVersionElementin classMetadataResource- Parameters:
value-MetadataResource.version(The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Overrides:
getVersionin classMetadataResource- Returns:
- The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
setVersion
public ValueSet setVersion(String value)
- Overrides:
setVersionin classMetadataResource- Parameters:
value- The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
getNameElement
public StringType getNameElement()
- Overrides:
getNameElementin classMetadataResource- Returns:
MetadataResource.name(A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Overrides:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public ValueSet setNameElement(StringType value)
- Overrides:
setNameElementin classMetadataResource- Parameters:
value-MetadataResource.name(A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Overrides:
getNamein classMetadataResource- Returns:
- A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
public ValueSet setName(String value)
- Overrides:
setNamein classMetadataResource- Parameters:
value- A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
public StringType getTitleElement()
- Overrides:
getTitleElementin classMetadataResource- Returns:
MetadataResource.title(A short, descriptive, user-friendly title for the value set.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Overrides:
hasTitleElementin classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitlein classMetadataResource
-
setTitleElement
public ValueSet setTitleElement(StringType value)
- Overrides:
setTitleElementin classMetadataResource- Parameters:
value-MetadataResource.title(A short, descriptive, user-friendly title for the value set.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Overrides:
getTitlein classMetadataResource- Returns:
- A short, descriptive, user-friendly title for the value set.
-
setTitle
public ValueSet setTitle(String value)
- Overrides:
setTitlein classMetadataResource- Parameters:
value- A short, descriptive, user-friendly title for the value set.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin classMetadataResource- Returns:
MetadataResource.status(The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Overrides:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public ValueSet setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin classMetadataResource- Parameters:
value-MetadataResource.status(The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatusin classMetadataResource- Returns:
- The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
-
setStatus
public ValueSet setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElementin classMetadataResource- Returns:
MetadataResource.experimental(A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public ValueSet setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElementin classMetadataResource- Parameters:
value-MetadataResource.experimental(A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Overrides:
getExperimentalin classMetadataResource- Returns:
- A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
setExperimental
public ValueSet setExperimental(boolean value)
- Overrides:
setExperimentalin classMetadataResource- Parameters:
value- A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Overrides:
getDateElementin classMetadataResource- Returns:
MetadataResource.date(The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public ValueSet setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-MetadataResource.date(The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Overrides:
getDatein classMetadataResource- Returns:
- The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
-
setDate
public ValueSet setDate(Date value)
- Overrides:
setDatein classMetadataResource- Parameters:
value- The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
-
getPublisherElement
public StringType getPublisherElement()
- Overrides:
getPublisherElementin classMetadataResource- Returns:
MetadataResource.publisher(The name of the organization or individual that published the value set.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Overrides:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public ValueSet setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-MetadataResource.publisher(The name of the organization or individual that published the value set.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Overrides:
getPublisherin classMetadataResource- Returns:
- The name of the organization or individual that published the value set.
-
setPublisher
public ValueSet setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the organization or individual that published the value set.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ValueSet setContact(List<ContactDetail> theContact)
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public ValueSet addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElementin classMetadataResource- Returns:
MetadataResource.description(A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of 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()
- Overrides:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public ValueSet setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElementin classMetadataResource- Parameters:
value-MetadataResource.description(A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of 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()
- Overrides:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
-
setDescription
public ValueSet setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate value set instances.)
-
setUseContext
public ValueSet setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public ValueSet addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin classMetadataResource- Returns:
MetadataResource.jurisdiction(A legal or geographic region in which the value set is intended to be used.)
-
setJurisdiction
public ValueSet setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public ValueSet addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
getImmutableElement
public BooleanType getImmutableElement()
- Returns:
immutable(If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.). This is the underlying object with id, value and extensions. The accessor "getImmutable" gives direct access to the value
-
hasImmutableElement
public boolean hasImmutableElement()
-
hasImmutable
public boolean hasImmutable()
-
setImmutableElement
public ValueSet setImmutableElement(BooleanType value)
- Parameters:
value-immutable(If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.). This is the underlying object with id, value and extensions. The accessor "getImmutable" gives direct access to the value
-
getImmutable
public boolean getImmutable()
- Returns:
- If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
-
setImmutable
public ValueSet setImmutable(boolean value)
- Parameters:
value- If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explanation of why this value set is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public ValueSet setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explanation of why this value set is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Returns:
- Explanation of why this value set is needed and why it has been designed as it has.
-
setPurpose
public ValueSet setPurpose(String value)
- Parameters:
value- Explanation of why this value set is needed and why it has been designed as it has.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public ValueSet setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
-
setCopyright
public ValueSet setCopyright(String value)
- Parameters:
value- A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
-
getCompose
public ValueSet.ValueSetComposeComponent getCompose()
- Returns:
compose(A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).)
-
hasCompose
public boolean hasCompose()
-
setCompose
public ValueSet setCompose(ValueSet.ValueSetComposeComponent value)
- Parameters:
value-compose(A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).)
-
getExpansion
public ValueSet.ValueSetExpansionComponent getExpansion()
- Returns:
expansion(A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.)
-
hasExpansion
public boolean hasExpansion()
-
setExpansion
public ValueSet setExpansion(ValueSet.ValueSetExpansionComponent value)
- Parameters:
value-expansion(A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public ValueSet copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(ValueSet dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-