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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Enumeration<Enumerations.FHIRAllTypes>	basis	The population basis specifies the type of elements in the population.
protected CodeableConcept	code	Indicates a meaning for the group.
protected StringType	description	The human readable description of this population group.
protected CodeableConcept	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).
protected List<Measure.MeasureGroupPopulationComponent>	population	A population criteria for the measure.
protected CodeableConcept	scoring	Indicates how the calculation is performed for the measure, including proportion, ratio, continuous-variable, and cohort.
protected CodeableConcept	scoringUnit	Defines the expected units of measure for the measure score.
protected List<Measure.MeasureGroupStratifierComponent>	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.
protected List<CodeableConcept>	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.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
MeasureGroupComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Measure.MeasureGroupPopulationComponent	addPopulation()
Measure.MeasureGroupComponent	addPopulation(Measure.MeasureGroupPopulationComponent t)
Measure.MeasureGroupStratifierComponent	addStratifier()
Measure.MeasureGroupComponent	addStratifier(Measure.MeasureGroupStratifierComponent t)
CodeableConcept	addType()
Measure.MeasureGroupComponent	addType(CodeableConcept t)
Measure.MeasureGroupComponent	copy()
void	copyValues(Measure.MeasureGroupComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Enumerations.FHIRAllTypes	getBasis()
Enumeration<Enumerations.FHIRAllTypes>	getBasisElement()
CodeableConcept	getCode()
String	getDescription()
StringType	getDescriptionElement()
CodeableConcept	getImprovementNotation()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Measure.MeasureGroupPopulationComponent>	getPopulation()
Measure.MeasureGroupPopulationComponent	getPopulationFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getScoring()
CodeableConcept	getScoringUnit()
List<Measure.MeasureGroupStratifierComponent>	getStratifier()
Measure.MeasureGroupStratifierComponent	getStratifierFirstRep()
List<CodeableConcept>	getType()
CodeableConcept	getTypeFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasBasis()
boolean	hasBasisElement()
boolean	hasCode()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasImprovementNotation()
boolean	hasPopulation()
boolean	hasScoring()
boolean	hasScoringUnit()
boolean	hasStratifier()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Measure.MeasureGroupComponent	setBasis(Enumerations.FHIRAllTypes value)
Measure.MeasureGroupComponent	setBasisElement(Enumeration<Enumerations.FHIRAllTypes> value)
Measure.MeasureGroupComponent	setCode(CodeableConcept value)
Measure.MeasureGroupComponent	setDescription(String value)
Measure.MeasureGroupComponent	setDescriptionElement(StringType value)
Measure.MeasureGroupComponent	setImprovementNotation(CodeableConcept value)
Measure.MeasureGroupComponent	setPopulation(List<Measure.MeasureGroupPopulationComponent> thePopulation)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Measure.MeasureGroupComponent	setScoring(CodeableConcept value)
Measure.MeasureGroupComponent	setScoringUnit(CodeableConcept value)
Measure.MeasureGroupComponent	setStratifier(List<Measure.MeasureGroupStratifierComponent> theStratifier)
Measure.MeasureGroupComponent	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

protected CodeableConcept 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

protected StringType description

The human readable description of this population group.

type

protected List<CodeableConcept> 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

protected Enumeration<Enumerations.FHIRAllTypes> 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

protected CodeableConcept 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

protected CodeableConcept scoringUnit

Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.

improvementNotation

protected CodeableConcept 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

protected List<Measure.MeasureGroupPopulationComponent> population

A population criteria for the measure.

stratifier

protected List<Measure.MeasureGroupStratifierComponent> 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

public CodeableConcept 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

public boolean hasCode()

setCode

public Measure.MeasureGroupComponent setCode(CodeableConcept value)

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

public StringType 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

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public Measure.MeasureGroupComponent setDescriptionElement(StringType value)

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

public String getDescription()

Returns:

The human readable description of this population group.

setDescription

public Measure.MeasureGroupComponent setDescription(String value)

Parameters:

value - The human readable description of this population group.

getType

public List<CodeableConcept> 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

public Measure.MeasureGroupComponent setType(List<CodeableConcept> theType)

Returns:

Returns a reference to this for easy method chaining

hasType

public boolean hasType()

addType

public CodeableConcept addType()

addType

public Measure.MeasureGroupComponent addType(CodeableConcept t)

getTypeFirstRep

public CodeableConcept getTypeFirstRep()

Returns:

The first repetition of repeating field type, creating it if it does not already exist {3}

getBasisElement

public Enumeration<Enumerations.FHIRAllTypes> 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

public boolean hasBasisElement()

hasBasis

public boolean hasBasis()

setBasisElement

public Measure.MeasureGroupComponent setBasisElement(Enumeration<Enumerations.FHIRAllTypes> value)

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

public Enumerations.FHIRAllTypes 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

public Measure.MeasureGroupComponent setBasis(Enumerations.FHIRAllTypes value)

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

public CodeableConcept 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

public boolean hasScoring()

setScoring

public Measure.MeasureGroupComponent setScoring(CodeableConcept value)

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

public CodeableConcept getScoringUnit()

Returns:

scoringUnit (Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.)

hasScoringUnit

public boolean hasScoringUnit()

setScoringUnit

public Measure.MeasureGroupComponent setScoringUnit(CodeableConcept value)

Parameters:

value - scoringUnit (Defines the expected units of measure for the measure score. This element SHOULD be specified as a UCUM unit.)

getImprovementNotation

public CodeableConcept 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

public boolean hasImprovementNotation()

setImprovementNotation

public Measure.MeasureGroupComponent setImprovementNotation(CodeableConcept value)

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

public List<Measure.MeasureGroupPopulationComponent> 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

public boolean hasPopulation()

addPopulation

public Measure.MeasureGroupPopulationComponent addPopulation()

addPopulation

public Measure.MeasureGroupComponent addPopulation(Measure.MeasureGroupPopulationComponent t)

getPopulationFirstRep

public Measure.MeasureGroupPopulationComponent getPopulationFirstRep()

Returns:

The first repetition of repeating field population, creating it if it does not already exist {3}

getStratifier

public List<Measure.MeasureGroupStratifierComponent> 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

public boolean hasStratifier()

addStratifier

public Measure.MeasureGroupStratifierComponent addStratifier()

addStratifier

public Measure.MeasureGroupComponent addStratifier(Measure.MeasureGroupStratifierComponent t)

getStratifierFirstRep

public Measure.MeasureGroupStratifierComponent getStratifierFirstRep()

Returns:

The first repetition of repeating field stratifier, creating it if it does not already exist {3}

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

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 Measure.MeasureGroupComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Measure.MeasureGroupComponent 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