Package org.hl7.fhir.r5.openehr

Class RESOURCE_DESCRIPTION_ITEM

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.RESOURCE_DESCRIPTION_ITEM

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

Language-specific detail of resource description. When a resource is translated for use in another language environment, each RESOURCE_DESCRIPTION_ITEM needs to be copied and translated into the new language.

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	copyright	Optional copyright statement for the resource as a knowledge resource.
protected List<StringType>	keywordsList	Keywords which characterise this resource, used e.g.
protected CODE_PHRASE	language	The localised language in which the items in this description item are written.
protected StringType	misuse	Description of any misuses of the resource, i.e.
protected List<StringType>	original_resource_uriList	URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.
protected List<StringType>	other_detailsList	Additional language-senstive resource metadata, as a list of name/value pairs.
protected StringType	purpose	Purpose of the resource.
protected StringType	use	Description of the uses of the resource, i.e.

Constructor Summary

Constructors

Constructor	Description
RESOURCE_DESCRIPTION_ITEM()	Constructor
RESOURCE_DESCRIPTION_ITEM(CODE_PHRASE language, String purpose, String other_details)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
RESOURCE_DESCRIPTION_ITEM	addKeywords(String value)
StringType	addKeywordsElement()
RESOURCE_DESCRIPTION_ITEM	addOriginal_resource_uri(String value)
StringType	addOriginal_resource_uriElement()
RESOURCE_DESCRIPTION_ITEM	addOther_details(String value)
StringType	addOther_detailsElement()
RESOURCE_DESCRIPTION_ITEM	copy()
void	copyValues(RESOURCE_DESCRIPTION_ITEM dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getCopyright()
StringType	getCopyrightElement()
List<StringType>	getKeywordsList()
CODE_PHRASE	getLanguage()
String	getMisuse()
StringType	getMisuseElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<StringType>	getOriginal_resource_uriList()
List<StringType>	getOther_detailsList()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPurpose()
StringType	getPurposeElement()
String[]	getTypesForProperty(int hash, String name)
String	getUse()
StringType	getUseElement()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasKeywords()
boolean	hasKeywords(String value)
boolean	hasLanguage()
boolean	hasMisuse()
boolean	hasMisuseElement()
boolean	hasOriginal_resource_uri()
boolean	hasOriginal_resource_uri(String value)
boolean	hasOther_details()
boolean	hasOther_details(String value)
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasUse()
boolean	hasUseElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
RESOURCE_DESCRIPTION_ITEM	setCopyright(String value)
RESOURCE_DESCRIPTION_ITEM	setCopyrightElement(StringType value)
RESOURCE_DESCRIPTION_ITEM	setKeywordsList(List<StringType> theKeywords)
RESOURCE_DESCRIPTION_ITEM	setLanguage(CODE_PHRASE value)
RESOURCE_DESCRIPTION_ITEM	setMisuse(String value)
RESOURCE_DESCRIPTION_ITEM	setMisuseElement(StringType value)
RESOURCE_DESCRIPTION_ITEM	setOriginal_resource_uriList(List<StringType> theOriginal_resource_uri)
RESOURCE_DESCRIPTION_ITEM	setOther_detailsList(List<StringType> theOther_details)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
RESOURCE_DESCRIPTION_ITEM	setPurpose(String value)
RESOURCE_DESCRIPTION_ITEM	setPurposeElement(StringType value)
RESOURCE_DESCRIPTION_ITEM	setUse(String value)
RESOURCE_DESCRIPTION_ITEM	setUseElement(StringType value)
protected RESOURCE_DESCRIPTION_ITEM	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

language

protected CODE_PHRASE language

The localised language in which the items in this description item are written. Coded from openEHR code set languages.

purpose

protected StringType purpose

Purpose of the resource.

keywordsList

protected List<StringType> keywordsList

Keywords which characterise this resource, used e.g. for indexing and searching.

use

protected StringType use

Description of the uses of the resource, i.e. contexts in which it could be used.

misuse

protected StringType misuse

Description of any misuses of the resource, i.e. contexts in which it should not be used.

copyright

protected StringType copyright

Optional copyright statement for the resource as a knowledge resource.

original_resource_uriList

protected List<StringType> original_resource_uriList

URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.

other_detailsList

protected List<StringType> other_detailsList

Additional language-senstive resource metadata, as a list of name/value pairs.

Constructor Details

RESOURCE_DESCRIPTION_ITEM

public RESOURCE_DESCRIPTION_ITEM()

Constructor

RESOURCE_DESCRIPTION_ITEM

public RESOURCE_DESCRIPTION_ITEM(CODE_PHRASE language,
 String purpose,
 String other_details)

Constructor

Method Details

getLanguage

public CODE_PHRASE getLanguage()

Returns:

language (The localised language in which the items in this description item are written. Coded from openEHR code set languages.)

hasLanguage

public boolean hasLanguage()

setLanguage

public RESOURCE_DESCRIPTION_ITEM setLanguage(CODE_PHRASE value)

Parameters:

value - language (The localised language in which the items in this description item are written. Coded from openEHR code set languages.)

getPurposeElement

public StringType getPurposeElement()

Returns:

purpose (Purpose of the resource.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

hasPurposeElement

public boolean hasPurposeElement()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public RESOURCE_DESCRIPTION_ITEM setPurposeElement(StringType value)

Parameters:

value - purpose (Purpose of the resource.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value

getPurpose

public String getPurpose()

Returns:

Purpose of the resource.

setPurpose

public RESOURCE_DESCRIPTION_ITEM setPurpose(String value)

Parameters:

value - Purpose of the resource.

getKeywordsList

public List<StringType> getKeywordsList()

Returns:

#keywords (Keywords which characterise this resource, used e.g. for indexing and searching.)

setKeywordsList

public RESOURCE_DESCRIPTION_ITEM setKeywordsList(List<StringType> theKeywords)

Returns:

Returns a reference to this for easy method chaining

hasKeywords

public boolean hasKeywords()

addKeywordsElement

public StringType addKeywordsElement()

Returns:

#keywords (Keywords which characterise this resource, used e.g. for indexing and searching.)

addKeywords

public RESOURCE_DESCRIPTION_ITEM addKeywords(String value)

Parameters:

value - #keywords (Keywords which characterise this resource, used e.g. for indexing and searching.)

hasKeywords

public boolean hasKeywords(String value)

Parameters:

value - #keywords (Keywords which characterise this resource, used e.g. for indexing and searching.)

getUseElement

public StringType getUseElement()

Returns:

use (Description of the uses of the resource, i.e. contexts in which it could be used.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

hasUseElement

public boolean hasUseElement()

hasUse

public boolean hasUse()

setUseElement

public RESOURCE_DESCRIPTION_ITEM setUseElement(StringType value)

Parameters:

value - use (Description of the uses of the resource, i.e. contexts in which it could be used.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

getUse

public String getUse()

Returns:

Description of the uses of the resource, i.e. contexts in which it could be used.

setUse

public RESOURCE_DESCRIPTION_ITEM setUse(String value)

Parameters:

value - Description of the uses of the resource, i.e. contexts in which it could be used.

getMisuseElement

public StringType getMisuseElement()

Returns:

misuse (Description of any misuses of the resource, i.e. contexts in which it should not be used.). This is the underlying object with id, value and extensions. The accessor "getMisuse" gives direct access to the value

hasMisuseElement

public boolean hasMisuseElement()

hasMisuse

public boolean hasMisuse()

setMisuseElement

public RESOURCE_DESCRIPTION_ITEM setMisuseElement(StringType value)

Parameters:

value - misuse (Description of any misuses of the resource, i.e. contexts in which it should not be used.). This is the underlying object with id, value and extensions. The accessor "getMisuse" gives direct access to the value

getMisuse

public String getMisuse()

Returns:

Description of any misuses of the resource, i.e. contexts in which it should not be used.

setMisuse

public RESOURCE_DESCRIPTION_ITEM setMisuse(String value)

Parameters:

value - Description of any misuses of the resource, i.e. contexts in which it should not be used.

getCopyrightElement

public StringType getCopyrightElement()

Returns:

copyright (Optional copyright statement for the resource as a knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

hasCopyrightElement

public boolean hasCopyrightElement()

hasCopyright

public boolean hasCopyright()

setCopyrightElement

public RESOURCE_DESCRIPTION_ITEM setCopyrightElement(StringType value)

Parameters:

value - copyright (Optional copyright statement for the resource as a knowledge resource.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

getCopyright

public String getCopyright()

Returns:

Optional copyright statement for the resource as a knowledge resource.

setCopyright

public RESOURCE_DESCRIPTION_ITEM setCopyright(String value)

Parameters:

value - Optional copyright statement for the resource as a knowledge resource.

getOriginal_resource_uriList

public List<StringType> getOriginal_resource_uriList()

Returns:

#original_resource_uri (URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.)

setOriginal_resource_uriList

public RESOURCE_DESCRIPTION_ITEM setOriginal_resource_uriList(List<StringType> theOriginal_resource_uri)

Returns:

Returns a reference to this for easy method chaining

hasOriginal_resource_uri

public boolean hasOriginal_resource_uri()

addOriginal_resource_uriElement

public StringType addOriginal_resource_uriElement()

Returns:

#original_resource_uri (URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.)

addOriginal_resource_uri

public RESOURCE_DESCRIPTION_ITEM addOriginal_resource_uri(String value)

Parameters:

value - #original_resource_uri (URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.)

hasOriginal_resource_uri

public boolean hasOriginal_resource_uri(String value)

Parameters:

value - #original_resource_uri (URIs of original clinical document(s) or description of which resource is a formalisation, in the language of this description item; keyed by meaning.)

getOther_detailsList

public List<StringType> getOther_detailsList()

Returns:

#other_details (Additional language-senstive resource metadata, as a list of name/value pairs.)

setOther_detailsList

public RESOURCE_DESCRIPTION_ITEM setOther_detailsList(List<StringType> theOther_details)

Returns:

Returns a reference to this for easy method chaining

hasOther_details

public boolean hasOther_details()

addOther_detailsElement

public StringType addOther_detailsElement()

Returns:

#other_details (Additional language-senstive resource metadata, as a list of name/value pairs.)

addOther_details

public RESOURCE_DESCRIPTION_ITEM addOther_details(String value)

Parameters:

value - #other_details (Additional language-senstive resource metadata, as a list of name/value pairs.)

hasOther_details

public boolean hasOther_details(String value)

Parameters:

value - #other_details (Additional language-senstive resource metadata, as a list of name/value pairs.)

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

Specified by:

copy in class Base

copyValues

public void copyValues(RESOURCE_DESCRIPTION_ITEM dst)

typedCopy

protected RESOURCE_DESCRIPTION_ITEM 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