org.hl7.fhir.instance.model

Class ValueSet.ConceptDefinitionComponent

java.lang.Object

org.hl7.fhir.instance.model.Base

org.hl7.fhir.instance.model.Element

org.hl7.fhir.instance.model.BackboneElement

org.hl7.fhir.instance.model.ValueSet.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.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

ValueSet

public static class ValueSet.ConceptDefinitionComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanType	abstract_ If this code is not for use as a real concept.
protected CodeType	code A code - a text symbol - that uniquely identifies the concept within the code system.
protected List<ValueSet.ConceptDefinitionComponent>	concept Defines children of a concept to produce a hierarchy of concepts.
protected StringType	definition The formal definition of the concept.
protected List<ValueSet.ConceptDefinitionDesignationComponent>	designation Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
protected StringType	display A human readable string that is the recommended default way to present this concept to a user.

Fields inherited from class org.hl7.fhir.instance.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.instance.model.Element

extension, id

Constructor Summary

Constructors

Constructor and Description
ConceptDefinitionComponent()
ConceptDefinitionComponent(CodeType code)

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
ValueSet.ConceptDefinitionComponent	addConcept()
ValueSet.ConceptDefinitionComponent	addConcept(ValueSet.ConceptDefinitionComponent t)
ValueSet.ConceptDefinitionDesignationComponent	addDesignation()
ValueSet.ConceptDefinitionComponent	addDesignation(ValueSet.ConceptDefinitionDesignationComponent t)
ValueSet.ConceptDefinitionComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
boolean	getAbstract()
BooleanType	getAbstractElement()
String	getCode()
CodeType	getCodeElement()
List<ValueSet.ConceptDefinitionComponent>	getConcept()
String	getDefinition()
StringType	getDefinitionElement()
List<ValueSet.ConceptDefinitionDesignationComponent>	getDesignation()
String	getDisplay()
StringType	getDisplayElement()
boolean	hasAbstract()
boolean	hasAbstractElement()
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasConcept()
boolean	hasDefinition()
boolean	hasDefinitionElement()
boolean	hasDesignation()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
ValueSet.ConceptDefinitionComponent	setAbstract(boolean value)
ValueSet.ConceptDefinitionComponent	setAbstractElement(BooleanType value)
ValueSet.ConceptDefinitionComponent	setCode(String value)
ValueSet.ConceptDefinitionComponent	setCodeElement(CodeType value)
ValueSet.ConceptDefinitionComponent	setDefinition(String value)
ValueSet.ConceptDefinitionComponent	setDefinitionElement(StringType value)
ValueSet.ConceptDefinitionComponent	setDisplay(String value)
ValueSet.ConceptDefinitionComponent	setDisplayElement(StringType value)
void	setProperty(String name, Base value)

Methods inherited from class org.hl7.fhir.instance.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.instance.model.Element

addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.instance.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension, getModifierExtension, hasModifierExtension

Field Detail

code

protected CodeType code

A code - a text symbol - that uniquely identifies the concept within the code system.

abstract_

protected BooleanType abstract_

If this code is not for use as a real concept.

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 value set 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<ValueSet.ConceptDefinitionDesignationComponent> designation

Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.

concept

protected List<ValueSet.ConceptDefinitionComponent> concept

Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts.

Constructor Detail

ConceptDefinitionComponent

public ConceptDefinitionComponent()

ConceptDefinitionComponent

public ConceptDefinitionComponent(CodeType code)

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 ValueSet.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 ValueSet.ConceptDefinitionComponent setCode(String value)

Parameters:

value - A code - a text symbol - that uniquely identifies the concept within the code system.

getAbstractElement

public BooleanType getAbstractElement()

Returns:

abstract_ (If this code is not for use as a real concept.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

hasAbstractElement

public boolean hasAbstractElement()

hasAbstract

public boolean hasAbstract()

setAbstractElement

public ValueSet.ConceptDefinitionComponent setAbstractElement(BooleanType value)

Parameters:

value - abstract_ (If this code is not for use as a real concept.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

getAbstract

public boolean getAbstract()

Returns:

If this code is not for use as a real concept.

setAbstract

public ValueSet.ConceptDefinitionComponent setAbstract(boolean value)

Parameters:

value - If this code is not for use as a real concept.

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 ValueSet.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 ValueSet.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 value set 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 ValueSet.ConceptDefinitionComponent setDefinitionElement(StringType value)

Parameters:

value - definition (The formal definition of the concept. The value set 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 value set 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 ValueSet.ConceptDefinitionComponent setDefinition(String value)

Parameters:

value - The formal definition of the concept. The value set 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<ValueSet.ConceptDefinitionDesignationComponent> getDesignation()

Returns:

designation (Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.)

hasDesignation

public boolean hasDesignation()

addDesignation

public ValueSet.ConceptDefinitionDesignationComponent addDesignation()

Returns:

designation (Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.)

addDesignation

public ValueSet.ConceptDefinitionComponent addDesignation(ValueSet.ConceptDefinitionDesignationComponent t)

getConcept

public List<ValueSet.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) and can only be determined by examining the definitions of the concepts.)

hasConcept

public boolean hasConcept()

addConcept

public ValueSet.ConceptDefinitionComponent addConcept()

Returns:

concept (Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts.)

addConcept

public ValueSet.ConceptDefinitionComponent addConcept(ValueSet.ConceptDefinitionComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ValueSet.ConceptDefinitionComponent copy()

Specified by:

copy in class BackboneElement

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Overrides:

fhirType in class BackboneElement