Package org.hl7.fhir.r4.model

Class EvidenceVariable.EvidenceVariableCharacteristicComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.model.EvidenceVariable.EvidenceVariableCharacteristicComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

EvidenceVariable

public static class EvidenceVariable.EvidenceVariableCharacteristicComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Type	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).
protected StringType	description	A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.
protected BooleanType	exclude	When true, members with this characteristic are excluded from the element.
protected Enumeration<EvidenceVariable.GroupMeasure>	groupMeasure	Indicates how elements are aggregated within the study effective period.
protected Type	participantEffective	Indicates what effective period the study covers.
protected Duration	timeFromStart	Indicates duration from the participant's study entry.
protected List<UsageContext>	usageContext	Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
EvidenceVariableCharacteristicComponent()	Constructor
EvidenceVariableCharacteristicComponent(Type definition)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
UsageContext	addUsageContext()
EvidenceVariable.EvidenceVariableCharacteristicComponent	addUsageContext(UsageContext t)
EvidenceVariable.EvidenceVariableCharacteristicComponent	copy()
void	copyValues(EvidenceVariable.EvidenceVariableCharacteristicComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Type	getDefinition()
CanonicalType	getDefinitionCanonicalType()
CodeableConcept	getDefinitionCodeableConcept()
DataRequirement	getDefinitionDataRequirement()
Expression	getDefinitionExpression()
Reference	getDefinitionReference()
TriggerDefinition	getDefinitionTriggerDefinition()
String	getDescription()
StringType	getDescriptionElement()
boolean	getExclude()
BooleanType	getExcludeElement()
EvidenceVariable.GroupMeasure	getGroupMeasure()
Enumeration<EvidenceVariable.GroupMeasure>	getGroupMeasureElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Type	getParticipantEffective()
DateTimeType	getParticipantEffectiveDateTimeType()
Duration	getParticipantEffectiveDuration()
Period	getParticipantEffectivePeriod()
Timing	getParticipantEffectiveTiming()
Base[]	getProperty(int hash, String name, boolean checkValid)
Duration	getTimeFromStart()
String[]	getTypesForProperty(int hash, String name)
List<UsageContext>	getUsageContext()
UsageContext	getUsageContextFirstRep()
boolean	hasDefinition()
boolean	hasDefinitionCanonicalType()
boolean	hasDefinitionCodeableConcept()
boolean	hasDefinitionDataRequirement()
boolean	hasDefinitionExpression()
boolean	hasDefinitionReference()
boolean	hasDefinitionTriggerDefinition()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExclude()
boolean	hasExcludeElement()
boolean	hasGroupMeasure()
boolean	hasGroupMeasureElement()
boolean	hasParticipantEffective()
boolean	hasParticipantEffectiveDateTimeType()
boolean	hasParticipantEffectiveDuration()
boolean	hasParticipantEffectivePeriod()
boolean	hasParticipantEffectiveTiming()
boolean	hasTimeFromStart()
boolean	hasUsageContext()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setDefinition(Type value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setDescription(String value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setDescriptionElement(StringType value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setExclude(boolean value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setExcludeElement(BooleanType value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setGroupMeasure(EvidenceVariable.GroupMeasure value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setGroupMeasureElement(Enumeration<EvidenceVariable.GroupMeasure> value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setParticipantEffective(Type value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setTimeFromStart(Duration value)
EvidenceVariable.EvidenceVariableCharacteristicComponent	setUsageContext(List<UsageContext> theUsageContext)

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

description

protected StringType description

A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

definition

protected Type 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).

usageContext

protected List<UsageContext> usageContext

Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.

exclude

protected BooleanType exclude

When true, members with this characteristic are excluded from the element.

participantEffective

protected Type participantEffective

Indicates what effective period the study covers.

timeFromStart

protected Duration timeFromStart

Indicates duration from the participant's study entry.

groupMeasure

protected Enumeration<EvidenceVariable.GroupMeasure> groupMeasure

Indicates how elements are aggregated within the study effective period.

Constructor Details

EvidenceVariableCharacteristicComponent

public EvidenceVariableCharacteristicComponent()

Constructor

EvidenceVariableCharacteristicComponent

public EvidenceVariableCharacteristicComponent(Type definition)

Constructor

Method Details

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public EvidenceVariable.EvidenceVariableCharacteristicComponent setDescriptionElement(StringType value)

Parameters:

value - description (A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

setDescription

public EvidenceVariable.EvidenceVariableCharacteristicComponent setDescription(String value)

Parameters:

value - A short, natural language description of the characteristic that could be used to communicate the criteria to an end-user.

getDefinition

public Type getDefinition()

Returns:

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

getDefinitionReference

public Reference getDefinitionReference()
                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionReference

public boolean hasDefinitionReference()

getDefinitionCanonicalType

public CanonicalType getDefinitionCanonicalType()
                                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionCanonicalType

public boolean hasDefinitionCanonicalType()

getDefinitionCodeableConcept

public CodeableConcept getDefinitionCodeableConcept()
                                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionCodeableConcept

public boolean hasDefinitionCodeableConcept()

getDefinitionExpression

public Expression getDefinitionExpression()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionExpression

public boolean hasDefinitionExpression()

getDefinitionDataRequirement

public DataRequirement getDefinitionDataRequirement()
                                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionDataRequirement

public boolean hasDefinitionDataRequirement()

getDefinitionTriggerDefinition

public TriggerDefinition getDefinitionTriggerDefinition()
                                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasDefinitionTriggerDefinition

public boolean hasDefinitionTriggerDefinition()

hasDefinition

public boolean hasDefinition()

setDefinition

public EvidenceVariable.EvidenceVariableCharacteristicComponent setDefinition(Type value)

Parameters:

value - 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).)

getUsageContext

public List<UsageContext> getUsageContext()

Returns:

usageContext (Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.)

setUsageContext

public EvidenceVariable.EvidenceVariableCharacteristicComponent setUsageContext(List<UsageContext> theUsageContext)

Returns:

Returns a reference to this for easy method chaining

hasUsageContext

public boolean hasUsageContext()

addUsageContext

public UsageContext addUsageContext()

addUsageContext

public EvidenceVariable.EvidenceVariableCharacteristicComponent addUsageContext(UsageContext t)

getUsageContextFirstRep

public UsageContext getUsageContextFirstRep()

Returns:

The first repetition of repeating field usageContext, creating it if it does not already exist

getExcludeElement

public BooleanType getExcludeElement()

Returns:

exclude (When true, members with this characteristic are excluded from the element.). This is the underlying object with id, value and extensions. The accessor "getExclude" gives direct access to the value

hasExcludeElement

public boolean hasExcludeElement()

hasExclude

public boolean hasExclude()

setExcludeElement

public EvidenceVariable.EvidenceVariableCharacteristicComponent setExcludeElement(BooleanType value)

Parameters:

value - exclude (When true, members with this characteristic are excluded from the element.). This is the underlying object with id, value and extensions. The accessor "getExclude" gives direct access to the value

getExclude

public boolean getExclude()

Returns:

When true, members with this characteristic are excluded from the element.

setExclude

public EvidenceVariable.EvidenceVariableCharacteristicComponent setExclude(boolean value)

Parameters:

value - When true, members with this characteristic are excluded from the element.

getParticipantEffective

public Type getParticipantEffective()

Returns:

participantEffective (Indicates what effective period the study covers.)

getParticipantEffectiveDateTimeType

public DateTimeType getParticipantEffectiveDateTimeType()
                                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

participantEffective (Indicates what effective period the study covers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasParticipantEffectiveDateTimeType

public boolean hasParticipantEffectiveDateTimeType()

getParticipantEffectivePeriod

public Period getParticipantEffectivePeriod()
                                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

participantEffective (Indicates what effective period the study covers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasParticipantEffectivePeriod

public boolean hasParticipantEffectivePeriod()

getParticipantEffectiveDuration

public Duration getParticipantEffectiveDuration()
                                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

participantEffective (Indicates what effective period the study covers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasParticipantEffectiveDuration

public boolean hasParticipantEffectiveDuration()

getParticipantEffectiveTiming

public Timing getParticipantEffectiveTiming()
                                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

participantEffective (Indicates what effective period the study covers.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasParticipantEffectiveTiming

public boolean hasParticipantEffectiveTiming()

hasParticipantEffective

public boolean hasParticipantEffective()

setParticipantEffective

public EvidenceVariable.EvidenceVariableCharacteristicComponent setParticipantEffective(Type value)

Parameters:

value - participantEffective (Indicates what effective period the study covers.)

getTimeFromStart

public Duration getTimeFromStart()

Returns:

timeFromStart (Indicates duration from the participant's study entry.)

hasTimeFromStart

public boolean hasTimeFromStart()

setTimeFromStart

public EvidenceVariable.EvidenceVariableCharacteristicComponent setTimeFromStart(Duration value)

Parameters:

value - timeFromStart (Indicates duration from the participant's study entry.)

getGroupMeasureElement

public Enumeration<EvidenceVariable.GroupMeasure> getGroupMeasureElement()

Returns:

groupMeasure (Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getGroupMeasure" gives direct access to the value

hasGroupMeasureElement

public boolean hasGroupMeasureElement()

hasGroupMeasure

public boolean hasGroupMeasure()

setGroupMeasureElement

public EvidenceVariable.EvidenceVariableCharacteristicComponent setGroupMeasureElement(Enumeration<EvidenceVariable.GroupMeasure> value)

Parameters:

value - groupMeasure (Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getGroupMeasure" gives direct access to the value

getGroupMeasure

public EvidenceVariable.GroupMeasure getGroupMeasure()

Returns:

Indicates how elements are aggregated within the study effective period.

setGroupMeasure

public EvidenceVariable.EvidenceVariableCharacteristicComponent setGroupMeasure(EvidenceVariable.GroupMeasure value)

Parameters:

value - Indicates how elements are aggregated within the study effective period.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public EvidenceVariable.EvidenceVariableCharacteristicComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(EvidenceVariable.EvidenceVariableCharacteristicComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement