Class ValueSet.Compose.Builder
- java.lang.Object
-
- org.linuxforhealth.fhir.model.builder.AbstractBuilder<Element>
-
- org.linuxforhealth.fhir.model.type.Element.Builder
-
- org.linuxforhealth.fhir.model.type.BackboneElement.Builder
-
- org.linuxforhealth.fhir.model.resource.ValueSet.Compose.Builder
-
- Enclosing class:
- ValueSet.Compose
public static class ValueSet.Compose.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
extension, id
-
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.Compose
build()
Build theValueSet.Compose
ValueSet.Compose.Builder
exclude(java.util.Collection<ValueSet.Compose.Include> exclude)
Exclude one or more codes from the value set based on code system filters and/or other value sets.ValueSet.Compose.Builder
exclude(ValueSet.Compose.Include... exclude)
Exclude one or more codes from the value set based on code system filters and/or other value sets.ValueSet.Compose.Builder
extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.ValueSet.Compose.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ValueSet.Compose.Builder
from(ValueSet.Compose compose)
ValueSet.Compose.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ValueSet.Compose.Builder
inactive(java.lang.Boolean inactive)
Convenience method for settinginactive
.ValueSet.Compose.Builder
inactive(Boolean inactive)
Whether inactive codes - codes that are not approved for current use - are in the value set.ValueSet.Compose.Builder
include(java.util.Collection<ValueSet.Compose.Include> include)
Include one or more codes from a code system or other value set(s).ValueSet.Compose.Builder
include(ValueSet.Compose.Include... include)
Include one or more codes from a code system or other value set(s).ValueSet.Compose.Builder
lockedDate(java.time.LocalDate lockedDate)
Convenience method for settinglockedDate
.ValueSet.Compose.Builder
lockedDate(Date lockedDate)
The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.ValueSet.Compose.Builder
modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.ValueSet.Compose.Builder
modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.protected void
validate(ValueSet.Compose compose)
-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class org.linuxforhealth.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public ValueSet.Compose.Builder id(java.lang.String id)
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.- Overrides:
id
in classBackboneElement.Builder
- Parameters:
id
- Unique id for inter-element referencing- Returns:
- A reference to this Builder instance
-
extension
public ValueSet.Compose.Builder extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element. 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 classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public ValueSet.Compose.Builder extension(java.util.Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element. 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 classBackboneElement.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.Compose.Builder modifierExtension(Extension... modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public ValueSet.Compose.Builder modifierExtension(java.util.Collection<Extension> modifierExtension)
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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 classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
lockedDate
public ValueSet.Compose.Builder lockedDate(java.time.LocalDate lockedDate)
Convenience method for settinglockedDate
.- Parameters:
lockedDate
- Fixed date for references with no specified version (transitive)- Returns:
- A reference to this Builder instance
- See Also:
lockedDate(org.linuxforhealth.fhir.model.type.Date)
-
lockedDate
public ValueSet.Compose.Builder lockedDate(Date lockedDate)
The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.- Parameters:
lockedDate
- Fixed date for references with no specified version (transitive)- Returns:
- A reference to this Builder instance
-
inactive
public ValueSet.Compose.Builder inactive(java.lang.Boolean inactive)
Convenience method for settinginactive
.- Parameters:
inactive
- Whether inactive codes are in the value set- Returns:
- A reference to this Builder instance
- See Also:
inactive(org.linuxforhealth.fhir.model.type.Boolean)
-
inactive
public ValueSet.Compose.Builder inactive(Boolean inactive)
Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).- Parameters:
inactive
- Whether inactive codes are in the value set- Returns:
- A reference to this Builder instance
-
include
public ValueSet.Compose.Builder include(ValueSet.Compose.Include... include)
Include one or more codes from a code system or other value set(s).Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
include
- Include one or more codes from a code system or other value set(s)- Returns:
- A reference to this Builder instance
-
include
public ValueSet.Compose.Builder include(java.util.Collection<ValueSet.Compose.Include> include)
Include one or more codes from a code system or other value set(s).Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling
build()
will fail.This element is required.
- Parameters:
include
- Include one or more codes from a code system or other value set(s)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
exclude
public ValueSet.Compose.Builder exclude(ValueSet.Compose.Include... exclude)
Exclude one or more codes from the value set based on code system filters and/or other value sets.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
exclude
- Explicitly exclude codes from a code system or other value sets- Returns:
- A reference to this Builder instance
-
exclude
public ValueSet.Compose.Builder exclude(java.util.Collection<ValueSet.Compose.Include> exclude)
Exclude one or more codes from the value set based on code system filters and/or other value sets.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:
exclude
- Explicitly exclude codes from a code system or other value sets- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public ValueSet.Compose build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ValueSet.Compose
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Compose per the base specification
-
validate
protected void validate(ValueSet.Compose compose)
-
from
protected ValueSet.Compose.Builder from(ValueSet.Compose compose)
-
-