Class Evidence.VariableDefinition.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.Evidence.VariableDefinition.Builder
-
- Enclosing class:
- Evidence.VariableDefinition
public static class Evidence.VariableDefinition.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 Evidence.VariableDefinition
build()
Build theEvidence.VariableDefinition
Evidence.VariableDefinition.Builder
description(Markdown description)
A text description or summary of the variable.Evidence.VariableDefinition.Builder
directnessMatch(CodeableConcept directnessMatch)
Indication of quality of match between intended variable to actual variable.Evidence.VariableDefinition.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.Evidence.VariableDefinition.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.protected Evidence.VariableDefinition.Builder
from(Evidence.VariableDefinition variableDefinition)
Evidence.VariableDefinition.Builder
id(java.lang.String id)
Unique id for the element within a resource (for internal references).Evidence.VariableDefinition.Builder
intended(Reference intended)
Definition of the intended variable related to the Evidence.Evidence.VariableDefinition.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.Evidence.VariableDefinition.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.Evidence.VariableDefinition.Builder
note(java.util.Collection<Annotation> note)
Footnotes and/or explanatory notes.Evidence.VariableDefinition.Builder
note(Annotation... note)
Footnotes and/or explanatory notes.Evidence.VariableDefinition.Builder
observed(Reference observed)
Definition of the actual variable related to the statistic(s).protected void
validate(Evidence.VariableDefinition variableDefinition)
Evidence.VariableDefinition.Builder
variableRole(CodeableConcept variableRole)
population | subpopulation | exposure | referenceExposure | measuredVariable | confounder.-
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 Evidence.VariableDefinition.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 Evidence.VariableDefinition.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 Evidence.VariableDefinition.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 Evidence.VariableDefinition.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 Evidence.VariableDefinition.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
-
description
public Evidence.VariableDefinition.Builder description(Markdown description)
A text description or summary of the variable.- Parameters:
description
- A text description or summary of the variable- Returns:
- A reference to this Builder instance
-
note
public Evidence.VariableDefinition.Builder note(Annotation... note)
Footnotes and/or explanatory notes.Adds new element(s) to the existing list. If any of the elements are null, calling
build()
will fail.- Parameters:
note
- Footnotes and/or explanatory notes- Returns:
- A reference to this Builder instance
-
note
public Evidence.VariableDefinition.Builder note(java.util.Collection<Annotation> note)
Footnotes and/or explanatory notes.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:
note
- Footnotes and/or explanatory notes- Returns:
- A reference to this Builder instance
- Throws:
java.lang.NullPointerException
- If the passed collection is null
-
variableRole
public Evidence.VariableDefinition.Builder variableRole(CodeableConcept variableRole)
population | subpopulation | exposure | referenceExposure | measuredVariable | confounder.This element is required.
- Parameters:
variableRole
- population | subpopulation | exposure | referenceExposure | measuredVariable | confounder- Returns:
- A reference to this Builder instance
-
observed
public Evidence.VariableDefinition.Builder observed(Reference observed)
Definition of the actual variable related to the statistic(s).Allowed resource types for this reference:
- Parameters:
observed
- Definition of the actual variable related to the statistic(s)- Returns:
- A reference to this Builder instance
-
intended
public Evidence.VariableDefinition.Builder intended(Reference intended)
Definition of the intended variable related to the Evidence.Allowed resource types for this reference:
- Parameters:
intended
- Definition of the intended variable related to the Evidence- Returns:
- A reference to this Builder instance
-
directnessMatch
public Evidence.VariableDefinition.Builder directnessMatch(CodeableConcept directnessMatch)
Indication of quality of match between intended variable to actual variable.- Parameters:
directnessMatch
- low | moderate | high | exact- Returns:
- A reference to this Builder instance
-
build
public Evidence.VariableDefinition build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
Evidence.VariableDefinition
- Throws:
java.lang.IllegalStateException
- if the current state cannot be built into a valid VariableDefinition per the base specification
-
validate
protected void validate(Evidence.VariableDefinition variableDefinition)
-
from
protected Evidence.VariableDefinition.Builder from(Evidence.VariableDefinition variableDefinition)
-
-