Package org.hl7.fhir.r5.openehr

Class DV_CODED_TEXT

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.DATA_VALUE

org.hl7.fhir.r5.openehr.DV_TEXT

org.hl7.fhir.r5.openehr.DV_CODED_TEXT

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.ICompositeType

public class DV_CODED_TEXT
extends DV_TEXT
implements org.hl7.fhir.instance.model.api.ICompositeType

A text item whose value must be the rubric from a controlled terminology, the key (i.e. the 'code') of which is the defining_code attribute. In other words: a DV_CODED_TEXT is a combination of a CODE_PHRASE (effectively a code) and the rubric of that term, from a terminology service, in the language in which the data were authored.

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 CODE_PHRASE	defining_code	Displayable rendition of the item, regardless of its underlying structure.

Fields inherited from class org.hl7.fhir.r5.openehr.DV_TEXT

encoding, formatting, hyperlink, language, mappingsList, value

Constructor Summary

Constructors

Constructor	Description
DV_CODED_TEXT()	Constructor
DV_CODED_TEXT(CODE_PHRASE defining_code)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
DV_CODED_TEXT	copy()
void	copyValues(DV_CODED_TEXT dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CODE_PHRASE	getDefining_code()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
boolean	hasDefining_code()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DV_CODED_TEXT	setDefining_code(CODE_PHRASE value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
protected DV_CODED_TEXT	typedCopy()

Methods inherited from class org.hl7.fhir.r5.openehr.DV_TEXT

addMappings, addMappings, copyValues, getEncoding, getFormatting, getFormattingElement, getHyperlink, getLanguage, getMappingsFirstRep, getMappingsList, getValue, getValueElement, hasEncoding, hasFormatting, hasFormattingElement, hasHyperlink, hasLanguage, hasMappings, hasValue, hasValueElement, setEncoding, setFormatting, setFormattingElement, setHyperlink, setLanguage, setMappingsList, setValue, setValueElement

Methods inherited from class org.hl7.fhir.r5.openehr.DATA_VALUE

copyValues

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

getFHIRPublicationVersion, getIdBase, setIdBase

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, executeFunction, 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, removeChild, setCopyUserData, setUserData, setUserDataINN, setXhtml

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

Field Details

defining_code

protected CODE_PHRASE defining_code

Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.

Constructor Details

DV_CODED_TEXT

public DV_CODED_TEXT()

Constructor

DV_CODED_TEXT

public DV_CODED_TEXT(CODE_PHRASE defining_code)

Constructor

Method Details

getDefining_code

public CODE_PHRASE getDefining_code()

Returns:

defining_code (Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.)

hasDefining_code

public boolean hasDefining_code()

setDefining_code

public DV_CODED_TEXT setDefining_code(CODE_PHRASE value)

Parameters:

value - defining_code (Displayable rendition of the item, regardless of its underlying structure. For DV_CODED_TEXT, this is the rubric of the complete term as provided by the terminology service.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DV_TEXT

getNamedProperty

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

Overrides:

getNamedProperty in class DV_TEXT

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 DV_TEXT

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 DV_TEXT

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DV_TEXT

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class DV_TEXT

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class DV_TEXT

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class DV_TEXT

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 DV_TEXT

Returns:

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

copy

public DV_CODED_TEXT copy()

Overrides:

copy in class DV_TEXT

copyValues

public void copyValues(DV_CODED_TEXT dst)

typedCopy

protected DV_CODED_TEXT typedCopy()

Overrides:

typedCopy in class DV_TEXT

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DV_TEXT

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DV_TEXT

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class DV_TEXT