Package org.hl7.fhir.r4.model
Class CodeSystem.ConceptDefinitionComponent
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.Element
-
- org.hl7.fhir.r4.model.BackboneElement
-
- org.hl7.fhir.r4.model.CodeSystem.ConceptDefinitionComponent
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseBackboneElement,org.hl7.fhir.instance.model.api.IBaseElement,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
- CodeSystem
public static class CodeSystem.ConceptDefinitionComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected CodeTypecodeA code - a text symbol - that uniquely identifies the concept within the code system.protected List<CodeSystem.ConceptDefinitionComponent>conceptDefines children of a concept to produce a hierarchy of concepts.protected StringTypedefinitionThe formal definition of the concept.protected List<CodeSystem.ConceptDefinitionDesignationComponent>designationAdditional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.protected StringTypedisplayA human readable string that is the recommended default way to present this concept to a user.protected List<CodeSystem.ConceptPropertyComponent>propertyA property value for this concept.-
Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension
-
-
Constructor Summary
Constructors Constructor Description ConceptDefinitionComponent()ConstructorConceptDefinitionComponent(CodeType code)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension
-
Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
-
-
-
-
Field Detail
-
code
protected CodeType code
A code - a text symbol - that uniquely identifies the concept within the code system.
-
display
protected StringType display
A human readable string that is the recommended default way to present this concept to a user.
-
definition
protected StringType definition
The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
-
designation
protected List<CodeSystem.ConceptDefinitionDesignationComponent> designation
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
-
property
protected List<CodeSystem.ConceptPropertyComponent> property
A property value for this concept.
-
concept
protected List<CodeSystem.ConceptDefinitionComponent> concept
Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
-
-
Constructor Detail
-
ConceptDefinitionComponent
public ConceptDefinitionComponent()
Constructor
-
ConceptDefinitionComponent
public ConceptDefinitionComponent(CodeType code)
Constructor
-
-
Method Detail
-
getCodeElement
public CodeType getCodeElement()
- Returns:
code(A code - a text symbol - that uniquely identifies the concept within the code system.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
hasCodeElement
public boolean hasCodeElement()
-
hasCode
public boolean hasCode()
-
setCodeElement
public CodeSystem.ConceptDefinitionComponent setCodeElement(CodeType value)
- Parameters:
value-code(A code - a text symbol - that uniquely identifies the concept within the code system.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
-
getCode
public String getCode()
- Returns:
- A code - a text symbol - that uniquely identifies the concept within the code system.
-
setCode
public CodeSystem.ConceptDefinitionComponent setCode(String value)
- Parameters:
value- A code - a text symbol - that uniquely identifies the concept within the code system.
-
getDisplayElement
public StringType getDisplayElement()
- Returns:
display(A human readable string that is the recommended default way to present this concept to a user.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
-
hasDisplayElement
public boolean hasDisplayElement()
-
hasDisplay
public boolean hasDisplay()
-
setDisplayElement
public CodeSystem.ConceptDefinitionComponent setDisplayElement(StringType value)
- Parameters:
value-display(A human readable string that is the recommended default way to present this concept to a user.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value
-
getDisplay
public String getDisplay()
- Returns:
- A human readable string that is the recommended default way to present this concept to a user.
-
setDisplay
public CodeSystem.ConceptDefinitionComponent setDisplay(String value)
- Parameters:
value- A human readable string that is the recommended default way to present this concept to a user.
-
getDefinitionElement
public StringType getDefinitionElement()
- Returns:
definition(The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value
-
hasDefinitionElement
public boolean hasDefinitionElement()
-
hasDefinition
public boolean hasDefinition()
-
setDefinitionElement
public CodeSystem.ConceptDefinitionComponent setDefinitionElement(StringType value)
- Parameters:
value-definition(The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.). This is the underlying object with id, value and extensions. The accessor "getDefinition" gives direct access to the value
-
getDefinition
public String getDefinition()
- Returns:
- The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
-
setDefinition
public CodeSystem.ConceptDefinitionComponent setDefinition(String value)
- Parameters:
value- The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
-
getDesignation
public List<CodeSystem.ConceptDefinitionDesignationComponent> getDesignation()
- Returns:
designation(Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.)
-
setDesignation
public CodeSystem.ConceptDefinitionComponent setDesignation(List<CodeSystem.ConceptDefinitionDesignationComponent> theDesignation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDesignation
public boolean hasDesignation()
-
addDesignation
public CodeSystem.ConceptDefinitionDesignationComponent addDesignation()
-
addDesignation
public CodeSystem.ConceptDefinitionComponent addDesignation(CodeSystem.ConceptDefinitionDesignationComponent t)
-
getDesignationFirstRep
public CodeSystem.ConceptDefinitionDesignationComponent getDesignationFirstRep()
- Returns:
- The first repetition of repeating field
designation, creating it if it does not already exist
-
getProperty
public List<CodeSystem.ConceptPropertyComponent> getProperty()
- Returns:
property(A property value for this concept.)
-
setProperty
public CodeSystem.ConceptDefinitionComponent setProperty(List<CodeSystem.ConceptPropertyComponent> theProperty)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProperty
public boolean hasProperty()
-
addProperty
public CodeSystem.ConceptPropertyComponent addProperty()
-
addProperty
public CodeSystem.ConceptDefinitionComponent addProperty(CodeSystem.ConceptPropertyComponent t)
-
getPropertyFirstRep
public CodeSystem.ConceptPropertyComponent getPropertyFirstRep()
- Returns:
- The first repetition of repeating field
property, creating it if it does not already exist
-
getConcept
public List<CodeSystem.ConceptDefinitionComponent> getConcept()
- Returns:
concept(Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.)
-
setConcept
public CodeSystem.ConceptDefinitionComponent setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasConcept
public boolean hasConcept()
-
addConcept
public CodeSystem.ConceptDefinitionComponent addConcept()
-
addConcept
public CodeSystem.ConceptDefinitionComponent addConcept(CodeSystem.ConceptDefinitionComponent t)
-
getConceptFirstRep
public CodeSystem.ConceptDefinitionComponent getConceptFirstRep()
- Returns:
- The first repetition of repeating field
concept, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classBackboneElement- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
public CodeSystem.ConceptDefinitionComponent copy()
- Specified by:
copyin classBackboneElement
-
copyValues
public void copyValues(CodeSystem.ConceptDefinitionComponent dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classBackboneElement
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classBackboneElement
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classBackboneElement
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classBackboneElement
-
-