Class CodeSystem.Concept.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.CodeSystem.Concept.Builder
-
- Enclosing class:
- CodeSystem.Concept
public static class CodeSystem.Concept.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 CodeSystem.Concept
build()
Build theCodeSystem.Concept
CodeSystem.Concept.Builder
code(Code code)
A code - a text symbol - that uniquely identifies the concept within the code system.CodeSystem.Concept.Builder
concept(java.util.Collection<CodeSystem.Concept> concept)
Defines children of a concept to produce a hierarchy of concepts.CodeSystem.Concept.Builder
concept(CodeSystem.Concept... concept)
Defines children of a concept to produce a hierarchy of concepts.CodeSystem.Concept.Builder
definition(java.lang.String definition)
Convenience method for settingdefinition
.CodeSystem.Concept.Builder
definition(String definition)
The formal definition of the concept.CodeSystem.Concept.Builder
designation(java.util.Collection<CodeSystem.Concept.Designation> designation)
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.CodeSystem.Concept.Builder
designation(CodeSystem.Concept.Designation... designation)
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.CodeSystem.Concept.Builder
display(java.lang.String display)
Convenience method for settingdisplay
.CodeSystem.Concept.Builder
display(String display)
A human readable string that is the recommended default way to present this concept to a user.CodeSystem.Concept.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.CodeSystem.Concept.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected CodeSystem.Concept.Builder
from(CodeSystem.Concept concept)
CodeSystem.Concept.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).CodeSystem.Concept.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.CodeSystem.Concept.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.CodeSystem.Concept.Builder
property(java.util.Collection<CodeSystem.Concept.Property> property)
A property value for this concept.CodeSystem.Concept.Builder
property(CodeSystem.Concept.Property... property)
A property value for this concept.protected void
validate(CodeSystem.Concept concept)
-
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 CodeSystem.Concept.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 CodeSystem.Concept.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 CodeSystem.Concept.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 CodeSystem.Concept.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 CodeSystem.Concept.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
-
code
public CodeSystem.Concept.Builder code(Code code)
A code - a text symbol - that uniquely identifies the concept within the code system.This element is required.
- Parameters:
code
- Code that identifies concept- Returns:
- A reference to this Builder instance
-
display
public CodeSystem.Concept.Builder display(java.lang.String display)
Convenience method for settingdisplay
.- Parameters:
display
- Text to display to the user- Returns:
- A reference to this Builder instance
- See Also:
display(org.linuxforhealth.fhir.model.type.String)
-
display
public CodeSystem.Concept.Builder display(String display)
A human readable string that is the recommended default way to present this concept to a user.- Parameters:
display
- Text to display to the user- Returns:
- A reference to this Builder instance
-
definition
public CodeSystem.Concept.Builder definition(java.lang.String definition)
Convenience method for settingdefinition
.- Parameters:
definition
- Formal definition- Returns:
- A reference to this Builder instance
- See Also:
definition(org.linuxforhealth.fhir.model.type.String)
-
definition
public CodeSystem.Concept.Builder definition(String definition)
The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.- Parameters:
definition
- Formal definition- Returns:
- A reference to this Builder instance
-
designation
public CodeSystem.Concept.Builder designation(CodeSystem.Concept.Designation... designation)
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
designation
- Additional representations for the concept- Returns:
- A reference to this Builder instance
-
designation
public CodeSystem.Concept.Builder designation(java.util.Collection<CodeSystem.Concept.Designation> designation)
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.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:
designation
- Additional representations for the concept- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
property
public CodeSystem.Concept.Builder property(CodeSystem.Concept.Property... property)
A property value for this concept.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
property
- Property value for the concept- Returns:
- A reference to this Builder instance
-
property
public CodeSystem.Concept.Builder property(java.util.Collection<CodeSystem.Concept.Property> property)
A property value for this concept.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:
property
- Property value for the concept- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
concept
public CodeSystem.Concept.Builder concept(CodeSystem.Concept... concept)
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is- a/contains/categorizes) - see hierarchyMeaning.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
concept
- Child Concepts (is-a/contains/categorizes)- Returns:
- A reference to this Builder instance
-
concept
public CodeSystem.Concept.Builder concept(java.util.Collection<CodeSystem.Concept> concept)
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is- a/contains/categorizes) - see hierarchyMeaning.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:
concept
- Child Concepts (is-a/contains/categorizes)- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
build
public CodeSystem.Concept build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
CodeSystem.Concept
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Concept per the base specification
-
validate
protected void validate(CodeSystem.Concept concept)
-
from
protected CodeSystem.Concept.Builder from(CodeSystem.Concept concept)
-
-