Class ResearchElementDefinition.Characteristic
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.ResearchElementDefinition.Characteristic
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- ResearchElementDefinition
public static class ResearchElementDefinition.Characteristic extends BackboneElement
A characteristic that defines the members of the research element. Multiple characteristics are applied with "and" semantics.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ResearchElementDefinition.Characteristic.Builder
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ResearchElementDefinition.Characteristic.Builder
builder()
boolean
equals(java.lang.Object obj)
Element
getDefinition()
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).Boolean
getExclude()
When true, members with this characteristic are excluded from the element.Element
getParticipantEffective()
Indicates what effective period the study covers.String
getParticipantEffectiveDescription()
A narrative description of the time period the study covers.GroupMeasure
getParticipantEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.Duration
getParticipantEffectiveTimeFromStart()
Indicates duration from the participant's study entry.Element
getStudyEffective()
Indicates what effective period the study covers.String
getStudyEffectiveDescription()
A narrative description of the time period the study covers.GroupMeasure
getStudyEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.Duration
getStudyEffectiveTimeFromStart()
Indicates duration from the study initiation.CodeableConcept
getUnitOfMeasure()
Specifies the UCUM unit for the outcome.java.util.List<UsageContext>
getUsageContext()
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.boolean
hasChildren()
int
hashCode()
ResearchElementDefinition.Characteristic.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getDefinition
public Element getDefinition()
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).- Returns:
- An immutable object of type
CodeableConcept
,Canonical
,Expression
orDataRequirement
that is non-null.
-
getUsageContext
public java.util.List<UsageContext> getUsageContext()
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getExclude
public Boolean getExclude()
When true, members with this characteristic are excluded from the element.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getUnitOfMeasure
public CodeableConcept getUnitOfMeasure()
Specifies the UCUM unit for the outcome.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getStudyEffectiveDescription
public String getStudyEffectiveDescription()
A narrative description of the time period the study covers.- Returns:
- An immutable object of type
String
that may be null.
-
getStudyEffective
public Element getStudyEffective()
Indicates what effective period the study covers.
-
getStudyEffectiveTimeFromStart
public Duration getStudyEffectiveTimeFromStart()
Indicates duration from the study initiation.- Returns:
- An immutable object of type
Duration
that may be null.
-
getStudyEffectiveGroupMeasure
public GroupMeasure getStudyEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.- Returns:
- An immutable object of type
GroupMeasure
that may be null.
-
getParticipantEffectiveDescription
public String getParticipantEffectiveDescription()
A narrative description of the time period the study covers.- Returns:
- An immutable object of type
String
that may be null.
-
getParticipantEffective
public Element getParticipantEffective()
Indicates what effective period the study covers.
-
getParticipantEffectiveTimeFromStart
public Duration getParticipantEffectiveTimeFromStart()
Indicates duration from the participant's study entry.- Returns:
- An immutable object of type
Duration
that may be null.
-
getParticipantEffectiveGroupMeasure
public GroupMeasure getParticipantEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.- Returns:
- An immutable object of type
GroupMeasure
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ResearchElementDefinition.Characteristic.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static ResearchElementDefinition.Characteristic.Builder builder()
-
-