Class ResearchElementDefinition.Characteristic.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.ResearchElementDefinition.Characteristic.Builder
-
- Enclosing class:
- ResearchElementDefinition.Characteristic
public static class ResearchElementDefinition.Characteristic.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 ResearchElementDefinition.Characteristic
build()
Build theResearchElementDefinition.Characteristic
ResearchElementDefinition.Characteristic.Builder
definition(Element definition)
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).ResearchElementDefinition.Characteristic.Builder
exclude(java.lang.Boolean exclude)
Convenience method for settingexclude
.ResearchElementDefinition.Characteristic.Builder
exclude(Boolean exclude)
When true, members with this characteristic are excluded from the element.ResearchElementDefinition.Characteristic.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.ResearchElementDefinition.Characteristic.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected ResearchElementDefinition.Characteristic.Builder
from(ResearchElementDefinition.Characteristic characteristic)
ResearchElementDefinition.Characteristic.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).ResearchElementDefinition.Characteristic.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.ResearchElementDefinition.Characteristic.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.ResearchElementDefinition.Characteristic.Builder
participantEffective(Element participantEffective)
Indicates what effective period the study covers.ResearchElementDefinition.Characteristic.Builder
participantEffectiveDescription(java.lang.String participantEffectiveDescription)
Convenience method for settingparticipantEffectiveDescription
.ResearchElementDefinition.Characteristic.Builder
participantEffectiveDescription(String participantEffectiveDescription)
A narrative description of the time period the study covers.ResearchElementDefinition.Characteristic.Builder
participantEffectiveGroupMeasure(GroupMeasure participantEffectiveGroupMeasure)
Indicates how elements are aggregated within the study effective period.ResearchElementDefinition.Characteristic.Builder
participantEffectiveTimeFromStart(Duration participantEffectiveTimeFromStart)
Indicates duration from the participant's study entry.ResearchElementDefinition.Characteristic.Builder
studyEffective(Element studyEffective)
Indicates what effective period the study covers.ResearchElementDefinition.Characteristic.Builder
studyEffectiveDescription(java.lang.String studyEffectiveDescription)
Convenience method for settingstudyEffectiveDescription
.ResearchElementDefinition.Characteristic.Builder
studyEffectiveDescription(String studyEffectiveDescription)
A narrative description of the time period the study covers.ResearchElementDefinition.Characteristic.Builder
studyEffectiveGroupMeasure(GroupMeasure studyEffectiveGroupMeasure)
Indicates how elements are aggregated within the study effective period.ResearchElementDefinition.Characteristic.Builder
studyEffectiveTimeFromStart(Duration studyEffectiveTimeFromStart)
Indicates duration from the study initiation.ResearchElementDefinition.Characteristic.Builder
unitOfMeasure(CodeableConcept unitOfMeasure)
Specifies the UCUM unit for the outcome.ResearchElementDefinition.Characteristic.Builder
usageContext(java.util.Collection<UsageContext> usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.ResearchElementDefinition.Characteristic.Builder
usageContext(UsageContext... usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.protected void
validate(ResearchElementDefinition.Characteristic characteristic)
-
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 ResearchElementDefinition.Characteristic.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 ResearchElementDefinition.Characteristic.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 ResearchElementDefinition.Characteristic.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 ResearchElementDefinition.Characteristic.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 ResearchElementDefinition.Characteristic.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
-
definition
public ResearchElementDefinition.Characteristic.Builder definition(Element definition)
Define members of the research element using Codes (such as condition, medication, or observation), Expressions ( using an expression language such as FHIRPath or CQL) or DataRequirements (such as Diabetes diagnosis onset in the last year).This element is required.
This is a choice element with the following allowed types:
- Parameters:
definition
- What code or expression defines members?- Returns:
- A reference to this Builder instance
-
usageContext
public ResearchElementDefinition.Characteristic.Builder usageContext(UsageContext... usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
usageContext
- What code/value pairs define members?- Returns:
- A reference to this Builder instance
-
usageContext
public ResearchElementDefinition.Characteristic.Builder usageContext(java.util.Collection<UsageContext> usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.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:
usageContext
- What code/value pairs define members?- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
exclude
public ResearchElementDefinition.Characteristic.Builder exclude(java.lang.Boolean exclude)
Convenience method for settingexclude
.- Parameters:
exclude
- Whether the characteristic includes or excludes members- Returns:
- A reference to this Builder instance
- See Also:
exclude(org.linuxforhealth.fhir.model.type.Boolean)
-
exclude
public ResearchElementDefinition.Characteristic.Builder exclude(Boolean exclude)
When true, members with this characteristic are excluded from the element.- Parameters:
exclude
- Whether the characteristic includes or excludes members- Returns:
- A reference to this Builder instance
-
unitOfMeasure
public ResearchElementDefinition.Characteristic.Builder unitOfMeasure(CodeableConcept unitOfMeasure)
Specifies the UCUM unit for the outcome.- Parameters:
unitOfMeasure
- What unit is the outcome described in?- Returns:
- A reference to this Builder instance
-
studyEffectiveDescription
public ResearchElementDefinition.Characteristic.Builder studyEffectiveDescription(java.lang.String studyEffectiveDescription)
Convenience method for settingstudyEffectiveDescription
.- Parameters:
studyEffectiveDescription
- What time period does the study cover- Returns:
- A reference to this Builder instance
- See Also:
studyEffectiveDescription(org.linuxforhealth.fhir.model.type.String)
-
studyEffectiveDescription
public ResearchElementDefinition.Characteristic.Builder studyEffectiveDescription(String studyEffectiveDescription)
A narrative description of the time period the study covers.- Parameters:
studyEffectiveDescription
- What time period does the study cover- Returns:
- A reference to this Builder instance
-
studyEffective
public ResearchElementDefinition.Characteristic.Builder studyEffective(Element studyEffective)
Indicates what effective period the study covers.This is a choice element with the following allowed types:
- Parameters:
studyEffective
- What time period does the study cover- Returns:
- A reference to this Builder instance
-
studyEffectiveTimeFromStart
public ResearchElementDefinition.Characteristic.Builder studyEffectiveTimeFromStart(Duration studyEffectiveTimeFromStart)
Indicates duration from the study initiation.- Parameters:
studyEffectiveTimeFromStart
- Observation time from study start- Returns:
- A reference to this Builder instance
-
studyEffectiveGroupMeasure
public ResearchElementDefinition.Characteristic.Builder studyEffectiveGroupMeasure(GroupMeasure studyEffectiveGroupMeasure)
Indicates how elements are aggregated within the study effective period.- Parameters:
studyEffectiveGroupMeasure
- mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median- Returns:
- A reference to this Builder instance
-
participantEffectiveDescription
public ResearchElementDefinition.Characteristic.Builder participantEffectiveDescription(java.lang.String participantEffectiveDescription)
Convenience method for settingparticipantEffectiveDescription
.- Parameters:
participantEffectiveDescription
- What time period do participants cover- Returns:
- A reference to this Builder instance
- See Also:
participantEffectiveDescription(org.linuxforhealth.fhir.model.type.String)
-
participantEffectiveDescription
public ResearchElementDefinition.Characteristic.Builder participantEffectiveDescription(String participantEffectiveDescription)
A narrative description of the time period the study covers.- Parameters:
participantEffectiveDescription
- What time period do participants cover- Returns:
- A reference to this Builder instance
-
participantEffective
public ResearchElementDefinition.Characteristic.Builder participantEffective(Element participantEffective)
Indicates what effective period the study covers.This is a choice element with the following allowed types:
- Parameters:
participantEffective
- What time period do participants cover- Returns:
- A reference to this Builder instance
-
participantEffectiveTimeFromStart
public ResearchElementDefinition.Characteristic.Builder participantEffectiveTimeFromStart(Duration participantEffectiveTimeFromStart)
Indicates duration from the participant's study entry.- Parameters:
participantEffectiveTimeFromStart
- Observation time from study start- Returns:
- A reference to this Builder instance
-
participantEffectiveGroupMeasure
public ResearchElementDefinition.Characteristic.Builder participantEffectiveGroupMeasure(GroupMeasure participantEffectiveGroupMeasure)
Indicates how elements are aggregated within the study effective period.- Parameters:
participantEffectiveGroupMeasure
- mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median- Returns:
- A reference to this Builder instance
-
build
public ResearchElementDefinition.Characteristic build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
ResearchElementDefinition.Characteristic
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid Characteristic per the base specification
-
validate
protected void validate(ResearchElementDefinition.Characteristic characteristic)
-
from
protected ResearchElementDefinition.Characteristic.Builder from(ResearchElementDefinition.Characteristic characteristic)
-
-