Package org.hl7.fhir.r5.openehr

Class CODE_PHRASE

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.CODE_PHRASE

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 CODE_PHRASE
extends LogicalBase
implements org.hl7.fhir.instance.model.api.ICompositeType

A fully coordinated (i.e. all coordination has been performed) term from a terminology service (as distinct from a particular terminology).

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 StringType	code_string	The key used by the terminology service to identify a concept or coordination of concepts.
protected StringType	preferred_term	Optional attribute to carry preferred term corresponding to the code or expression in code_string.
protected TERMINOLOGY_ID	terminology_id	Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

Constructor Summary

Constructors

Constructor	Description
CODE_PHRASE()	Constructor
CODE_PHRASE(TERMINOLOGY_ID terminology_id, String code_string)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CODE_PHRASE	copy()
void	copyValues(CODE_PHRASE dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCode_string()
StringType	getCode_stringElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getPreferred_term()
StringType	getPreferred_termElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
TERMINOLOGY_ID	getTerminology_id()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCode_string()
boolean	hasCode_stringElement()
boolean	hasPreferred_term()
boolean	hasPreferred_termElement()
boolean	hasTerminology_id()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
CODE_PHRASE	setCode_string(String value)
CODE_PHRASE	setCode_stringElement(StringType value)
CODE_PHRASE	setPreferred_term(String value)
CODE_PHRASE	setPreferred_termElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
CODE_PHRASE	setTerminology_id(TERMINOLOGY_ID value)
protected CODE_PHRASE	typedCopy()

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

terminology_id

protected TERMINOLOGY_ID terminology_id

Identifier of the distinct terminology from which the code_string (or its elements) was extracted.

code_string

protected StringType code_string

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

preferred_term

protected StringType preferred_term

Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

Constructor Details

CODE_PHRASE

public CODE_PHRASE()

Constructor

CODE_PHRASE

public CODE_PHRASE(TERMINOLOGY_ID terminology_id,
 String code_string)

Constructor

Method Details

getTerminology_id

public TERMINOLOGY_ID getTerminology_id()

Returns:

terminology_id (Identifier of the distinct terminology from which the code_string (or its elements) was extracted.)

hasTerminology_id

public boolean hasTerminology_id()

setTerminology_id

public CODE_PHRASE setTerminology_id(TERMINOLOGY_ID value)

Parameters:

value - terminology_id (Identifier of the distinct terminology from which the code_string (or its elements) was extracted.)

getCode_stringElement

public StringType getCode_stringElement()

Returns:

code_string (The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.). This is the underlying object with id, value and extensions. The accessor "getCode_string" gives direct access to the value

hasCode_stringElement

public boolean hasCode_stringElement()

hasCode_string

public boolean hasCode_string()

setCode_stringElement

public CODE_PHRASE setCode_stringElement(StringType value)

Parameters:

value - code_string (The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.). This is the underlying object with id, value and extensions. The accessor "getCode_string" gives direct access to the value

getCode_string

public String getCode_string()

Returns:

The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

setCode_string

public CODE_PHRASE setCode_string(String value)

Parameters:

value - The key used by the terminology service to identify a concept or coordination of concepts. This string is most likely parsable inside the terminology service, but nothing can be assumed about its syntax outside that context.

getPreferred_termElement

public StringType getPreferred_termElement()

Returns:

preferred_term (Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.). This is the underlying object with id, value and extensions. The accessor "getPreferred_term" gives direct access to the value

hasPreferred_termElement

public boolean hasPreferred_termElement()

hasPreferred_term

public boolean hasPreferred_term()

setPreferred_termElement

public CODE_PHRASE setPreferred_termElement(StringType value)

Parameters:

value - preferred_term (Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.). This is the underlying object with id, value and extensions. The accessor "getPreferred_term" gives direct access to the value

getPreferred_term

public String getPreferred_term()

Returns:

Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

setPreferred_term

public CODE_PHRASE setPreferred_term(String value)

Parameters:

value - Optional attribute to carry preferred term corresponding to the code or expression in code_string. Typical use in integration situations which create mappings, and representing data for which both a (non-preferred) actual term and a preferred term are both required.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Base

getNamedProperty

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

Overrides:

getNamedProperty in class Base

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 Base

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 Base

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Specified by:

fhirType in class Base

Returns:

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

copy

public CODE_PHRASE copy()

Specified by:

copy in class Base

copyValues

public void copyValues(CODE_PHRASE dst)

typedCopy

protected CODE_PHRASE typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Base

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Base

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Base