Package org.hl7.fhir.dstu2.model

Class Element

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

All Implemented Interfaces:

Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions

Direct Known Subclasses:

BackboneElement, ElementDefinition.ElementDefinitionBaseComponent, ElementDefinition.ElementDefinitionBindingComponent, ElementDefinition.ElementDefinitionConstraintComponent, ElementDefinition.ElementDefinitionMappingComponent, ElementDefinition.ElementDefinitionSlicingComponent, ElementDefinition.TypeRefComponent, Timing.TimingRepeatComponent, Type

public abstract class Element
extends Base
implements org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseElement

Base definition for all elements in a resource.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Extension>	extension	May be used to represent additional information that is not part of the basic definition of the element.
protected IdType	id	unique id for the element within a resource (for internal references).

Constructor Summary

Constructors

Constructor	Description
Element()

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Extension	addExtension()
Element	addExtension(Extension t)
abstract Element	copy()
void	copyValues(Element dst)
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<Extension>	getExtension()
List<Extension>	getExtensionsByUrl(String theUrl)	Returns an unmodifiable list containing all extensions on this element which match the given URL.
String	getExtensionString(String theUrl)
String	getId()
IdType	getIdElement()
boolean	hasExtension()
boolean	hasExtension(String theUrl)
boolean	hasId()
boolean	hasIdElement()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Element	setId(String value)
Element	setIdElement(IdType value)
void	setProperty(String name, Base value)

Methods inherited from class org.hl7.fhir.dstu2.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Field Detail

id

protected IdType id

unique id for the element within a resource (for internal references).

extension

protected List<Extension> extension

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Constructor Detail

Element

public Element()

Method Detail

getIdElement

public IdType getIdElement()

Returns:

id (unique id for the element within a resource (for internal references).). This is the underlying object with id, value and extensions. The accessor "getId" gives direct access to the value

hasIdElement

public boolean hasIdElement()

hasId

public boolean hasId()

setIdElement

public Element setIdElement(IdType value)

Parameters:

value - id (unique id for the element within a resource (for internal references).). This is the underlying object with id, value and extensions. The accessor "getId" gives direct access to the value

getId

public String getId()

Specified by:

getId in interface org.hl7.fhir.instance.model.api.IBaseElement

Returns:

unique id for the element within a resource (for internal references).

setId

public Element setId(String value)

Specified by:

setId in interface org.hl7.fhir.instance.model.api.IBaseElement

Parameters:

value - unique id for the element within a resource (for internal references).

getExtension

public List<Extension> getExtension()

Specified by:

getExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Returns:

extension (May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.)

hasExtension

public boolean hasExtension()

Specified by:

hasExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

addExtension

public Extension addExtension()

Specified by:

addExtension in interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Returns:

extension (May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.)

addExtension

public Element addExtension(Extension t)

getExtensionsByUrl

public List<Extension> getExtensionsByUrl(String theUrl)

Returns an unmodifiable list containing all extensions on this element which match the given URL.

Parameters:

theUrl - The URL. Must not be blank or null.

Returns:

an unmodifiable list containing all extensions on this element which match the given URL

hasExtension

public boolean hasExtension(String theUrl)

getExtensionString

public String getExtensionString(String theUrl)
                          throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

listChildren

protected void listChildren(List<Property> childrenList)

Specified by:

listChildren in class Base

setProperty

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

Overrides:

setProperty 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

copy

public abstract Element copy()

copyValues

public void copyValues(Element 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