Package org.hl7.fhir.r5.model

Class Statistic

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.BackboneType

org.hl7.fhir.r5.model.Statistic

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.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Statistic
extends BackboneType
implements org.hl7.fhir.instance.model.api.ICompositeType

Base StructureDefinition for Statistic Type: A fact or piece of data from a study of a large quantity of numerical data. A mathematical or quantified characteristic of a group of observations.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Statistic.StatisticAttributeEstimateAttributeEstimateComponent
static class	Statistic.StatisticAttributeEstimateComponent
static class	Statistic.StatisticModelCharacteristicComponent
static class	Statistic.StatisticModelCharacteristicVariableComponent
static class	Statistic.StatisticSampleSizeComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Statistic.StatisticAttributeEstimateComponent>	attributeEstimate	A statistical attribute of the statistic such as a measure of heterogeneity.
protected CodeableConcept	category	When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.
protected StringType	description	A description of the content value of the statistic.
protected List<Statistic.StatisticModelCharacteristicComponent>	modelCharacteristic	A component of the method to generate the statistic.
protected List<Annotation>	note	Footnotes and/or explanatory notes.
protected UnsignedIntType	numberAffected	The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.
protected UnsignedIntType	numberOfEvents	The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.
protected Quantity	quantity	Statistic value.
protected Statistic.StatisticSampleSizeComponent	sampleSize	Number of samples in the statistic.
protected CodeableConcept	statisticType	Type of statistic, eg relative risk.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
Statistic()	Constructor

Method Summary

Modifier and Type	Method	Description
Statistic.StatisticAttributeEstimateComponent	addAttributeEstimate()
Statistic	addAttributeEstimate(Statistic.StatisticAttributeEstimateComponent t)
Base	addChild(String name)
Statistic.StatisticModelCharacteristicComponent	addModelCharacteristic()
Statistic	addModelCharacteristic(Statistic.StatisticModelCharacteristicComponent t)
Annotation	addNote()
Statistic	addNote(Annotation t)
Statistic	copy()
void	copyValues(Statistic dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Statistic.StatisticAttributeEstimateComponent>	getAttributeEstimate()
Statistic.StatisticAttributeEstimateComponent	getAttributeEstimateFirstRep()
CodeableConcept	getCategory()
String	getDescription()
StringType	getDescriptionElement()
List<Statistic.StatisticModelCharacteristicComponent>	getModelCharacteristic()
Statistic.StatisticModelCharacteristicComponent	getModelCharacteristicFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
int	getNumberAffected()
UnsignedIntType	getNumberAffectedElement()
int	getNumberOfEvents()
UnsignedIntType	getNumberOfEventsElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Quantity	getQuantity()
Statistic.StatisticSampleSizeComponent	getSampleSize()
CodeableConcept	getStatisticType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAttributeEstimate()
boolean	hasCategory()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasModelCharacteristic()
boolean	hasNote()
boolean	hasNumberAffected()
boolean	hasNumberAffectedElement()
boolean	hasNumberOfEvents()
boolean	hasNumberOfEventsElement()
boolean	hasQuantity()
boolean	hasSampleSize()
boolean	hasStatisticType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Statistic	setAttributeEstimate(List<Statistic.StatisticAttributeEstimateComponent> theAttributeEstimate)
Statistic	setCategory(CodeableConcept value)
Statistic	setDescription(String value)
Statistic	setDescriptionElement(StringType value)
Statistic	setModelCharacteristic(List<Statistic.StatisticModelCharacteristicComponent> theModelCharacteristic)
Statistic	setNote(List<Annotation> theNote)
Statistic	setNumberAffected(int value)
Statistic	setNumberAffectedElement(UnsignedIntType value)
Statistic	setNumberOfEvents(int value)
Statistic	setNumberOfEventsElement(UnsignedIntType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Statistic	setQuantity(Quantity value)
Statistic	setSampleSize(Statistic.StatisticSampleSizeComponent value)
Statistic	setStatisticType(CodeableConcept value)
protected Statistic	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.BackboneType

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

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

Field Details

description

protected StringType description

A description of the content value of the statistic.

note

protected List<Annotation> note

Footnotes and/or explanatory notes.

statisticType

protected CodeableConcept statisticType

Type of statistic, eg relative risk.

category

protected CodeableConcept category

When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.

quantity

protected Quantity quantity

Statistic value.

numberOfEvents

protected UnsignedIntType numberOfEvents

The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.

numberAffected

protected UnsignedIntType numberAffected

The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.

sampleSize

protected Statistic.StatisticSampleSizeComponent sampleSize

Number of samples in the statistic.

attributeEstimate

protected List<Statistic.StatisticAttributeEstimateComponent> attributeEstimate

A statistical attribute of the statistic such as a measure of heterogeneity.

modelCharacteristic

protected List<Statistic.StatisticModelCharacteristicComponent> modelCharacteristic

A component of the method to generate the statistic.

Constructor Details

Statistic

public Statistic()

Constructor

Method Details

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A description of the content value of the statistic.). 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 Statistic setDescriptionElement(StringType value)

Parameters:

value - description (A description of the content value of the statistic.). 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 description of the content value of the statistic.

setDescription

public Statistic setDescription(String value)

Parameters:

value - A description of the content value of the statistic.

getNote

public List<Annotation> getNote()

Returns:

note (Footnotes and/or explanatory notes.)

setNote

public Statistic setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public Statistic addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getStatisticType

public CodeableConcept getStatisticType()

Returns:

statisticType (Type of statistic, eg relative risk.)

hasStatisticType

public boolean hasStatisticType()

setStatisticType

public Statistic setStatisticType(CodeableConcept value)

Parameters:

value - statisticType (Type of statistic, eg relative risk.)

getCategory

public CodeableConcept getCategory()

Returns:

category (When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.)

hasCategory

public boolean hasCategory()

setCategory

public Statistic setCategory(CodeableConcept value)

Parameters:

value - category (When the measured variable is handled categorically, the category element is used to define which category the statistic is reporting.)

getQuantity

public Quantity getQuantity()

Returns:

quantity (Statistic value.)

hasQuantity

public boolean hasQuantity()

setQuantity

public Statistic setQuantity(Quantity value)

Parameters:

value - quantity (Statistic value.)

getNumberOfEventsElement

public UnsignedIntType getNumberOfEventsElement()

Returns:

numberOfEvents (The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.). This is the underlying object with id, value and extensions. The accessor "getNumberOfEvents" gives direct access to the value

hasNumberOfEventsElement

public boolean hasNumberOfEventsElement()

hasNumberOfEvents

public boolean hasNumberOfEvents()

setNumberOfEventsElement

public Statistic setNumberOfEventsElement(UnsignedIntType value)

Parameters:

value - numberOfEvents (The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.). This is the underlying object with id, value and extensions. The accessor "getNumberOfEvents" gives direct access to the value

getNumberOfEvents

public int getNumberOfEvents()

Returns:

The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.

setNumberOfEvents

public Statistic setNumberOfEvents(int value)

Parameters:

value - The number of events associated with the statistic, where the unit of analysis is different from numberAffected, sampleSize.knownDataCount and sampleSize.numberOfParticipants.

getNumberAffectedElement

public UnsignedIntType getNumberAffectedElement()

Returns:

numberAffected (The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.). This is the underlying object with id, value and extensions. The accessor "getNumberAffected" gives direct access to the value

hasNumberAffectedElement

public boolean hasNumberAffectedElement()

hasNumberAffected

public boolean hasNumberAffected()

setNumberAffectedElement

public Statistic setNumberAffectedElement(UnsignedIntType value)

Parameters:

value - numberAffected (The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.). This is the underlying object with id, value and extensions. The accessor "getNumberAffected" gives direct access to the value

getNumberAffected

public int getNumberAffected()

Returns:

The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.

setNumberAffected

public Statistic setNumberAffected(int value)

Parameters:

value - The number of participants affected where the unit of analysis is the same as sampleSize.knownDataCount and sampleSize.numberOfParticipants.

getSampleSize

public Statistic.StatisticSampleSizeComponent getSampleSize()

Returns:

sampleSize (Number of samples in the statistic.)

hasSampleSize

public boolean hasSampleSize()

setSampleSize

public Statistic setSampleSize(Statistic.StatisticSampleSizeComponent value)

Parameters:

value - sampleSize (Number of samples in the statistic.)

getAttributeEstimate

public List<Statistic.StatisticAttributeEstimateComponent> getAttributeEstimate()

Returns:

attributeEstimate (A statistical attribute of the statistic such as a measure of heterogeneity.)

setAttributeEstimate

public Statistic setAttributeEstimate(List<Statistic.StatisticAttributeEstimateComponent> theAttributeEstimate)

Returns:

Returns a reference to this for easy method chaining

hasAttributeEstimate

public boolean hasAttributeEstimate()

addAttributeEstimate

public Statistic.StatisticAttributeEstimateComponent addAttributeEstimate()

addAttributeEstimate

public Statistic addAttributeEstimate(Statistic.StatisticAttributeEstimateComponent t)

getAttributeEstimateFirstRep

public Statistic.StatisticAttributeEstimateComponent getAttributeEstimateFirstRep()

Returns:

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

getModelCharacteristic

public List<Statistic.StatisticModelCharacteristicComponent> getModelCharacteristic()

Returns:

modelCharacteristic (A component of the method to generate the statistic.)

setModelCharacteristic

public Statistic setModelCharacteristic(List<Statistic.StatisticModelCharacteristicComponent> theModelCharacteristic)

Returns:

Returns a reference to this for easy method chaining

hasModelCharacteristic

public boolean hasModelCharacteristic()

addModelCharacteristic

public Statistic.StatisticModelCharacteristicComponent addModelCharacteristic()

addModelCharacteristic

public Statistic addModelCharacteristic(Statistic.StatisticModelCharacteristicComponent t)

getModelCharacteristicFirstRep

public Statistic.StatisticModelCharacteristicComponent getModelCharacteristicFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneType

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneType

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 BackboneType

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 BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneType

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Statistic copy()

Specified by:

copy in class BackboneType

copyValues

public void copyValues(Statistic dst)

typedCopy

protected Statistic typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneType

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneType

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneType