Class EvidenceVariable.Characteristic.Builder
- java.lang.Object
-
- com.ibm.fhir.model.builder.AbstractBuilder<Element>
-
- com.ibm.fhir.model.type.Element.Builder
-
- com.ibm.fhir.model.type.BackboneElement.Builder
-
- com.ibm.fhir.model.resource.EvidenceVariable.Characteristic.Builder
-
- Enclosing class:
- EvidenceVariable.Characteristic
public static class EvidenceVariable.Characteristic.Builder extends BackboneElement.Builder
-
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
modifierExtension
-
Fields inherited from class com.ibm.fhir.model.type.Element.Builder
extension, id
-
Fields inherited from class com.ibm.fhir.model.builder.AbstractBuilder
validating
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EvidenceVariable.Characteristic
build()
Build theEvidenceVariable.Characteristic
EvidenceVariable.Characteristic.Builder
definition(Element definition)
Define members of the evidence 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).EvidenceVariable.Characteristic.Builder
description(String description)
A short, natural language description of the characteristic that could be used to communicate the criteria to an end- user.EvidenceVariable.Characteristic.Builder
exclude(Boolean exclude)
When true, members with this characteristic are excluded from the element.EvidenceVariable.Characteristic.Builder
extension(Extension... extension)
May be used to represent additional information that is not part of the basic definition of the element.EvidenceVariable.Characteristic.Builder
extension(Collection<Extension> extension)
May be used to represent additional information that is not part of the basic definition of the element.protected EvidenceVariable.Characteristic.Builder
from(EvidenceVariable.Characteristic characteristic)
EvidenceVariable.Characteristic.Builder
groupMeasure(GroupMeasure groupMeasure)
Indicates how elements are aggregated within the study effective period.EvidenceVariable.Characteristic.Builder
id(String id)
Unique id for the element within a resource (for internal references).EvidenceVariable.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.EvidenceVariable.Characteristic.Builder
modifierExtension(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.EvidenceVariable.Characteristic.Builder
participantEffective(Element participantEffective)
Indicates what effective period the study covers.EvidenceVariable.Characteristic.Builder
timeFromStart(Duration timeFromStart)
Indicates duration from the participant's study entry.EvidenceVariable.Characteristic.Builder
usageContext(UsageContext... usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.EvidenceVariable.Characteristic.Builder
usageContext(Collection<UsageContext> usageContext)
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.protected void
validate(EvidenceVariable.Characteristic characteristic)
-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.type.Element.Builder
from, validate
-
Methods inherited from class com.ibm.fhir.model.builder.AbstractBuilder
isValidating, setValidating
-
-
-
-
Method Detail
-
id
public EvidenceVariable.Characteristic.Builder id(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 EvidenceVariable.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
- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
extension
public EvidenceVariable.Characteristic.Builder extension(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
- Overrides:
extension
in classBackboneElement.Builder
- Parameters:
extension
- Additional content defined by implementations- Returns:
- A reference to this Builder instance
-
modifierExtension
public EvidenceVariable.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
- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
modifierExtension
public EvidenceVariable.Characteristic.Builder modifierExtension(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
- Overrides:
modifierExtension
in classBackboneElement.Builder
- Parameters:
modifierExtension
- Extensions that cannot be ignored even if unrecognized- Returns:
- A reference to this Builder instance
-
description
public EvidenceVariable.Characteristic.Builder description(String description)
A short, natural language description of the characteristic that could be used to communicate the criteria to an end- user.- Parameters:
description
- Natural language description of the characteristic- Returns:
- A reference to this Builder instance
-
definition
public EvidenceVariable.Characteristic.Builder definition(Element definition)
Define members of the evidence 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:
When of typeReference
, the allowed resource types for this reference are:- Parameters:
definition
- What code or expression defines members?- Returns:
- A reference to this Builder instance
-
usageContext
public EvidenceVariable.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
- Parameters:
usageContext
- What code/value pairs define members?- Returns:
- A reference to this Builder instance
-
usageContext
public EvidenceVariable.Characteristic.Builder usageContext(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
- Parameters:
usageContext
- What code/value pairs define members?- Returns:
- A reference to this Builder instance
-
exclude
public EvidenceVariable.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
-
participantEffective
public EvidenceVariable.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
-
timeFromStart
public EvidenceVariable.Characteristic.Builder timeFromStart(Duration timeFromStart)
Indicates duration from the participant's study entry.- Parameters:
timeFromStart
- Observation time from study start- Returns:
- A reference to this Builder instance
-
groupMeasure
public EvidenceVariable.Characteristic.Builder groupMeasure(GroupMeasure groupMeasure)
Indicates how elements are aggregated within the study effective period.- Parameters:
groupMeasure
- mean | median | mean-of-mean | mean-of-median | median-of-mean | median-of-median- Returns:
- A reference to this Builder instance
-
build
public EvidenceVariable.Characteristic build()
- Specified by:
build
in interfaceBuilder<Element>
- Specified by:
build
in classBackboneElement.Builder
- Returns:
- An immutable object of type
EvidenceVariable.Characteristic
- Throws:
IllegalStateException
- if the current state cannot be built into a valid Characteristic per the base specification
-
validate
protected void validate(EvidenceVariable.Characteristic characteristic)
-
from
protected EvidenceVariable.Characteristic.Builder from(EvidenceVariable.Characteristic characteristic)
-
-