Package org.hl7.fhir.r5.model

Class CodeableConcept

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.CodeableConcept

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class CodeableConcept
extends DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

CodeableConcept Type: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

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 List<Coding>	coding	A reference to a code defined by a terminology system.
protected StringType	text	A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
CodeableConcept()	Constructor
CodeableConcept(Coding code)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Coding	addCoding()
void	addCoding(String system, String code, String display)
CodeableConcept	addCoding(Coding t)
CodeableConcept	copy()
void	copyValues(CodeableConcept dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCode(String system)
List<Coding>	getCoding()
Coding	getCodingFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getText()
StringType	getTextElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCoding()
boolean	hasCoding(String system)
boolean	hasCoding(String system, String code)
boolean	hasCoding(Coding coding)
boolean	hasText()
boolean	hasTextElement()
static CodeableConcept	intersect(CodeableConcept l, CodeableConcept r)
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
boolean	matches(CodeableConcept other)
static CodeableConcept	merge(CodeableConcept l, CodeableConcept r)
void	removeChild(String name, Base value)
void	removeCoding(String system, String version, String code)
CodeableConcept	setCoding(List<Coding> theCoding)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CodeableConcept	setText(String value)
CodeableConcept	setTextElement(StringType value)
String	toString()
protected CodeableConcept	typedCopy()

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

copyValues, getTranslation, isTranslatable

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, 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

Field Details

coding

protected List<Coding> coding

A reference to a code defined by a terminology system.

text

protected StringType text

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Constructor Details

CodeableConcept

public CodeableConcept()

Constructor

CodeableConcept

public CodeableConcept(Coding code)

Method Details

getCoding

public List<Coding> getCoding()

Returns:

coding (A reference to a code defined by a terminology system.)

setCoding

public CodeableConcept setCoding(List<Coding> theCoding)

Returns:

Returns a reference to this for easy method chaining

hasCoding

public boolean hasCoding()

addCoding

public Coding addCoding()

addCoding

public CodeableConcept addCoding(Coding t)

getCodingFirstRep

public Coding getCodingFirstRep()

Returns:

The first repetition of repeating field coding, creating it if it does not already exist {3}

getTextElement

public StringType getTextElement()

Returns:

text (A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

hasTextElement

public boolean hasTextElement()

hasText

public boolean hasText()

setTextElement

public CodeableConcept setTextElement(StringType value)

Parameters:

value - text (A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value

getText

public String getText()

Returns:

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

setText

public CodeableConcept setText(String value)

Parameters:

value - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

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

Overrides:

getNamedProperty in class Element

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 Element

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 Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DataType

Returns:

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

copy

public CodeableConcept copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(CodeableConcept dst)

typedCopy

protected CodeableConcept typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element

hasCoding

public boolean hasCoding(String system,
 String code)

matches

public boolean matches(CodeableConcept other)

hasCoding

public boolean hasCoding(Coding coding)

hasCoding

public boolean hasCoding(String system)

getCode

public String getCode(String system)

merge

public static CodeableConcept merge(CodeableConcept l,
 CodeableConcept r)

intersect

public static CodeableConcept intersect(CodeableConcept l,
 CodeableConcept r)

addCoding

public void addCoding(String system,
 String code,
 String display)

toString

public String toString()

Overrides:

toString in class Object

removeCoding

public void removeCoding(String system,
 String version,
 String code)