Package org.hl7.fhir.r5.openehr

Class AUTHORED_RESOURCE

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.AUTHORED_RESOURCE

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

Abstract idea of an online resource created by a human author.

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 RESOURCE_DESCRIPTION	description	Description and lifecycle information of the resource.
protected BooleanType	is_controlled	True if this resource is under any kind of change control (even file copying), in which case revision history is created.
protected CODE_PHRASE	original_language	Language in which this resource was initially authored.
protected REVISION_HISTORY	revision_history	The revision history of the resource.
protected List<TRANSLATION_DETAILS>	translationsList	List of details for each natural-language translation made of this resource, keyed by language.

Constructor Summary

Constructors

Constructor	Description
AUTHORED_RESOURCE()	Constructor
AUTHORED_RESOURCE(CODE_PHRASE original_language)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
TRANSLATION_DETAILS	addTranslations()
AUTHORED_RESOURCE	addTranslations(TRANSLATION_DETAILS t)
abstract AUTHORED_RESOURCE	copy()
void	copyValues(AUTHORED_RESOURCE dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
RESOURCE_DESCRIPTION	getDescription()
boolean	getIs_controlled()
BooleanType	getIs_controlledElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
CODE_PHRASE	getOriginal_language()
Base[]	getProperty(int hash, String name, boolean checkValid)
REVISION_HISTORY	getRevision_history()
TRANSLATION_DETAILS	getTranslationsFirstRep()
List<TRANSLATION_DETAILS>	getTranslationsList()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDescription()
boolean	hasIs_controlled()
boolean	hasIs_controlledElement()
boolean	hasOriginal_language()
boolean	hasRevision_history()
boolean	hasTranslations()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
AUTHORED_RESOURCE	setDescription(RESOURCE_DESCRIPTION value)
AUTHORED_RESOURCE	setIs_controlled(boolean value)
AUTHORED_RESOURCE	setIs_controlledElement(BooleanType value)
AUTHORED_RESOURCE	setOriginal_language(CODE_PHRASE value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
AUTHORED_RESOURCE	setRevision_history(REVISION_HISTORY value)
AUTHORED_RESOURCE	setTranslationsList(List<TRANSLATION_DETAILS> theTranslations)

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

original_language

protected CODE_PHRASE original_language

Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections.

is_controlled

protected BooleanType is_controlled

True if this resource is under any kind of change control (even file copying), in which case revision history is created.

translationsList

protected List<TRANSLATION_DETAILS> translationsList

List of details for each natural-language translation made of this resource, keyed by language. For each translation listed here, there must be corresponding sections in all language-dependent parts of the resource. The original_language does not appear in this list.

description

protected RESOURCE_DESCRIPTION description

Description and lifecycle information of the resource.

revision_history

protected REVISION_HISTORY revision_history

The revision history of the resource. Only required if is_controlled = True (avoids large revision histories for informal or private editing situations).

Constructor Details

AUTHORED_RESOURCE

public AUTHORED_RESOURCE()

Constructor

AUTHORED_RESOURCE

public AUTHORED_RESOURCE(CODE_PHRASE original_language)

Constructor

Method Details

getOriginal_language

public CODE_PHRASE getOriginal_language()

Returns:

original_language (Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections.)

hasOriginal_language

public boolean hasOriginal_language()

setOriginal_language

public AUTHORED_RESOURCE setOriginal_language(CODE_PHRASE value)

Parameters:

value - original_language (Language in which this resource was initially authored. Although there is no language primacy of resources overall, the language of original authoring is required to ensure natural language translations can preserve quality. Language is relevant in both the description and ontology sections.)

getIs_controlledElement

public BooleanType getIs_controlledElement()

Returns:

is_controlled (True if this resource is under any kind of change control (even file copying), in which case revision history is created.). This is the underlying object with id, value and extensions. The accessor "getIs_controlled" gives direct access to the value

hasIs_controlledElement

public boolean hasIs_controlledElement()

hasIs_controlled

public boolean hasIs_controlled()

setIs_controlledElement

public AUTHORED_RESOURCE setIs_controlledElement(BooleanType value)

Parameters:

value - is_controlled (True if this resource is under any kind of change control (even file copying), in which case revision history is created.). This is the underlying object with id, value and extensions. The accessor "getIs_controlled" gives direct access to the value

getIs_controlled

public boolean getIs_controlled()

Returns:

True if this resource is under any kind of change control (even file copying), in which case revision history is created.

setIs_controlled

public AUTHORED_RESOURCE setIs_controlled(boolean value)

Parameters:

value - True if this resource is under any kind of change control (even file copying), in which case revision history is created.

getTranslationsList

public List<TRANSLATION_DETAILS> getTranslationsList()

Returns:

invalid reference

#translations

(List of details for each natural-language translation made of this resource, keyed by language. For each translation listed here, there must be corresponding sections in all language-dependent parts of the resource. The original_language does not appear in this list.)

setTranslationsList

public AUTHORED_RESOURCE setTranslationsList(List<TRANSLATION_DETAILS> theTranslations)

Returns:

Returns a reference to this for easy method chaining

hasTranslations

public boolean hasTranslations()

addTranslations

public TRANSLATION_DETAILS addTranslations()

addTranslations

public AUTHORED_RESOURCE addTranslations(TRANSLATION_DETAILS t)

getTranslationsFirstRep

public TRANSLATION_DETAILS getTranslationsFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#translations

, creating it if it does not already exist {3}

getDescription

public RESOURCE_DESCRIPTION getDescription()

Returns:

description (Description and lifecycle information of the resource.)

hasDescription

public boolean hasDescription()

setDescription

public AUTHORED_RESOURCE setDescription(RESOURCE_DESCRIPTION value)

Parameters:

value - description (Description and lifecycle information of the resource.)

getRevision_history

public REVISION_HISTORY getRevision_history()

Returns:

revision_history (The revision history of the resource. Only required if is_controlled = True (avoids large revision histories for informal or private editing situations).)

hasRevision_history

public boolean hasRevision_history()

setRevision_history

public AUTHORED_RESOURCE setRevision_history(REVISION_HISTORY value)

Parameters:

value - revision_history (The revision history of the resource. Only required if is_controlled = True (avoids large revision histories for informal or private editing situations).)

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 abstract AUTHORED_RESOURCE copy()

Specified by:

copy in class Base

copyValues

public void copyValues(AUTHORED_RESOURCE dst)

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