Package org.hl7.fhir.r5.model

Class CodeSystem.ConceptDefinitionComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.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

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeType	code	A code - a text symbol - that uniquely identifies the concept within the code system.
protected List<CodeSystem.ConceptDefinitionComponent>	concept	Defines children of a concept to produce a hierarchy of concepts.
protected StringType	definition	The formal definition of the concept.
protected List<CodeSystem.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.
protected List<CodeSystem.ConceptPropertyComponent>	property	A property value for this concept.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ConceptDefinitionComponent()	Constructor
ConceptDefinitionComponent(String code)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeSystem.ConceptDefinitionComponent	addConcept()
CodeSystem.ConceptDefinitionComponent	addConcept(CodeSystem.ConceptDefinitionComponent t)
CodeSystem.ConceptDefinitionDesignationComponent	addDesignation()
CodeSystem.ConceptDefinitionComponent	addDesignation(CodeSystem.ConceptDefinitionDesignationComponent t)
CodeSystem.ConceptPropertyComponent	addProperty()
CodeSystem.ConceptDefinitionComponent	addProperty(CodeSystem.ConceptPropertyComponent t)
CodeSystem.ConceptDefinitionComponent	copy()
void	copyValues(CodeSystem.ConceptDefinitionComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCode()
CodeType	getCodeElement()
List<CodeSystem.ConceptDefinitionComponent>	getConcept()
CodeSystem.ConceptDefinitionComponent	getConceptFirstRep()
String	getDefinition()
StringType	getDefinitionElement()
List<CodeSystem.ConceptDefinitionDesignationComponent>	getDesignation()
CodeSystem.ConceptDefinitionDesignationComponent	getDesignationFirstRep()
String	getDisplay()
StringType	getDisplayElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<CodeSystem.ConceptPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeSystem.ConceptPropertyComponent	getPropertyFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasConcept()
boolean	hasDefinition()
boolean	hasDefinitionElement()
boolean	hasDesignation()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	hasProperty()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
CodeSystem.ConceptDefinitionComponent	setCode(String value)
CodeSystem.ConceptDefinitionComponent	setCodeElement(CodeType value)
CodeSystem.ConceptDefinitionComponent	setConcept(List<CodeSystem.ConceptDefinitionComponent> theConcept)
CodeSystem.ConceptDefinitionComponent	setDefinition(String value)
CodeSystem.ConceptDefinitionComponent	setDefinitionElement(StringType value)
CodeSystem.ConceptDefinitionComponent	setDesignation(List<CodeSystem.ConceptDefinitionDesignationComponent> theDesignation)
CodeSystem.ConceptDefinitionComponent	setDisplay(String value)
CodeSystem.ConceptDefinitionComponent	setDisplayElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CodeSystem.ConceptDefinitionComponent	setProperty(List<CodeSystem.ConceptPropertyComponent> theProperty)
String	toString()

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

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 Details

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 Details

ConceptDefinitionComponent

public ConceptDefinitionComponent()

Constructor

ConceptDefinitionComponent

public ConceptDefinitionComponent(String code)

Constructor

Method Details

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 this for 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 {3}

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 this for 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 {3}

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 this for 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 {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

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 class BackboneElement

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 class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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 CodeSystem.ConceptDefinitionComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(CodeSystem.ConceptDefinitionComponent dst)

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()

Specified by:

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

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)

toString

public String toString()

Overrides:

toString in class Object