
Package org.hl7.fhir.r5.model
Class Measure.MeasureGroupComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.Measure.MeasureGroupComponent
- 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:
- Measure
public static class Measure.MeasureGroupComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Enumeration<Enumerations.FHIRAllTypes>
The population basis specifies the type of elements in the population.protected CodeableConcept
Indicates a meaning for the group.protected StringType
The human readable description of this population group.protected CodeableConcept
Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).protected List<Measure.MeasureGroupPopulationComponent>
A population criteria for the measure.protected CodeableConcept
Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort.protected CodeableConcept
Defines the expected units of measure for the measure score.protected List<Measure.MeasureGroupStratifierComponent>
The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.protected List<CodeableConcept>
Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddType()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getBasis()
getCode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
hasBasis()
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCode
(CodeableConcept value) setDescription
(String value) setDescriptionElement
(StringType value) setPopulation
(List<Measure.MeasureGroupPopulationComponent> thePopulation) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setScoring
(CodeableConcept value) setScoringUnit
(CodeableConcept value) setStratifier
(List<Measure.MeasureGroupStratifierComponent> theStratifier) setType
(List<CodeableConcept> theType) Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, 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.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
code
Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures. -
description
The human readable description of this population group. -
type
Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization. -
basis
The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters. -
scoring
Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented. -
scoringUnit
Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit. -
improvementNotation
Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range). -
population
A population criteria for the measure. -
stratifier
The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.
-
-
Constructor Details
-
MeasureGroupComponent
public MeasureGroupComponent()Constructor
-
-
Method Details
-
getCode
- Returns:
code
(Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.)
-
hasCode
-
setCode
- Parameters:
value
-code
(Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures.)
-
getDescriptionElement
- Returns:
description
(The human readable description of this population group.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(The human readable description of this population group.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- The human readable description of this population group.
-
setDescription
- Parameters:
value
- The human readable description of this population group.
-
getType
- Returns:
type
(Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.)
-
setType
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasType
-
addType
-
addType
-
getTypeFirstRep
- Returns:
- The first repetition of repeating field
type
, creating it if it does not already exist {3}
-
getBasisElement
- Returns:
basis
(The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.). This is the underlying object with id, value and extensions. The accessor "getBasis" gives direct access to the value
-
hasBasisElement
-
hasBasis
-
setBasisElement
- Parameters:
value
-basis
(The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.). This is the underlying object with id, value and extensions. The accessor "getBasis" gives direct access to the value
-
getBasis
- Returns:
- The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.
-
setBasis
- Parameters:
value
- The population basis specifies the type of elements in the population. For a subject-based measure, this is boolean (because the subject and the population basis are the same, and the population criteria define yes/no values for each individual in the population). For measures that have a population basis that is different than the subject, this element specifies the type of the population basis. For example, an encounter-based measure has a subject of Patient and a population basis of Encounter, and the population criteria all return lists of Encounters.
-
getScoring
- Returns:
scoring
(Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.)
-
hasScoring
-
setScoring
- Parameters:
value
-scoring
(Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.)
-
getScoringUnit
- Returns:
scoringUnit
(Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.)
-
hasScoringUnit
-
setScoringUnit
- Parameters:
value
-scoringUnit
(Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.)
-
getImprovementNotation
- Returns:
improvementNotation
(Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).)
-
hasImprovementNotation
-
setImprovementNotation
- Parameters:
value
-improvementNotation
(Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is within a range).)
-
getPopulation
- Returns:
population
(A population criteria for the measure.)
-
setPopulation
public Measure.MeasureGroupComponent setPopulation(List<Measure.MeasureGroupPopulationComponent> thePopulation) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPopulation
-
addPopulation
-
addPopulation
-
getPopulationFirstRep
- Returns:
- The first repetition of repeating field
population
, creating it if it does not already exist {3}
-
getStratifier
- Returns:
stratifier
(The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path.)
-
setStratifier
public Measure.MeasureGroupComponent setStratifier(List<Measure.MeasureGroupStratifierComponent> theStratifier) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasStratifier
-
addStratifier
-
addStratifier
-
getStratifierFirstRep
- Returns:
- The first repetition of repeating field
stratifier
, creating it if it does not already exist {3}
-
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
-
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
-