Package com.ibm.fhir.model.resource

Class 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.

    • 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 or DataRequirement 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.
        Returns:
        An immutable object of type DateTime, Period, Duration or Timing that may be null.

      • 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.
        Returns:
        An immutable object of type DateTime, Period, Duration or Timing that may be null.

      • 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.

      • 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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object