Package org.hl7.fhir.r4.model
Class ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent
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.ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent
- 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:
ResearchElementDefinition
public static class ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected Type
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).protected BooleanType
When true, members with this characteristic are excluded from the element.protected Type
Indicates what effective period the study covers.protected StringType
A narrative description of the time period the study covers.Indicates how elements are aggregated within the study effective period.protected Duration
Indicates duration from the participant's study entry.protected Type
Indicates what effective period the study covers.protected StringType
A narrative description of the time period the study covers.Indicates how elements are aggregated within the study effective period.protected Duration
Indicates duration from the study initiation.protected CodeableConcept
Specifies the UCUM unit for the outcome.protected List
<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
-
Constructor Summary
ConstructorDescriptionConstructorResearchElementDefinitionCharacteristicComponent
(Type definition) Constructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setDefinition
(Type value) setExclude
(boolean value) setExcludeElement
(BooleanType value) setParticipantEffective
(Type value) setParticipantEffectiveGroupMeasureElement
(Enumeration<ResearchElementDefinition.GroupMeasure> value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setStudyEffective
(Type value) setUnitOfMeasure
(CodeableConcept value) 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
-
definition
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). -
usageContext
Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings. -
exclude
When true, members with this characteristic are excluded from the element. -
unitOfMeasure
Specifies the UCUM unit for the outcome. -
studyEffectiveDescription
A narrative description of the time period the study covers. -
studyEffective
Indicates what effective period the study covers. -
studyEffectiveTimeFromStart
Indicates duration from the study initiation. -
studyEffectiveGroupMeasure
Indicates how elements are aggregated within the study effective period. -
participantEffectiveDescription
A narrative description of the time period the study covers. -
participantEffective
Indicates what effective period the study covers. -
participantEffectiveTimeFromStart
Indicates duration from the participant's study entry. -
participantEffectiveGroupMeasure
Indicates how elements are aggregated within the study effective period.
-
-
Constructor Details
-
ResearchElementDefinitionCharacteristicComponent
Constructor -
ResearchElementDefinitionCharacteristicComponent
Constructor
-
-
Method Details
-
getDefinition
- Returns:
definition
(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).)
-
getDefinitionCodeableConcept
- Returns:
definition
(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).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionCodeableConcept
-
getDefinitionCanonicalType
- Returns:
definition
(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).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionCanonicalType
-
getDefinitionExpression
- Returns:
definition
(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).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionExpression
-
getDefinitionDataRequirement
- Returns:
definition
(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).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDefinitionDataRequirement
-
hasDefinition
-
setDefinition
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setDefinition(Type value) - Parameters:
value
-definition
(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).)
-
getUsageContext
- Returns:
usageContext
(Use UsageContext to define the members of the population, such as Age Ranges, Genders, Settings.)
-
setUsageContext
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setUsageContext(List<UsageContext> theUsageContext) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasUsageContext
-
addUsageContext
-
addUsageContext
-
getUsageContextFirstRep
- Returns:
- The first repetition of repeating field
usageContext
, creating it if it does not already exist
-
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
-
hasExclude
-
setExcludeElement
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent 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
- Returns:
- When true, members with this characteristic are excluded from the element.
-
setExclude
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setExclude(boolean value) - Parameters:
value
- When true, members with this characteristic are excluded from the element.
-
getUnitOfMeasure
- Returns:
unitOfMeasure
(Specifies the UCUM unit for the outcome.)
-
hasUnitOfMeasure
-
setUnitOfMeasure
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setUnitOfMeasure(CodeableConcept value) - Parameters:
value
-unitOfMeasure
(Specifies the UCUM unit for the outcome.)
-
getStudyEffectiveDescriptionElement
- Returns:
studyEffectiveDescription
(A narrative description of the time period the study covers.). This is the underlying object with id, value and extensions. The accessor "getStudyEffectiveDescription" gives direct access to the value
-
hasStudyEffectiveDescriptionElement
-
hasStudyEffectiveDescription
-
setStudyEffectiveDescriptionElement
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffectiveDescriptionElement(StringType value) - Parameters:
value
-studyEffectiveDescription
(A narrative description of the time period the study covers.). This is the underlying object with id, value and extensions. The accessor "getStudyEffectiveDescription" gives direct access to the value
-
getStudyEffectiveDescription
- Returns:
- A narrative description of the time period the study covers.
-
setStudyEffectiveDescription
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffectiveDescription(String value) - Parameters:
value
- A narrative description of the time period the study covers.
-
getStudyEffective
- Returns:
studyEffective
(Indicates what effective period the study covers.)
-
getStudyEffectiveDateTimeType
- Returns:
studyEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStudyEffectiveDateTimeType
-
getStudyEffectivePeriod
- Returns:
studyEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStudyEffectivePeriod
-
getStudyEffectiveDuration
- Returns:
studyEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStudyEffectiveDuration
-
getStudyEffectiveTiming
- Returns:
studyEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStudyEffectiveTiming
-
hasStudyEffective
-
setStudyEffective
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffective(Type value) - Parameters:
value
-studyEffective
(Indicates what effective period the study covers.)
-
getStudyEffectiveTimeFromStart
- Returns:
studyEffectiveTimeFromStart
(Indicates duration from the study initiation.)
-
hasStudyEffectiveTimeFromStart
-
setStudyEffectiveTimeFromStart
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffectiveTimeFromStart(Duration value) - Parameters:
value
-studyEffectiveTimeFromStart
(Indicates duration from the study initiation.)
-
getStudyEffectiveGroupMeasureElement
- Returns:
studyEffectiveGroupMeasure
(Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getStudyEffectiveGroupMeasure" gives direct access to the value
-
hasStudyEffectiveGroupMeasureElement
-
hasStudyEffectiveGroupMeasure
-
setStudyEffectiveGroupMeasureElement
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffectiveGroupMeasureElement(Enumeration<ResearchElementDefinition.GroupMeasure> value) - Parameters:
value
-studyEffectiveGroupMeasure
(Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getStudyEffectiveGroupMeasure" gives direct access to the value
-
getStudyEffectiveGroupMeasure
- Returns:
- Indicates how elements are aggregated within the study effective period.
-
setStudyEffectiveGroupMeasure
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setStudyEffectiveGroupMeasure(ResearchElementDefinition.GroupMeasure value) - Parameters:
value
- Indicates how elements are aggregated within the study effective period.
-
getParticipantEffectiveDescriptionElement
- Returns:
participantEffectiveDescription
(A narrative description of the time period the study covers.). This is the underlying object with id, value and extensions. The accessor "getParticipantEffectiveDescription" gives direct access to the value
-
hasParticipantEffectiveDescriptionElement
-
hasParticipantEffectiveDescription
-
setParticipantEffectiveDescriptionElement
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffectiveDescriptionElement(StringType value) - Parameters:
value
-participantEffectiveDescription
(A narrative description of the time period the study covers.). This is the underlying object with id, value and extensions. The accessor "getParticipantEffectiveDescription" gives direct access to the value
-
getParticipantEffectiveDescription
- Returns:
- A narrative description of the time period the study covers.
-
setParticipantEffectiveDescription
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffectiveDescription(String value) - Parameters:
value
- A narrative description of the time period the study covers.
-
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
-
getParticipantEffectivePeriod
- Returns:
participantEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasParticipantEffectivePeriod
-
getParticipantEffectiveDuration
- Returns:
participantEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasParticipantEffectiveDuration
-
getParticipantEffectiveTiming
- Returns:
participantEffective
(Indicates what effective period the study covers.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasParticipantEffectiveTiming
-
hasParticipantEffective
-
setParticipantEffective
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffective(Type value) - Parameters:
value
-participantEffective
(Indicates what effective period the study covers.)
-
getParticipantEffectiveTimeFromStart
- Returns:
participantEffectiveTimeFromStart
(Indicates duration from the participant's study entry.)
-
hasParticipantEffectiveTimeFromStart
-
setParticipantEffectiveTimeFromStart
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffectiveTimeFromStart(Duration value) - Parameters:
value
-participantEffectiveTimeFromStart
(Indicates duration from the participant's study entry.)
-
getParticipantEffectiveGroupMeasureElement
public Enumeration<ResearchElementDefinition.GroupMeasure> getParticipantEffectiveGroupMeasureElement()- Returns:
participantEffectiveGroupMeasure
(Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getParticipantEffectiveGroupMeasure" gives direct access to the value
-
hasParticipantEffectiveGroupMeasureElement
-
hasParticipantEffectiveGroupMeasure
-
setParticipantEffectiveGroupMeasureElement
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffectiveGroupMeasureElement(Enumeration<ResearchElementDefinition.GroupMeasure> value) - Parameters:
value
-participantEffectiveGroupMeasure
(Indicates how elements are aggregated within the study effective period.). This is the underlying object with id, value and extensions. The accessor "getParticipantEffectiveGroupMeasure" gives direct access to the value
-
getParticipantEffectiveGroupMeasure
- Returns:
- Indicates how elements are aggregated within the study effective period.
-
setParticipantEffectiveGroupMeasure
public ResearchElementDefinition.ResearchElementDefinitionCharacteristicComponent setParticipantEffectiveGroupMeasure(ResearchElementDefinition.GroupMeasure value) - Parameters:
value
- Indicates how elements are aggregated within the study effective period.
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
-