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 classResearchElementDefinition.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 voidaccept(java.lang.String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static ResearchElementDefinition.Characteristic.Builderbuilder()booleanequals(java.lang.Object obj)ElementgetDefinition()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).BooleangetExclude()When true, members with this characteristic are excluded from the element.ElementgetParticipantEffective()Indicates what effective period the study covers.StringgetParticipantEffectiveDescription()A narrative description of the time period the study covers.GroupMeasuregetParticipantEffectiveGroupMeasure()Indicates how elements are aggregated within the study effective period.DurationgetParticipantEffectiveTimeFromStart()Indicates duration from the participant's study entry.ElementgetStudyEffective()Indicates what effective period the study covers.StringgetStudyEffectiveDescription()A narrative description of the time period the study covers.GroupMeasuregetStudyEffectiveGroupMeasure()Indicates how elements are aggregated within the study effective period.DurationgetStudyEffectiveTimeFromStart()Indicates duration from the study initiation.CodeableConceptgetUnitOfMeasure()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.booleanhasChildren()inthashCode()ResearchElementDefinition.Characteristic.BuildertoBuilder()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,ExpressionorDataRequirementthat 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
UsageContextthat may be empty.
-
getExclude
public Boolean getExclude()
When true, members with this characteristic are excluded from the element.- Returns:
- An immutable object of type
Booleanthat may be null.
-
getUnitOfMeasure
public CodeableConcept getUnitOfMeasure()
Specifies the UCUM unit for the outcome.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getStudyEffectiveDescription
public String getStudyEffectiveDescription()
A narrative description of the time period the study covers.- Returns:
- An immutable object of type
Stringthat 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
Durationthat may be null.
-
getStudyEffectiveGroupMeasure
public GroupMeasure getStudyEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.- Returns:
- An immutable object of type
GroupMeasurethat may be null.
-
getParticipantEffectiveDescription
public String getParticipantEffectiveDescription()
A narrative description of the time period the study covers.- Returns:
- An immutable object of type
Stringthat 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
Durationthat may be null.
-
getParticipantEffectiveGroupMeasure
public GroupMeasure getParticipantEffectiveGroupMeasure()
Indicates how elements are aggregated within the study effective period.- Returns:
- An immutable object of type
GroupMeasurethat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)Description copied from interface:VisitableAccept 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:
acceptin interfaceVisitable- Specified by:
acceptin 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:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toBuilder
public ResearchElementDefinition.Characteristic.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static ResearchElementDefinition.Characteristic.Builder builder()
-
-