Package org.hl7.fhir.r5.openehr

Class ARCHETYPED

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.ARCHETYPED

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

Archetypes act as the configuration basis for the particular structures of instances defined by the reference model. To enable archetypes to be used to create valid data, key classes in the reference model act as root points for archetyping; accordingly, these classes have the archetype_details attribute set. An instance of the class ARCHETYPED contains the relevant archetype identification information, allowing generating archetypes to be matched up with data instances.

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 ARCHETYPE_ID	archetype_id	Globally unique archetype identifier.
protected StringType	rm_version	Version of the openEHR reference model used to create this object.
protected TEMPLATE_ID	template_id	Globally unique template identifier, if a template was active at this point in the structure.

Constructor Summary

Constructors

Constructor	Description
ARCHETYPED()	Constructor
ARCHETYPED(ARCHETYPE_ID archetype_id)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ARCHETYPED	copy()
void	copyValues(ARCHETYPED dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
ARCHETYPE_ID	getArchetype_id()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getRm_version()
StringType	getRm_versionElement()
TEMPLATE_ID	getTemplate_id()
String[]	getTypesForProperty(int hash, String name)
boolean	hasArchetype_id()
boolean	hasRm_version()
boolean	hasRm_versionElement()
boolean	hasTemplate_id()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ARCHETYPED	setArchetype_id(ARCHETYPE_ID value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ARCHETYPED	setRm_version(String value)
ARCHETYPED	setRm_versionElement(StringType value)
ARCHETYPED	setTemplate_id(TEMPLATE_ID value)
protected ARCHETYPED	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

archetype_id

protected ARCHETYPE_ID archetype_id

Globally unique archetype identifier.

template_id

protected TEMPLATE_ID template_id

Globally unique template identifier, if a template was active at this point in the structure. Normally, a template would only be used at the top of a top-level structure, but the possibility exists for templates at lower levels.

rm_version

protected StringType rm_version

Version of the openEHR reference model used to create this object. Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .

Constructor Details

ARCHETYPED

public ARCHETYPED()

Constructor

ARCHETYPED

public ARCHETYPED(ARCHETYPE_ID archetype_id)

Constructor

Method Details

getArchetype_id

public ARCHETYPE_ID getArchetype_id()

Returns:

archetype_id (Globally unique archetype identifier.)

hasArchetype_id

public boolean hasArchetype_id()

setArchetype_id

public ARCHETYPED setArchetype_id(ARCHETYPE_ID value)

Parameters:

value - archetype_id (Globally unique archetype identifier.)

getTemplate_id

public TEMPLATE_ID getTemplate_id()

Returns:

template_id (Globally unique template identifier, if a template was active at this point in the structure. Normally, a template would only be used at the top of a top-level structure, but the possibility exists for templates at lower levels.)

hasTemplate_id

public boolean hasTemplate_id()

setTemplate_id

public ARCHETYPED setTemplate_id(TEMPLATE_ID value)

Parameters:

value - template_id (Globally unique template identifier, if a template was active at this point in the structure. Normally, a template would only be used at the top of a top-level structure, but the possibility exists for templates at lower levels.)

getRm_versionElement

public StringType getRm_versionElement()

Returns:

rm_version (Version of the openEHR reference model used to create this object. Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .). This is the underlying object with id, value and extensions. The accessor "getRm_version" gives direct access to the value

hasRm_versionElement

public boolean hasRm_versionElement()

hasRm_version

public boolean hasRm_version()

setRm_versionElement

public ARCHETYPED setRm_versionElement(StringType value)

Parameters:

value - rm_version (Version of the openEHR reference model used to create this object. Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .). This is the underlying object with id, value and extensions. The accessor "getRm_version" gives direct access to the value

getRm_version

public String getRm_version()

Returns:

Version of the openEHR reference model used to create this object. Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .

setRm_version

public ARCHETYPED setRm_version(String value)

Parameters:

value - Version of the openEHR reference model used to create this object. Expressed in terms of the release version string, e.g. 1.0 , 1.2.4 .

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

Specified by:

copy in class Base

copyValues

public void copyValues(ARCHETYPED dst)

typedCopy

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