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
Set of definitional characteristics for a kind of observation or measurement
produced or consumed by an orderable health care service.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Reference
The set of abnormal coded results for the observation conforming to this ObservationDefinition.protected ValueSet
The 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> A code that classifies the general type of observation.protected CodeableConcept
Describes what will be observed.protected Reference
The set of critical coded results for the observation conforming to this ObservationDefinition.protected ValueSet
The 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> A unique identifier assigned to this ObservationDefinition artifact.protected CodeableConcept
The method or technique used to perform the observation.protected BooleanType
Multiple results allowed for observations conforming to this ObservationDefinition.protected Reference
The set of normal coded results for the observations conforming to this ObservationDefinition.protected ValueSet
The 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>> The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.protected StringType
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.Multiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition.Characteristics for quantitative results of this observation.protected Reference
The set of valid coded results for the observations conforming to this ObservationDefinition.protected ValueSet
The 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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptioncopy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
boolean
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCategory
(List<CodeableConcept> theCategory) setCode
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setMethod
(CodeableConcept value) setMultipleResultsAllowed
(boolean value) setNormalCodedValueSet
(Reference value) setPermittedDataType
(List<Enumeration<ObservationDefinition.ObservationDataType>> thePermittedDataType) setPreferredReportName
(String value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQualifiedInterval
(List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> theQualifiedInterval) setQuantitativeDetails
(ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent value) setValidCodedValueSet
(Reference value) protected ObservationDefinition
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
category
A code that classifies the general type of observation. -
code
Describes what will be observed. Sometimes this is called the observation "name". -
identifier
A unique identifier assigned to this ObservationDefinition artifact. -
permittedDataType
The data types allowed for the value element of the instance observations conforming to this ObservationDefinition. -
multipleResultsAllowed
Multiple results allowed for observations conforming to this ObservationDefinition. -
method
The method or technique used to perform the observation. -
preferredReportName
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. -
quantitativeDetails
protected ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent quantitativeDetailsCharacteristics for quantitative results of this observation. -
qualifiedInterval
protected List<ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent> qualifiedIntervalMultiple ranges of results qualified by different contexts for ordinal or continuous observations conforming to this ObservationDefinition. -
validCodedValueSet
The set of valid coded results for the observations conforming to this ObservationDefinition. -
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
The set of normal coded results for the observations conforming to this ObservationDefinition. -
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
The set of abnormal coded results for the observation conforming to this ObservationDefinition. -
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
The set of critical coded results for the observation conforming to this ObservationDefinition. -
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 Details
-
ObservationDefinition
public ObservationDefinition()Constructor -
ObservationDefinition
Constructor
-
-
Method Details
-
getCategory
- Returns:
category
(A code that classifies the general type of observation.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
getCode
- Returns:
code
(Describes what will be observed. Sometimes this is called the observation "name".)
-
hasCode
-
setCode
- Parameters:
value
-code
(Describes what will be observed. Sometimes this is called the observation "name".)
-
getIdentifier
- Returns:
identifier
(A unique identifier assigned to this ObservationDefinition artifact.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
this
for easy method chaining
-
hasPermittedDataType
-
addPermittedDataTypeElement
- Returns:
permittedDataType
(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
addPermittedDataType
- Parameters:
value
-permittedDataType
(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
hasPermittedDataType
- Parameters:
value
-permittedDataType
(The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.)
-
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
-
hasMultipleResultsAllowed
-
setMultipleResultsAllowedElement
- 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
- Returns:
- Multiple results allowed for observations conforming to this ObservationDefinition.
-
setMultipleResultsAllowed
- Parameters:
value
- Multiple results allowed for observations conforming to this ObservationDefinition.
-
getMethod
- Returns:
method
(The method or technique used to perform the observation.)
-
hasMethod
-
setMethod
- Parameters:
value
-method
(The method or technique used to perform the observation.)
-
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
-
hasPreferredReportName
-
setPreferredReportNameElement
- 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
- Returns:
- The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.
-
setPreferredReportName
- 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
-
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
this
for easy method chaining
-
hasQualifiedInterval
-
addQualifiedInterval
-
addQualifiedInterval
-
getQualifiedIntervalFirstRep
public ObservationDefinition.ObservationDefinitionQualifiedIntervalComponent getQualifiedIntervalFirstRep()- Returns:
- The first repetition of repeating field
qualifiedInterval
, creating it if it does not already exist
-
getValidCodedValueSet
- Returns:
validCodedValueSet
(The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
hasValidCodedValueSet
-
setValidCodedValueSet
- Parameters:
value
-validCodedValueSet
(The set of valid coded results for the observations conforming to this ObservationDefinition.)
-
getValidCodedValueSetTarget
- Returns:
validCodedValueSet
The 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
- Parameters:
value
-validCodedValueSet
The 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
- Returns:
normalCodedValueSet
(The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
hasNormalCodedValueSet
-
setNormalCodedValueSet
- Parameters:
value
-normalCodedValueSet
(The set of normal coded results for the observations conforming to this ObservationDefinition.)
-
getNormalCodedValueSetTarget
- Returns:
normalCodedValueSet
The 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
- Parameters:
value
-normalCodedValueSet
The 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
- Returns:
abnormalCodedValueSet
(The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
hasAbnormalCodedValueSet
-
setAbnormalCodedValueSet
- Parameters:
value
-abnormalCodedValueSet
(The set of abnormal coded results for the observation conforming to this ObservationDefinition.)
-
getAbnormalCodedValueSetTarget
- Returns:
abnormalCodedValueSet
The 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
- Parameters:
value
-abnormalCodedValueSet
The 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
- Returns:
criticalCodedValueSet
(The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
hasCriticalCodedValueSet
-
setCriticalCodedValueSet
- Parameters:
value
-criticalCodedValueSet
(The set of critical coded results for the observation conforming to this ObservationDefinition.)
-
getCriticalCodedValueSetTarget
- Returns:
criticalCodedValueSet
The 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
- Parameters:
value
-criticalCodedValueSet
The 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
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-