Package com.ibm.fhir.model.resource
Class ObservationDefinition
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.ObservationDefinition
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class ObservationDefinition extends DomainResource
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.Maturity level: FMM0 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classObservationDefinition.Builderstatic classObservationDefinition.QualifiedIntervalMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.static classObservationDefinition.QuantitativeDetailsCharacteristics for quantitative results of this observation.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
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 ObservationDefinition.Builderbuilder()booleanequals(Object obj)ReferencegetAbnormalCodedValueSet()The set of abnormal coded results for the observation conforming to this ObservationDefinition.List<CodeableConcept>getCategory()A code that classifies the general type of observation.CodeableConceptgetCode()Describes what will be observed.ReferencegetCriticalCodedValueSet()The set of critical coded results for the observation conforming to this ObservationDefinition.List<Identifier>getIdentifier()A unique identifier assigned to this ObservationDefinition artifact.CodeableConceptgetMethod()The method or technique used to perform the observation.BooleangetMultipleResultsAllowed()Multiple results allowed for observations conforming to this ObservationDefinition.ReferencegetNormalCodedValueSet()The set of normal coded results for the observations conforming to this ObservationDefinition.List<ObservationDataType>getPermittedDataType()The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.StringgetPreferredReportName()The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.List<ObservationDefinition.QualifiedInterval>getQualifiedInterval()Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.ObservationDefinition.QuantitativeDetailsgetQuantitativeDetails()Characteristics for quantitative results of this observation.ReferencegetValidCodedValueSet()The set of valid coded results for the observations conforming to this ObservationDefinition.booleanhasChildren()inthashCode()ObservationDefinition.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getCategory
public List<CodeableConcept> getCategory()
A code that classifies the general type of observation.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getCode
public CodeableConcept getCode()
Describes what will be observed. Sometimes this is called the observation "name".- Returns:
- An immutable object of type
CodeableConceptthat is non-null.
-
getIdentifier
public List<Identifier> getIdentifier()
A unique identifier assigned to this ObservationDefinition artifact.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getPermittedDataType
public List<ObservationDataType> getPermittedDataType()
The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.- Returns:
- An unmodifiable list containing immutable objects of type
ObservationDataTypethat may be empty.
-
getMultipleResultsAllowed
public Boolean getMultipleResultsAllowed()
Multiple results allowed for observations conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Booleanthat may be null.
-
getMethod
public CodeableConcept getMethod()
The method or technique used to perform the observation.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getPreferredReportName
public String getPreferredReportName()
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Stringthat may be null.
-
getQuantitativeDetails
public ObservationDefinition.QuantitativeDetails getQuantitativeDetails()
Characteristics for quantitative results of this observation.- Returns:
- An immutable object of type
ObservationDefinition.QuantitativeDetailsthat may be null.
-
getQualifiedInterval
public List<ObservationDefinition.QualifiedInterval> getQualifiedInterval()
Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.- Returns:
- An unmodifiable list containing immutable objects of type
ObservationDefinition.QualifiedIntervalthat may be empty.
-
getValidCodedValueSet
public Reference getValidCodedValueSet()
The set of valid coded results for the observations conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Referencethat may be null.
-
getNormalCodedValueSet
public Reference getNormalCodedValueSet()
The set of normal coded results for the observations conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Referencethat may be null.
-
getAbnormalCodedValueSet
public Reference getAbnormalCodedValueSet()
The set of abnormal coded results for the observation conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Referencethat may be null.
-
getCriticalCodedValueSet
public Reference getCriticalCodedValueSet()
The set of critical coded results for the observation conforming to this ObservationDefinition.- Returns:
- An immutable object of type
Referencethat may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
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 ObservationDefinition.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static ObservationDefinition.Builder builder()
-
-