Package com.ibm.fhir.model.resource
Class Observation.ReferenceRange
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.type.Element
-
- com.ibm.fhir.model.type.BackboneElement
-
- com.ibm.fhir.model.resource.Observation.ReferenceRange
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- Observation
public static class Observation.ReferenceRange extends BackboneElement
Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classObservation.ReferenceRange.Builder
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static Observation.ReferenceRange.Builderbuilder()booleanequals(Object obj)RangegetAge()The age at which this reference range is applicable.List<CodeableConcept>getAppliesTo()Codes to indicate the target population this reference range applies to.SimpleQuantitygetHigh()The value of the high bound of the reference range.SimpleQuantitygetLow()The value of the low bound of the reference range.StringgetText()Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation.CodeableConceptgetType()Codes to indicate the what part of the targeted reference population it applies to.booleanhasChildren()inthashCode()Observation.ReferenceRange.BuildertoBuilder()Create a new Builder from the contents of this Element-
Methods inherited from class com.ibm.fhir.model.type.BackboneElement
getModifierExtension
-
-
-
-
Method Detail
-
getLow
public SimpleQuantity getLow()
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 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).- Returns:
- An immutable object of type
SimpleQuantitythat may be null.
-
getHigh
public SimpleQuantity getHigh()
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 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).- Returns:
- An immutable object of type
SimpleQuantitythat may be null.
-
getType
public CodeableConcept getType()
Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getAppliesTo
public List<CodeableConcept> getAppliesTo()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getAge
public Range getAge()
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.- Returns:
- An immutable object of type
Rangethat may be null.
-
getText
public String getText()
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".- Returns:
- An immutable object of type
Stringthat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classBackboneElement
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public Observation.ReferenceRange.Builder toBuilder()
Description copied from class:ElementCreate a new Builder from the contents of this Element- Specified by:
toBuilderin classBackboneElement
-
builder
public static Observation.ReferenceRange.Builder builder()
-
-