Class ValueSet.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Resource>
-
- org.linuxforhealth.fhir.model.resource.Resource.Builder
-
- org.linuxforhealth.fhir.model.resource.DomainResource.Builder
-
- org.linuxforhealth.fhir.model.resource.ValueSet.Builder
-
- Enclosing class:
- ValueSet
public static class ValueSet.Builder extends DomainResource.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
contained, extension, modifierExtension, text
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
id, implicitRules, language, meta
-
Fields inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ValueSet
build()
Build theValueSet
ValueSet.Builder
compose(ValueSet.Compose 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.ValueSet.Builder
contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.ValueSet.Builder
contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.ValueSet.Builder
contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.ValueSet.Builder
contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.ValueSet.Builder
copyright(Markdown copyright)
A copyright statement relating to the value set and/or its contents.ValueSet.Builder
date(DateTime date)
The date (and optionally time) when the value set was created or revised (e.g.ValueSet.Builder
description(Markdown description)
A free text natural language description of the value set from a consumer's perspective.ValueSet.Builder
expansion(ValueSet.Expansion expansion)
A value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes.ValueSet.Builder
experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.ValueSet.Builder
experimental(Boolean 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.ValueSet.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource.ValueSet.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource.protected ValueSet.Builder
from(ValueSet valueSet)
ValueSet.Builder
id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource.ValueSet.Builder
identifier(java.util.Collection<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.ValueSet.Builder
identifier(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.ValueSet.Builder
immutable(java.lang.Boolean immutable)
Convenience method for settingimmutable
.ValueSet.Builder
immutable(Boolean immutable)
If this is set to 'true', then no new versions of the content logical definition can be created.ValueSet.Builder
implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.ValueSet.Builder
jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the value set is intended to be used.ValueSet.Builder
jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the value set is intended to be used.ValueSet.Builder
language(Code language)
The base language in which the resource is written.ValueSet.Builder
meta(Meta meta)
The metadata about the resource.ValueSet.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.ValueSet.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants.ValueSet.Builder
name(java.lang.String name)
Convenience method for settingname
.ValueSet.Builder
name(String name)
A natural language name identifying the value set.ValueSet.Builder
publisher(java.lang.String publisher)
Convenience method for settingpublisher
.ValueSet.Builder
publisher(String publisher)
The name of the organization or individual that published the value set.ValueSet.Builder
purpose(Markdown purpose)
Explanation of why this value set is needed and why it has been designed as it has.ValueSet.Builder
status(PublicationStatus status)
The status of this value set.ValueSet.Builder
text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human.ValueSet.Builder
title(java.lang.String title)
Convenience method for settingtitle
.ValueSet.Builder
title(String title)
A short, descriptive, user-friendly title for the value set.ValueSet.Builder
url(Uri 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.ValueSet.Builder
useContext(java.util.Collection<UsageContext> useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.ValueSet.Builder
useContext(UsageContext... useContext)
The content was developed with a focus and intent of supporting the contexts that are listed.protected void
validate(ValueSet valueSet)
ValueSet.Builder
version(java.lang.String version)
Convenience method for settingversion
.ValueSet.Builder
version(String 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.-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public ValueSet.Builder id(java.lang.String id)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.- Overrides:
id
in classDomainResource.Builder
- Parameters:
id
- Logical id of this artifact- Returns:
- A reference to this Builder instance
-
meta
public ValueSet.Builder meta(Meta meta)
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.- Overrides:
meta
in classDomainResource.Builder
- Parameters:
meta
- Metadata about the resource- Returns:
- A reference to this Builder instance
-
implicitRules
public ValueSet.Builder implicitRules(Uri implicitRules)
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.- Overrides:
implicitRules
in classDomainResource.Builder
- Parameters:
implicitRules
- A set of rules under which this content was created- Returns:
- A reference to this Builder instance
-
language
public ValueSet.Builder language(Code language)
The base language in which the resource is written.- Overrides:
language
in classDomainResource.Builder
- Parameters:
language
- Language of the resource content- Returns:
- A reference to this Builder instance
-
text
public ValueSet.Builder text(Narrative text)
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.- Overrides:
text
in classDomainResource.Builder
- Parameters:
text
- Text summary of the resource, for human interpretation- Returns:
- A reference to this Builder instance
-
contained
public ValueSet.Builder contained(Resource... contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
-
contained
public ValueSet.Builder contained(java.util.Collection<Resource> contained)
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
contained
in classDomainResource.Builder
- Parameters:
contained
- Contained, inline Resources- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
extension
public ValueSet.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public ValueSet.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
extension
in classDomainResource.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
modifierExtension
public ValueSet.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
-
modifierExtension
public ValueSet.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Overrides:
modifierExtension
in classDomainResource.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
url
public ValueSet.Builder url(Uri 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.- Parameters:
url
- Canonical identifier for this value set, represented as a URI (globally unique)- Returns:
- A reference to this Builder instance
-
identifier
public ValueSet.Builder identifier(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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the value set (business identifier)- Returns:
- A reference to this Builder instance
-
identifier
public ValueSet.Builder identifier(java.util.Collection<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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
identifier
- Additional identifier for the value set (business identifier)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
version
public ValueSet.Builder version(java.lang.String version)
Convenience method for settingversion
.- Parameters:
version
- Business version of the value set- Returns:
- A reference to this Builder instance
- See Also:
version(org.linuxforhealth.fhir.model.type.String)
-
version
public ValueSet.Builder version(String 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.- Parameters:
version
- Business version of the value set- Returns:
- A reference to this Builder instance
-
name
public ValueSet.Builder name(java.lang.String name)
Convenience method for settingname
.- Parameters:
name
- Name for this value set (computer friendly)- Returns:
- A reference to this Builder instance
- See Also:
name(org.linuxforhealth.fhir.model.type.String)
-
name
public ValueSet.Builder name(String 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.- Parameters:
name
- Name for this value set (computer friendly)- Returns:
- A reference to this Builder instance
-
title
public ValueSet.Builder title(java.lang.String title)
Convenience method for settingtitle
.- Parameters:
title
- Name for this value set (human friendly)- Returns:
- A reference to this Builder instance
- See Also:
title(org.linuxforhealth.fhir.model.type.String)
-
title
public ValueSet.Builder title(String title)
A short, descriptive, user-friendly title for the value set.- Parameters:
title
- Name for this value set (human friendly)- Returns:
- A reference to this Builder instance
-
status
public ValueSet.Builder status(PublicationStatus 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 element is required.
- Parameters:
status
- draft | active | retired | unknown- Returns:
- A reference to this Builder instance
-
experimental
public ValueSet.Builder experimental(java.lang.Boolean experimental)
Convenience method for settingexperimental
.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
- See Also:
experimental(org.linuxforhealth.fhir.model.type.Boolean)
-
experimental
public ValueSet.Builder experimental(Boolean 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.- Parameters:
experimental
- For testing purposes, not real usage- Returns:
- A reference to this Builder instance
-
date
public ValueSet.Builder date(DateTime date)
The date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').- Parameters:
date
- Date last changed- Returns:
- A reference to this Builder instance
-
publisher
public ValueSet.Builder publisher(java.lang.String publisher)
Convenience method for settingpublisher
.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
- See Also:
publisher(org.linuxforhealth.fhir.model.type.String)
-
publisher
public ValueSet.Builder publisher(String publisher)
The name of the organization or individual that published the value set.- Parameters:
publisher
- Name of the publisher (organization or individual)- Returns:
- A reference to this Builder instance
-
contact
public ValueSet.Builder contact(ContactDetail... contact)
Contact details to assist a user in finding and communicating with the publisher.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
-
contact
public ValueSet.Builder contact(java.util.Collection<ContactDetail> contact)
Contact details to assist a user in finding and communicating with the publisher.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
contact
- Contact details for the publisher- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
description
public ValueSet.Builder description(Markdown 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.- Parameters:
description
- Natural language description of the value set- Returns:
- A reference to this Builder instance
-
useContext
public ValueSet.Builder useContext(UsageContext... 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.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
-
useContext
public ValueSet.Builder useContext(java.util.Collection<UsageContext> 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.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
useContext
- The context that the content is intended to support- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
jurisdiction
public ValueSet.Builder jurisdiction(CodeableConcept... jurisdiction)
A legal or geographic region in which the value set is intended to be used.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for value set (if applicable)- Returns:
- A reference to this Builder instance
-
jurisdiction
public ValueSet.Builder jurisdiction(java.util.Collection<CodeableConcept> jurisdiction)
A legal or geographic region in which the value set is intended to be used.Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.- Parameters:
jurisdiction
- Intended jurisdiction for value set (if applicable)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
immutable
public ValueSet.Builder immutable(java.lang.Boolean immutable)
Convenience method for settingimmutable
.- Parameters:
immutable
- Indicates whether or not any change to the content logical definition may occur- Returns:
- A reference to this Builder instance
- See Also:
immutable(org.linuxforhealth.fhir.model.type.Boolean)
-
immutable
public ValueSet.Builder immutable(Boolean 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.- Parameters:
immutable
- Indicates whether or not any change to the content logical definition may occur- Returns:
- A reference to this Builder instance
-
purpose
public ValueSet.Builder purpose(Markdown purpose)
Explanation of why this value set is needed and why it has been designed as it has.- Parameters:
purpose
- Why this value set is defined- Returns:
- A reference to this Builder instance
-
copyright
public ValueSet.Builder copyright(Markdown 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.- Parameters:
copyright
- Use and/or publishing restrictions- Returns:
- A reference to this Builder instance
-
compose
public ValueSet.Builder compose(ValueSet.Compose 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).- Parameters:
compose
- Content logical definition of the value set (CLD)- Returns:
- A reference to this Builder instance
-
expansion
public ValueSet.Builder expansion(ValueSet.Expansion 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.- Parameters:
expansion
- Used when the value set is "expanded"- Returns:
- A reference to this Builder instance
-
build
public ValueSet build()
-
validate
protected void validate(ValueSet valueSet)
-
from
protected ValueSet.Builder from(ValueSet valueSet)
-
-