Package org.hl7.fhir.r4.model
Class ObservationDefinition
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.ObservationDefinition
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classObservationDefinition.ObservationDataTypestatic classObservationDefinition.ObservationDataTypeEnumFactorystatic classObservationDefinition.ObservationDefinitionQualifiedIntervalComponentstatic classObservationDefinition.ObservationDefinitionQuantitativeDetailsComponentstatic classObservationDefinition.ObservationRangeCategorystatic classObservationDefinition.ObservationRangeCategoryEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceabnormalCodedValueSetThe set of abnormal coded results for the observation conforming to this ObservationDefinition.protected ValueSetabnormalCodedValueSetTargetThe actual object that is the target of the reference (The set of abnormal coded results for the observation conforming to this ObservationDefinition.)protected List<CodeableConcept>categoryA code that classifies the general type of observation.protected CodeableConceptcodeDescribes what will be observed.protected ReferencecriticalCodedValueSetThe set of critical coded results for the observation conforming to this ObservationDefinition.protected ValueSetcriticalCodedValueSetTargetThe actual object that is the target of the reference (The set of critical coded results for the observation conforming to this ObservationDefinition.)protected List<Identifier>identifierA unique identifier assigned to this ObservationDefinition artifact.protected CodeableConceptmethodThe method or technique used to perform the observation.protected BooleanTypemultipleResultsAllowedMultiple results allowed for observations conforming to this ObservationDefinition.protected ReferencenormalCodedValueSetThe set of normal coded results for the observations conforming to this ObservationDefinition.protected ValueSetnormalCodedValueSetTargetThe actual object that is the target of the reference (The set of normal coded results for the observations conforming to this ObservationDefinition.)protected List<Enumeration<ObservationDefinition.ObservationDataType>>permittedDataTypeThe data types allowed for the value element of the instance observations conforming to this ObservationDefinition.protected StringTypepreferredReportNameThe preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.protected List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent>qualifiedIntervalMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.protected ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponentquantitativeDetailsCharacteristics for quantitative results of this observation.protected ReferencevalidCodedValueSetThe set of valid coded results for the observations conforming to this ObservationDefinition.protected ValueSetvalidCodedValueSetTargetThe actual object that is the target of the reference (The set of valid coded results for the observations conforming to this ObservationDefinition.)-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ObservationDefinition()ConstructorObservationDefinition(CodeableConcept code)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, 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.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
category
protected List<CodeableConcept> category
A code that classifies the general type of observation.
-
code
protected CodeableConcept code
Describes what will be observed. Sometimes this is called the observation "name".
-
identifier
protected List<Identifier> identifier
A unique identifier assigned to this ObservationDefinition artifact.
-
permittedDataType
protected List<Enumeration<ObservationDefinition.ObservationDataType>> permittedDataType
The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.
-
multipleResultsAllowed
protected BooleanType multipleResultsAllowed
Multiple results allowed for observations conforming to this ObservationDefinition.
-
method
protected CodeableConcept method
The method or technique used to perform the observation.
-
preferredReportName
protected StringType preferredReportName
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
-
quantitativeDetails
protected ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent quantitativeDetails
Characteristics for quantitative results of this observation.
-
qualifiedInterval
protected List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> qualifiedInterval
Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.
-
validCodedValueSet
protected Reference validCodedValueSet
The set of valid coded results for the observations conforming to this ObservationDefinition.
-
validCodedValueSetTarget
protected ValueSet validCodedValueSetTarget
The actual object that is the target of the reference (The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
normalCodedValueSet
protected Reference normalCodedValueSet
The set of normal coded results for the observations conforming to this ObservationDefinition.
-
normalCodedValueSetTarget
protected ValueSet normalCodedValueSetTarget
The actual object that is the target of the reference (The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
abnormalCodedValueSet
protected Reference abnormalCodedValueSet
The set of abnormal coded results for the observation conforming to this ObservationDefinition.
-
abnormalCodedValueSetTarget
protected ValueSet abnormalCodedValueSetTarget
The actual object that is the target of the reference (The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
criticalCodedValueSet
protected Reference criticalCodedValueSet
The set of critical coded results for the observation conforming to this ObservationDefinition.
-
criticalCodedValueSetTarget
protected ValueSet criticalCodedValueSetTarget
The actual object that is the target of the reference (The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
-
Constructor Detail
-
ObservationDefinition
public ObservationDefinition()
Constructor
-
ObservationDefinition
public ObservationDefinition(CodeableConcept code)
Constructor
-
-
Method Detail
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(A code that classifies the general type of observation.)
-
setCategory
public ObservationDefinition setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public ObservationDefinition addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist
-
getCode
public CodeableConcept getCode()
- Returns:
code(Describes what will be observed. Sometimes this is called the observation "name".)
-
hasCode
public boolean hasCode()
-
setCode
public ObservationDefinition setCode(CodeableConcept value)
- Parameters:
value-code(Describes what will be observed. Sometimes this is called the observation "name".)
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A unique identifier assigned to this ObservationDefinition artifact.)
-
setIdentifier
public ObservationDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ObservationDefinition addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getPermittedDataType
public List<Enumeration<ObservationDefinition.ObservationDataType>> getPermittedDataType()
- Returns:
permittedDataType(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
setPermittedDataType
public ObservationDefinition setPermittedDataType(List<Enumeration<ObservationDefinition.ObservationDataType>> thePermittedDataType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPermittedDataType
public boolean hasPermittedDataType()
-
addPermittedDataTypeElement
public Enumeration<ObservationDefinition.ObservationDataType> addPermittedDataTypeElement()
- Returns:
permittedDataType(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
addPermittedDataType
public ObservationDefinition addPermittedDataType(ObservationDefinition.ObservationDataType value)
- Parameters:
value-permittedDataType(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
hasPermittedDataType
public boolean hasPermittedDataType(ObservationDefinition.ObservationDataType value)
- Parameters:
value-permittedDataType(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
getMultipleResultsAllowedElement
public BooleanType getMultipleResultsAllowedElement()
- Returns:
multipleResultsAllowed(Multiple results allowed for observations conforming to this ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getMultipleResultsAllowed" gives direct access to the value
-
hasMultipleResultsAllowedElement
public boolean hasMultipleResultsAllowedElement()
-
hasMultipleResultsAllowed
public boolean hasMultipleResultsAllowed()
-
setMultipleResultsAllowedElement
public ObservationDefinition setMultipleResultsAllowedElement(BooleanType value)
- Parameters:
value-multipleResultsAllowed(Multiple results allowed for observations conforming to this ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getMultipleResultsAllowed" gives direct access to the value
-
getMultipleResultsAllowed
public boolean getMultipleResultsAllowed()
- Returns:
- Multiple results allowed for observations conforming to this ObservationDefinition.
-
setMultipleResultsAllowed
public ObservationDefinition setMultipleResultsAllowed(boolean value)
- Parameters:
value- Multiple results allowed for observations conforming to this ObservationDefinition.
-
getMethod
public CodeableConcept getMethod()
- Returns:
method(The method or technique used to perform the observation.)
-
hasMethod
public boolean hasMethod()
-
setMethod
public ObservationDefinition setMethod(CodeableConcept value)
- Parameters:
value-method(The method or technique used to perform the observation.)
-
getPreferredReportNameElement
public StringType getPreferredReportNameElement()
- Returns:
preferredReportName(The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getPreferredReportName" gives direct access to the value
-
hasPreferredReportNameElement
public boolean hasPreferredReportNameElement()
-
hasPreferredReportName
public boolean hasPreferredReportName()
-
setPreferredReportNameElement
public ObservationDefinition setPreferredReportNameElement(StringType value)
- Parameters:
value-preferredReportName(The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getPreferredReportName" gives direct access to the value
-
getPreferredReportName
public String getPreferredReportName()
- Returns:
- The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
-
setPreferredReportName
public ObservationDefinition setPreferredReportName(String value)
- Parameters:
value- The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
-
getQuantitativeDetails
public ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent getQuantitativeDetails()
- Returns:
quantitativeDetails(Characteristics for quantitative results of this observation.)
-
hasQuantitativeDetails
public boolean hasQuantitativeDetails()
-
setQuantitativeDetails
public ObservationDefinition setQuantitativeDetails(ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent value)
- Parameters:
value-quantitativeDetails(Characteristics for quantitative results of this observation.)
-
getQualifiedInterval
public List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> getQualifiedInterval()
- Returns:
qualifiedInterval(Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.)
-
setQualifiedInterval
public ObservationDefinition setQualifiedInterval(List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> theQualifiedInterval)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasQualifiedInterval
public boolean hasQualifiedInterval()
-
addQualifiedInterval
public ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent addQualifiedInterval()
-
addQualifiedInterval
public ObservationDefinition addQualifiedInterval(ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent t)
-
getQualifiedIntervalFirstRep
public ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent getQualifiedIntervalFirstRep()
- Returns:
- The first repetition of repeating field
qualifiedInterval, creating it if it does not already exist
-
getValidCodedValueSet
public Reference getValidCodedValueSet()
- Returns:
validCodedValueSet(The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
hasValidCodedValueSet
public boolean hasValidCodedValueSet()
-
setValidCodedValueSet
public ObservationDefinition setValidCodedValueSet(Reference value)
- Parameters:
value-validCodedValueSet(The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
getValidCodedValueSetTarget
public ValueSet getValidCodedValueSetTarget()
- Returns:
validCodedValueSetThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
setValidCodedValueSetTarget
public ObservationDefinition setValidCodedValueSetTarget(ValueSet value)
- Parameters:
value-validCodedValueSetThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
getNormalCodedValueSet
public Reference getNormalCodedValueSet()
- Returns:
normalCodedValueSet(The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
hasNormalCodedValueSet
public boolean hasNormalCodedValueSet()
-
setNormalCodedValueSet
public ObservationDefinition setNormalCodedValueSet(Reference value)
- Parameters:
value-normalCodedValueSet(The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
getNormalCodedValueSetTarget
public ValueSet getNormalCodedValueSetTarget()
- Returns:
normalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
setNormalCodedValueSetTarget
public ObservationDefinition setNormalCodedValueSetTarget(ValueSet value)
- Parameters:
value-normalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
getAbnormalCodedValueSet
public Reference getAbnormalCodedValueSet()
- Returns:
abnormalCodedValueSet(The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
hasAbnormalCodedValueSet
public boolean hasAbnormalCodedValueSet()
-
setAbnormalCodedValueSet
public ObservationDefinition setAbnormalCodedValueSet(Reference value)
- Parameters:
value-abnormalCodedValueSet(The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
getAbnormalCodedValueSetTarget
public ValueSet getAbnormalCodedValueSetTarget()
- Returns:
abnormalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
setAbnormalCodedValueSetTarget
public ObservationDefinition setAbnormalCodedValueSetTarget(ValueSet value)
- Parameters:
value-abnormalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
getCriticalCodedValueSet
public Reference getCriticalCodedValueSet()
- Returns:
criticalCodedValueSet(The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
hasCriticalCodedValueSet
public boolean hasCriticalCodedValueSet()
-
setCriticalCodedValueSet
public ObservationDefinition setCriticalCodedValueSet(Reference value)
- Parameters:
value-criticalCodedValueSet(The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
getCriticalCodedValueSetTarget
public ValueSet getCriticalCodedValueSetTarget()
- Returns:
criticalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
setCriticalCodedValueSetTarget
public ObservationDefinition setCriticalCodedValueSetTarget(ValueSet value)
- Parameters:
value-criticalCodedValueSetThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ObservationDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ObservationDefinition dst)
-
typedCopy
protected ObservationDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-