Package org.hl7.fhir.r5.model

Class Observation.ObservationReferenceRangeComponent

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.Observation.ObservationReferenceRangeComponent

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:

Observation

public static class Observation.ObservationReferenceRangeComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

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 Range	age	The age at which this reference range is applicable.
protected List<CodeableConcept>	appliesTo	Codes to indicate the target population this reference range applies to.
protected Quantity	high	The value of the high bound of the reference range.
protected Quantity	low	The value of the low bound of the reference range.
protected CodeableConcept	normalValue	The value of the normal value of the reference range.
protected MarkdownType	text	Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation.
protected CodeableConcept	type	Codes to indicate the what part of the targeted reference population it applies to.

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
ObservationReferenceRangeComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAppliesTo()
Observation.ObservationReferenceRangeComponent	addAppliesTo(CodeableConcept t)
Base	addChild(String name)
Observation.ObservationReferenceRangeComponent	copy()
void	copyValues(Observation.ObservationReferenceRangeComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Range	getAge()
List<CodeableConcept>	getAppliesTo()
CodeableConcept	getAppliesToFirstRep()
Quantity	getHigh()
Quantity	getLow()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
CodeableConcept	getNormalValue()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getText()
MarkdownType	getTextElement()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAge()
boolean	hasAppliesTo()
boolean	hasHigh()
boolean	hasLow()
boolean	hasNormalValue()
boolean	hasText()
boolean	hasTextElement()
boolean	hasType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Observation.ObservationReferenceRangeComponent	setAge(Range value)
Observation.ObservationReferenceRangeComponent	setAppliesTo(List<CodeableConcept> theAppliesTo)
Observation.ObservationReferenceRangeComponent	setHigh(Quantity value)
Observation.ObservationReferenceRangeComponent	setLow(Quantity value)
Observation.ObservationReferenceRangeComponent	setNormalValue(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Observation.ObservationReferenceRangeComponent	setText(String value)
Observation.ObservationReferenceRangeComponent	setTextElement(MarkdownType value)
Observation.ObservationReferenceRangeComponent	setType(CodeableConcept value)

Methods inherited from class org.hl7.fhir.r5.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.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, 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

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

low

protected Quantity low

The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3).

high

protected Quantity high

The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).

normalValue

protected CodeableConcept normalValue

The value of the normal value of the reference range.

type

protected CodeableConcept type

Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.

appliesTo

protected List<CodeableConcept> appliesTo

Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.

age

protected Range age

The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.

text

protected MarkdownType text

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

Constructor Details

ObservationReferenceRangeComponent

public ObservationReferenceRangeComponent()

Constructor

Method Details

getLow

public Quantity getLow()

Returns:

low (The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3).)

hasLow

public boolean hasLow()

setLow

public Observation.ObservationReferenceRangeComponent setLow(Quantity value)

Parameters:

value - low (The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is invalid input: '<'=2.3).)

getHigh

public Quantity getHigh()

Returns:

high (The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).)

hasHigh

public boolean hasHigh()

setHigh

public Observation.ObservationReferenceRangeComponent setHigh(Quantity value)

Parameters:

value - high (The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - invalid input: '<'=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).)

getNormalValue

public CodeableConcept getNormalValue()

Returns:

normalValue (The value of the normal value of the reference range.)

hasNormalValue

public boolean hasNormalValue()

setNormalValue

public Observation.ObservationReferenceRangeComponent setNormalValue(CodeableConcept value)

Parameters:

value - normalValue (The value of the normal value of the reference range.)

getType

public CodeableConcept getType()

Returns:

type (Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.)

hasType

public boolean hasType()

setType

public Observation.ObservationReferenceRangeComponent setType(CodeableConcept value)

Parameters:

value - type (Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.)

getAppliesTo

public List<CodeableConcept> getAppliesTo()

Returns:

appliesTo (Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used.)

setAppliesTo

public Observation.ObservationReferenceRangeComponent setAppliesTo(List<CodeableConcept> theAppliesTo)

Returns:

Returns a reference to this for easy method chaining

hasAppliesTo

public boolean hasAppliesTo()

addAppliesTo

public CodeableConcept addAppliesTo()

addAppliesTo

public Observation.ObservationReferenceRangeComponent addAppliesTo(CodeableConcept t)

getAppliesToFirstRep

public CodeableConcept getAppliesToFirstRep()

Returns:

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

getAge

public Range getAge()

Returns:

age (The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.)

hasAge

public boolean hasAge()

setAge

public Observation.ObservationReferenceRangeComponent setAge(Range value)

Parameters:

value - age (The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.)

getTextElement

public MarkdownType getTextElement()

Returns:

text (Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

hasTextElement

public boolean hasTextElement()

hasText

public boolean hasText()

setTextElement

public Observation.ObservationReferenceRangeComponent setTextElement(MarkdownType value)

Parameters:

value - text (Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

getText

public String getText()

Returns:

Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

setText

public Observation.ObservationReferenceRangeComponent setText(String value)

Parameters:

value - Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals".

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 Observation.ObservationReferenceRangeComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Observation.ObservationReferenceRangeComponent 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

Returns:

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