Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static class
static class
static enum
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateType
The date on which the asset content was approved by the publisher.protected CodeableConcept
The site on the subject's body where the observation is to be made.protected List
<CodeableConcept> A code that classifies the general type of observation.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected CodeableConcept
Describes what will be observed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeSome observations have multiple component observations, expressed as separate code value pairs.protected List
<ContactDetail> Contact details to assist a user in finding and communicating with the publisher.protected MarkdownType
Copyright statement relating to the ObservationDefinition and/or its contents.protected StringType
A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted.protected DateTimeType
The date (and optionally time) when the ObservationDefinition was last significantly changed.protected List
<CanonicalType> The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.protected MarkdownType
A free text natural language description of the ObservationDefinition from the consumer's perspective.The measurement model of device or actual device used to produce observations of this type.protected Period
The period during which the ObservationDefinition content was or is planned to be effective.protected BooleanType
A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for experimentalThis ObservationDefinition defines a group observation (e.g.protected Identifier
Business identifiers assigned to this ObservationDefinition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierprotected List
<CodeableConcept> A jurisdiction in which the ObservationDefinition is intended to be used.protected DateType
The date on which the asset content was last reviewed.protected CodeableConcept
The method or technique used to perform the observation.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for methodprotected BooleanType
Multiple results allowed for observations conforming to this ObservationDefinition.protected StringType
A natural language name identifying the ObservationDefinition.protected CodeableConcept
The type of individual/organization/device that is expected to act upon instances of this definition.protected List
<Enumeration<ObservationDefinition.ObservationDataType>> The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.Units allowed for the valueQuantity element in 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.protected StringType
Helps establish the "authority/credibility" of the ObservationDefinition.protected MarkdownType
Explains why this ObservationDefinition is needed and why it has been designed as it has.A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.static final String
Search parameter: categorystatic final String
Search parameter: codestatic final String
Search parameter: experimentalstatic final String
Search parameter: identifierstatic final String
Search parameter: methodstatic final String
Search parameter: statusstatic final String
Search parameter: titlestatic final String
Search parameter: urlThe kind of specimen that this type of observation is produced on.protected Enumeration
<Enumerations.PublicationStatus> The current state of the ObservationDefinition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected List
<CodeableConcept> A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.protected StringType
A short, descriptive, user-friendly title for the ObservationDefinition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected UriType
An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlprotected List
<UsageContext> The content was developed with a focus and intent of supporting the contexts that are listed.protected StringType
The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance.protected DataType
Indicates the mechanism used to compare versions to determine which is more current.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.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 TypeMethodDescriptionaddDerivedFromCanonical
(String value) addDerivedFromUri
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getDate()
boolean
boolean
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
hasDerivedFromCanonical
(String value) boolean
boolean
hasDerivedFromUri
(String value) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasUrl()
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) setApprovalDate
(Date value) setApprovalDateElement
(DateType value) setBodySite
(CodeableConcept value) setCategory
(List<CodeableConcept> theCategory) setCode
(CodeableConcept value) setContact
(List<ContactDetail> theContact) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setCopyrightLabel
(String value) setDateElement
(DateTimeType value) setDerivedFromCanonical
(List<CanonicalType> theDerivedFromCanonical) setDerivedFromUri
(List<UriType> theDerivedFromUri) setDescription
(String value) setEffectivePeriod
(Period value) setExperimental
(boolean value) setHasMember
(List<Reference> theHasMember) setIdentifier
(Identifier value) setJurisdiction
(List<CodeableConcept> theJurisdiction) setLastReviewDate
(Date value) setLastReviewDateElement
(DateType value) setMethod
(CodeableConcept value) setMultipleResultsAllowed
(boolean value) setNameElement
(StringType value) setPerformerType
(CodeableConcept value) setPermittedDataType
(List<Enumeration<ObservationDefinition.ObservationDataType>> thePermittedDataType) setPermittedUnit
(List<Coding> thePermittedUnit) setPreferredReportName
(String value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setQualifiedValue
(List<ObservationDefinition.ObservationDefinitionQualifiedValueComponent> theQualifiedValue) setSpecimen
(List<Reference> theSpecimen) setSubject
(List<CodeableConcept> theSubject) setTitleElement
(StringType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionAlgorithm
(DataType value) setVersionElement
(StringType value) protected ObservationDefinition
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
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, 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.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
-
url
An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions. -
identifier
Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. -
version
The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. -
versionAlgorithm
Indicates the mechanism used to compare versions to determine which is more current. -
name
A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation. -
title
A short, descriptive, user-friendly title for the ObservationDefinition. -
status
The current state of the ObservationDefinition. -
experimental
A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. -
date
The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes. -
publisher
Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact. -
contact
Contact details to assist a user in finding and communicating with the publisher. -
description
A free text natural language description of the ObservationDefinition from the consumer's perspective. -
useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances. -
jurisdiction
A jurisdiction in which the ObservationDefinition is intended to be used. -
purpose
Explains why this ObservationDefinition is needed and why it has been designed as it has. -
copyright
Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition. -
copyrightLabel
A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). -
approvalDate
The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage. -
lastReviewDate
The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date. -
effectivePeriod
The period during which the ObservationDefinition content was or is planned to be effective. -
derivedFromCanonical
The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition. -
derivedFromUri
The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition. -
subject
A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition. -
performerType
The type of individual/organization/device that is expected to act upon instances of this definition. -
category
A code that classifies the general type of observation. -
code
Describes what will be observed. Sometimes this is called the observation "name". -
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. -
bodySite
The site on the subject's body where the observation is to be made. -
method
The method or technique used to perform the observation. -
specimen
The kind of specimen that this type of observation is produced on. -
device
The measurement model of device or actual device used to produce observations of this type. -
preferredReportName
The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition. -
permittedUnit
Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition. -
qualifiedValue
A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations. -
hasMember
This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group. -
component
Some observations have multiple component observations, expressed as separate code value pairs. -
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
Type: token
Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): External identifier for the activity definition [ActorDefinition](actordefinition.html): External identifier for the Actor Definition [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition [Citation](citation.html): External identifier for the citation [CodeSystem](codesystem.html): External identifier for the code system [ConceptMap](conceptmap.html): External identifier for the concept map [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition [EventDefinition](eventdefinition.html): External identifier for the event definition [Evidence](evidence.html): External identifier for the evidence [EvidenceReport](evidencereport.html): External identifier for the evidence report [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable [ExampleScenario](examplescenario.html): External identifier for the example scenario [GraphDefinition](graphdefinition.html): External identifier for the graph definition [ImplementationGuide](implementationguide.html): External identifier for the implementation guide [Library](library.html): External identifier for the library [Measure](measure.html): External identifier for the measure [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication [MessageDefinition](messagedefinition.html): External identifier for the message definition [NamingSystem](namingsystem.html): External identifier for the naming system [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition [OperationDefinition](operationdefinition.html): External identifier for the search parameter [PlanDefinition](plandefinition.html): External identifier for the plan definition [Questionnaire](questionnaire.html): External identifier for the questionnaire [Requirements](requirements.html): External identifier for the requirements [SearchParameter](searchparameter.html): External identifier for the search parameter [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition [StructureDefinition](structuredefinition.html): External identifier for the structure definition [StructureMap](structuremap.html): External identifier for the structure map [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities [TestPlan](testplan.html): An identifier for the test plan [TestScript](testscript.html): External identifier for the test script [ValueSet](valueset.html): External identifier for the value set
Type: token
Path: ActivityDefinition.identifier | ActorDefinition.identifier | CapabilityStatement.identifier | ChargeItemDefinition.identifier | Citation.identifier | CodeSystem.identifier | ConceptMap.identifier | ConditionDefinition.identifier | EventDefinition.identifier | Evidence.identifier | EvidenceReport.identifier | EvidenceVariable.identifier | ExampleScenario.identifier | GraphDefinition.identifier | ImplementationGuide.identifier | Library.identifier | Measure.identifier | MedicationKnowledge.identifier | MessageDefinition.identifier | NamingSystem.identifier | ObservationDefinition.identifier | OperationDefinition.identifier | PlanDefinition.identifier | Questionnaire.identifier | Requirements.identifier | SearchParameter.identifier | SpecimenDefinition.identifier | StructureDefinition.identifier | StructureMap.identifier | SubscriptionTopic.identifier | TerminologyCapabilities.identifier | TestPlan.identifier | TestScript.identifier | ValueSet.identifier
-
SP_STATUS
Search parameter: statusDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
Type: token
Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The current status of the activity definition [ActorDefinition](actordefinition.html): The current status of the Actor Definition [CapabilityStatement](capabilitystatement.html): The current status of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition [Citation](citation.html): The current status of the citation [CodeSystem](codesystem.html): The current status of the code system [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition [ConceptMap](conceptmap.html): The current status of the concept map [ConditionDefinition](conditiondefinition.html): The current status of the condition definition [EventDefinition](eventdefinition.html): The current status of the event definition [Evidence](evidence.html): The current status of the evidence [EvidenceReport](evidencereport.html): The current status of the evidence report [EvidenceVariable](evidencevariable.html): The current status of the evidence variable [ExampleScenario](examplescenario.html): The current status of the example scenario [GraphDefinition](graphdefinition.html): The current status of the graph definition [ImplementationGuide](implementationguide.html): The current status of the implementation guide [Library](library.html): The current status of the library [Measure](measure.html): The current status of the measure [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error [MessageDefinition](messagedefinition.html): The current status of the message definition [NamingSystem](namingsystem.html): The current status of the naming system [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown [OperationDefinition](operationdefinition.html): The current status of the operation definition [PlanDefinition](plandefinition.html): The current status of the plan definition [Questionnaire](questionnaire.html): The current status of the questionnaire [Requirements](requirements.html): The current status of the requirements [SearchParameter](searchparameter.html): The current status of the search parameter [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown [StructureDefinition](structuredefinition.html): The current status of the structure definition [StructureMap](structuremap.html): The current status of the structure map [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities [TestPlan](testplan.html): The current status of the test plan [TestScript](testscript.html): The current status of the test script [ValueSet](valueset.html): The current status of the value set
Type: token
Path: ActivityDefinition.status | ActorDefinition.status | CapabilityStatement.status | ChargeItemDefinition.status | Citation.status | CodeSystem.status | CompartmentDefinition.status | ConceptMap.status | ConditionDefinition.status | EventDefinition.status | Evidence.status | EvidenceReport.status | EvidenceVariable.status | ExampleScenario.status | GraphDefinition.status | ImplementationGuide.status | Library.status | Measure.status | MedicationKnowledge.status | MessageDefinition.status | NamingSystem.status | ObservationDefinition.status | OperationDefinition.status | PlanDefinition.status | Questionnaire.status | Requirements.status | SearchParameter.status | SpecimenDefinition.status | StructureDefinition.status | StructureMap.status | SubscriptionTopic.status | TerminologyCapabilities.status | TestPlan.status | TestScript.status | ValueSet.status
-
SP_TITLE
Search parameter: titleDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
Type: string
Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition [Citation](citation.html): The human-friendly name of the citation [CodeSystem](codesystem.html): The human-friendly name of the code system [ConceptMap](conceptmap.html): The human-friendly name of the concept map [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition [EventDefinition](eventdefinition.html): The human-friendly name of the event definition [Evidence](evidence.html): The human-friendly name of the evidence [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide [Library](library.html): The human-friendly name of the library [Measure](measure.html): The human-friendly name of the measure [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire [Requirements](requirements.html): The human-friendly name of the requirements [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition [StructureMap](structuremap.html): The human-friendly name of the structure map [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly) [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities [TestScript](testscript.html): The human-friendly name of the test script [ValueSet](valueset.html): The human-friendly name of the value set
Type: string
Path: ActivityDefinition.title | ActorDefinition.title | CapabilityStatement.title | ChargeItemDefinition.title | Citation.title | CodeSystem.title | ConceptMap.title | ConditionDefinition.title | EventDefinition.title | Evidence.title | EvidenceVariable.title | ImplementationGuide.title | Library.title | Measure.title | MessageDefinition.title | ObservationDefinition.title | OperationDefinition.title | PlanDefinition.title | Questionnaire.title | Requirements.title | SpecimenDefinition.title | StructureDefinition.title | StructureMap.title | SubscriptionTopic.title | TerminologyCapabilities.title | TestScript.title | ValueSet.title
-
SP_URL
Search parameter: urlDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: Multiple Resources: [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition [Citation](citation.html): The uri that identifies the citation [CodeSystem](codesystem.html): The uri that identifies the code system [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition [ConceptMap](conceptmap.html): The URI that identifies the concept map [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition [EventDefinition](eventdefinition.html): The uri that identifies the event definition [Evidence](evidence.html): The uri that identifies the evidence [EvidenceReport](evidencereport.html): The uri that identifies the evidence report [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable [ExampleScenario](examplescenario.html): The uri that identifies the example scenario [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide [Library](library.html): The uri that identifies the library [Measure](measure.html): The uri that identifies the measure [MessageDefinition](messagedefinition.html): The uri that identifies the message definition [NamingSystem](namingsystem.html): The uri that identifies the naming system [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition [PlanDefinition](plandefinition.html): The uri that identifies the plan definition [Questionnaire](questionnaire.html): The uri that identifies the questionnaire [Requirements](requirements.html): The uri that identifies the requirements [SearchParameter](searchparameter.html): The uri that identifies the search parameter [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition [StructureMap](structuremap.html): The uri that identifies the structure map [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique) [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities [TestPlan](testplan.html): The uri that identifies the test plan [TestScript](testscript.html): The uri that identifies the test script [ValueSet](valueset.html): The uri that identifies the value set
Type: uri
Path: ActivityDefinition.url | ActorDefinition.url | CapabilityStatement.url | ChargeItemDefinition.url | Citation.url | CodeSystem.url | CompartmentDefinition.url | ConceptMap.url | ConditionDefinition.url | EventDefinition.url | Evidence.url | EvidenceReport.url | EvidenceVariable.url | ExampleScenario.url | GraphDefinition.url | ImplementationGuide.url | Library.url | Measure.url | MessageDefinition.url | NamingSystem.url | ObservationDefinition.url | OperationDefinition.url | PlanDefinition.url | Questionnaire.url | Requirements.url | SearchParameter.url | SpecimenDefinition.url | StructureDefinition.url | StructureMap.url | SubscriptionTopic.url | TerminologyCapabilities.url | TestPlan.url | TestScript.url | ValueSet.url
-
SP_CATEGORY
Search parameter: categoryDescription: Category (class) of observation
Type: token
Path: ObservationDefinition.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Category (class) of observation
Type: token
Path: ObservationDefinition.category
-
SP_CODE
Search parameter: codeDescription: Observation code
Type: token
Path: ObservationDefinition.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Observation code
Type: token
Path: ObservationDefinition.code
-
SP_EXPERIMENTAL
Search parameter: experimentalDescription: Not for genuine usage (true)
Type: token
Path: ObservationDefinition.experimental
- See Also:
-
EXPERIMENTAL
Fluent Client search parameter constant for experimentalDescription: Not for genuine usage (true)
Type: token
Path: ObservationDefinition.experimental
-
SP_METHOD
Search parameter: methodDescription: Method of observation
Type: token
Path: ObservationDefinition.method
- See Also:
-
METHOD
Fluent Client search parameter constant for methodDescription: Method of observation
Type: token
Path: ObservationDefinition.method
-
-
Constructor Details
-
ObservationDefinition
public ObservationDefinition()Constructor -
ObservationDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Returns:
url
(An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
-
hasUrl
-
setUrlElement
- Parameters:
value
-url
(An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Returns:
- An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.
-
setUrl
- Parameters:
value
- An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.
-
getIdentifier
- Returns:
identifier
(Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
-
hasIdentifier
-
setIdentifier
- Parameters:
value
-identifier
(Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)
-
getVersionElement
- Returns:
version
(The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
-
hasVersion
-
setVersionElement
- Parameters:
value
-version
(The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
- Returns:
- The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
-
setVersion
- Parameters:
value
- The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.
-
getVersionAlgorithm
- Returns:
versionAlgorithm
(Indicates the mechanism used to compare versions to determine which is more current.)
-
getVersionAlgorithmStringType
- Returns:
versionAlgorithm
(Indicates the mechanism used to compare versions to determine which is more current.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersionAlgorithmStringType
-
getVersionAlgorithmCoding
- Returns:
versionAlgorithm
(Indicates the mechanism used to compare versions to determine which is more current.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersionAlgorithmCoding
-
hasVersionAlgorithm
-
setVersionAlgorithm
- Parameters:
value
-versionAlgorithm
(Indicates the mechanism used to compare versions to determine which is more current.)
-
getNameElement
- Returns:
name
(A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-name
(A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
- Parameters:
value
- A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
- Returns:
title
(A short, descriptive, user-friendly title for the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(A short, descriptive, user-friendly title for the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- A short, descriptive, user-friendly title for the ObservationDefinition.
-
setTitle
- Parameters:
value
- A short, descriptive, user-friendly title for the ObservationDefinition.
-
getStatusElement
- Returns:
status
(The current state of the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(The current state of the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- The current state of the ObservationDefinition.
-
setStatus
- Parameters:
value
- The current state of the ObservationDefinition.
-
getExperimentalElement
- Returns:
experimental
(A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
-
hasExperimental
-
setExperimentalElement
- Parameters:
value
-experimental
(A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
- Returns:
- A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
- Parameters:
value
- A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
- Returns:
date
(The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
-
hasDate
-
setDateElement
- Parameters:
value
-date
(The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Returns:
- The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.
-
setDate
- Parameters:
value
- The date (and optionally time) when the ObservationDefinition was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.
-
getPublisherElement
- Returns:
publisher
(Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
-
hasPublisher
-
setPublisherElement
- Parameters:
value
-publisher
(Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
- Returns:
- Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.
-
setPublisher
- Parameters:
value
- Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.
-
getContact
- Returns:
contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist {3}
-
getDescriptionElement
- Returns:
description
(A free text natural language description of the ObservationDefinition from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value
-description
(A free text natural language description of the ObservationDefinition from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A free text natural language description of the ObservationDefinition from the consumer's perspective.
-
setDescription
- Parameters:
value
- A free text natural language description of the ObservationDefinition from the consumer's perspective.
-
getUseContext
- Returns:
useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances.)
-
setUseContext
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
-
addUseContext
-
addUseContext
-
getUseContextFirstRep
- Returns:
- The first repetition of repeating field
useContext
, creating it if it does not already exist {3}
-
getJurisdiction
- Returns:
jurisdiction
(A jurisdiction in which the ObservationDefinition is intended to be used.)
-
setJurisdiction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
-
addJurisdiction
-
addJurisdiction
-
getJurisdictionFirstRep
- Returns:
- The first repetition of repeating field
jurisdiction
, creating it if it does not already exist {3}
-
getPurposeElement
- Returns:
purpose
(Explains why this ObservationDefinition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-purpose
(Explains why this ObservationDefinition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
- Returns:
- Explains why this ObservationDefinition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explains why this ObservationDefinition is needed and why it has been designed as it has.
-
getCopyrightElement
- Returns:
copyright
(Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
-
hasCopyright
-
setCopyrightElement
- Parameters:
value
-copyright
(Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
- Returns:
- Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.
-
setCopyright
- Parameters:
value
- Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.
-
getCopyrightLabelElement
- Returns:
copyrightLabel
(A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').). This is the underlying object with id, value and extensions. The accessor "getCopyrightLabel" gives direct access to the value
-
hasCopyrightLabelElement
-
hasCopyrightLabel
-
setCopyrightLabelElement
- Parameters:
value
-copyrightLabel
(A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').). This is the underlying object with id, value and extensions. The accessor "getCopyrightLabel" gives direct access to the value
-
getCopyrightLabel
- Returns:
- A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
-
setCopyrightLabel
- Parameters:
value
- A short string (invalid input: '<'50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
-
getApprovalDateElement
- Returns:
approvalDate
(The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
-
hasApprovalDate
-
setApprovalDateElement
- Parameters:
value
-approvalDate
(The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
- Returns:
- The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
- Parameters:
value
- The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
- Returns:
lastReviewDate
(The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
-
hasLastReviewDate
-
setLastReviewDateElement
- Parameters:
value
-lastReviewDate
(The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
- Returns:
- The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
-
setLastReviewDate
- Parameters:
value
- The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
-
getEffectivePeriod
- Returns:
effectivePeriod
(The period during which the ObservationDefinition content was or is planned to be effective.)
-
hasEffectivePeriod
-
setEffectivePeriod
- Parameters:
value
-effectivePeriod
(The period during which the ObservationDefinition content was or is planned to be effective.)
-
getDerivedFromCanonical
- Returns:
derivedFromCanonical
(The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.)
-
setDerivedFromCanonical
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDerivedFromCanonical
-
addDerivedFromCanonicalElement
- Returns:
derivedFromCanonical
(The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.)
-
addDerivedFromCanonical
- Parameters:
value
-derivedFromCanonical
(The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.)
-
hasDerivedFromCanonical
- Parameters:
value
-derivedFromCanonical
(The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.)
-
getDerivedFromUri
- Returns:
derivedFromUri
(The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.)
-
setDerivedFromUri
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDerivedFromUri
-
addDerivedFromUriElement
- Returns:
derivedFromUri
(The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.)
-
addDerivedFromUri
- Parameters:
value
-derivedFromUri
(The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.)
-
hasDerivedFromUri
- Parameters:
value
-derivedFromUri
(The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.)
-
getSubject
- Returns:
subject
(A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.)
-
setSubject
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSubject
-
addSubject
-
addSubject
-
getSubjectFirstRep
- Returns:
- The first repetition of repeating field
subject
, creating it if it does not already exist {3}
-
getPerformerType
- Returns:
performerType
(The type of individual/organization/device that is expected to act upon instances of this definition.)
-
hasPerformerType
-
setPerformerType
- Parameters:
value
-performerType
(The type of individual/organization/device that is expected to act upon instances of this definition.)
-
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 {3}
-
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".)
-
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.
-
getBodySite
- Returns:
bodySite
(The site on the subject's body where the observation is to be made.)
-
hasBodySite
-
setBodySite
- Parameters:
value
-bodySite
(The site on the subject's body where the observation is to be made.)
-
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.)
-
getSpecimen
- Returns:
specimen
(The kind of specimen that this type of observation is produced on.)
-
setSpecimen
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecimen
-
addSpecimen
-
addSpecimen
-
getSpecimenFirstRep
- Returns:
- The first repetition of repeating field
specimen
, creating it if it does not already exist {3}
-
getDevice
- Returns:
device
(The measurement model of device or actual device used to produce observations of this type.)
-
setDevice
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDevice
-
addDevice
-
addDevice
-
getDeviceFirstRep
- Returns:
- The first repetition of repeating field
device
, creating it if it does not already exist {3}
-
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.
-
getPermittedUnit
- Returns:
permittedUnit
(Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.)
-
setPermittedUnit
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPermittedUnit
-
addPermittedUnit
-
addPermittedUnit
-
getPermittedUnitFirstRep
- Returns:
- The first repetition of repeating field
permittedUnit
, creating it if it does not already exist {3}
-
getQualifiedValue
- Returns:
qualifiedValue
(A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.)
-
setQualifiedValue
public ObservationDefinition setQualifiedValue(List<ObservationDefinition.ObservationDefinitionQualifiedValueComponent> theQualifiedValue) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasQualifiedValue
-
addQualifiedValue
-
addQualifiedValue
-
getQualifiedValueFirstRep
public ObservationDefinition.ObservationDefinitionQualifiedValueComponent getQualifiedValueFirstRep()- Returns:
- The first repetition of repeating field
qualifiedValue
, creating it if it does not already exist {3}
-
getHasMember
- Returns:
hasMember
(This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.)
-
setHasMember
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasHasMember
-
addHasMember
-
addHasMember
-
getHasMemberFirstRep
- Returns:
- The first repetition of repeating field
hasMember
, creating it if it does not already exist {3}
-
getComponent
- Returns:
component
(Some observations have multiple component observations, expressed as separate code value pairs.)
-
setComponent
public ObservationDefinition setComponent(List<ObservationDefinition.ObservationDefinitionComponentComponent> theComponent) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasComponent
-
addComponent
-
addComponent
-
getComponentFirstRep
- Returns:
- The first repetition of repeating field
component
, creating it if it does not already exist {3}
-
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
- Returns:
- the FHIR type name of the instance (not the java class name)
-
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
-