Package org.hl7.fhir.r5.model

Class BackboneType

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.BackboneType

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Direct Known Subclasses:

Dosage, ElementDefinition, MarketingStatus, OrderedDistribution, ProdCharacteristic, ProductShelfLife, Statistic, SubstanceAmount, Timing

public abstract class BackboneType
extends DataType
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

BackboneType Type: Base definition for the few data types that are allowed to carry modifier extensions.

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 List<Extension>	modifierExtension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants.

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
BackboneType()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Extension	addModifierExtension()
BackboneType	addModifierExtension(Extension t)
void	checkNoModifiers(String noun, String verb)
abstract BackboneType	copy()
void	copyExtensions(BackboneElement src, String... urls)
void	copyNewExtensions(BackboneElement src, String... urls)
void	copyValues(BackboneType dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Extension>	getExtensionsByUrl(String... theUrls)
List<Extension>	getModifierExtension()
Extension	getModifierExtensionFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
boolean	hasExtension(String theUrl)	Returns an true if this element has an extension that matchs the given URL.
boolean	hasExtension(String... theUrls)
boolean	hasModifierExtension()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
BackboneType	setModifierExtension(List<Extension> theModifierExtension)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getExtensionString, getExtensionValue, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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, 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

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

Field Details

modifierExtension

protected List<Extension> modifierExtension

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Constructor Details

BackboneType

public BackboneType()

Constructor

Method Details

getModifierExtension

public List<Extension> getModifierExtension()

Specified by:

getModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Returns:

modifierExtension (May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).)

setModifierExtension

public BackboneType setModifierExtension(List<Extension> theModifierExtension)

Returns:

Returns a reference to this for easy method chaining

hasModifierExtension

public boolean hasModifierExtension()

Specified by:

hasModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension

public Extension addModifierExtension()

Specified by:

addModifierExtension in interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

addModifierExtension

public BackboneType addModifierExtension(Extension t)

getModifierExtensionFirstRep

public Extension getModifierExtensionFirstRep()

Returns:

The first repetition of repeating field modifierExtension, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

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

Overrides:

getNamedProperty in class Element

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 Element

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 Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DataType

Returns:

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

copy

public abstract BackboneType copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(BackboneType dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element

checkNoModifiers

public void checkNoModifiers(String noun,
 String verb)
                      throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

copyExtensions

public void copyExtensions(BackboneElement src,
 String... urls)

getExtensionsByUrl

public List<Extension> getExtensionsByUrl(String... theUrls)

Overrides:

getExtensionsByUrl in class Element

hasExtension

public boolean hasExtension(String... theUrls)

Overrides:

hasExtension in class Element

hasExtension

public boolean hasExtension(String theUrl)

Description copied from class: Element

Returns an true if this element has an extension that matchs the given URL. Note: BackboneElements override this to check Modifier Extensions too

Overrides:

hasExtension in class Element

Parameters:

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

copyNewExtensions

public void copyNewExtensions(BackboneElement src,
 String... urls)