Package org.hl7.fhir.r5.model

Class ElementDefinition.ElementDefinitionBindingAdditionalComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.ElementDefinition.ElementDefinitionBindingAdditionalComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatypeElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions

Enclosing class:

ElementDefinition

public static class ElementDefinition.ElementDefinitionBindingAdditionalComponent
extends Element
implements org.hl7.fhir.instance.model.api.IBaseDatatypeElement

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 BooleanType	any	Whether the binding applies to all repeats, or just to any one of them.
protected MarkdownType	documentation	Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.
protected Enumeration<ElementDefinition.AdditionalBindingPurposeVS>	purpose	The use of this additional binding.
protected StringType	shortDoco	Concise documentation - for summary tables.
protected List<UsageContext>	usage	Qualifies the usage of the binding.
protected CanonicalType	valueSet	The valueSet that is being bound for the purpose.

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ElementDefinitionBindingAdditionalComponent()	Constructor
ElementDefinitionBindingAdditionalComponent(ElementDefinition.AdditionalBindingPurposeVS purpose, String valueSet)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
UsageContext	addUsage()
ElementDefinition.ElementDefinitionBindingAdditionalComponent	addUsage(UsageContext t)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	copy()
void	copyValues(ElementDefinition.ElementDefinitionBindingAdditionalComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAny()
BooleanType	getAnyElement()
String	getDocumentation()
MarkdownType	getDocumentationElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
ElementDefinition.AdditionalBindingPurposeVS	getPurpose()
Enumeration<ElementDefinition.AdditionalBindingPurposeVS>	getPurposeElement()
String	getShortDoco()
StringType	getShortDocoElement()
String[]	getTypesForProperty(int hash, String name)
List<UsageContext>	getUsage()
UsageContext	getUsageFirstRep()
String	getValueSet()
CanonicalType	getValueSetElement()
boolean	hasAny()
boolean	hasAnyElement()
boolean	hasDocumentation()
boolean	hasDocumentationElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasShortDoco()
boolean	hasShortDocoElement()
boolean	hasUsage()
boolean	hasValueSet()
boolean	hasValueSetElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setAny(boolean value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setAnyElement(BooleanType value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setDocumentation(String value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setDocumentationElement(MarkdownType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setPurpose(ElementDefinition.AdditionalBindingPurposeVS value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setPurposeElement(Enumeration<ElementDefinition.AdditionalBindingPurposeVS> value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setShortDoco(String value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setShortDocoElement(StringType value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setUsage(List<UsageContext> theUsage)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setValueSet(String value)
ElementDefinition.ElementDefinitionBindingAdditionalComponent	setValueSetElement(CanonicalType value)

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, 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, 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

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 Details

purpose

protected Enumeration<ElementDefinition.AdditionalBindingPurposeVS> purpose

The use of this additional binding.

valueSet

protected CanonicalType valueSet

The valueSet that is being bound for the purpose.

documentation

protected MarkdownType documentation

Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.

shortDoco

protected StringType shortDoco

Concise documentation - for summary tables.

usage

protected List<UsageContext> usage

Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.

any

protected BooleanType any

Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.

Constructor Details

ElementDefinitionBindingAdditionalComponent

public ElementDefinitionBindingAdditionalComponent()

Constructor

ElementDefinitionBindingAdditionalComponent

public ElementDefinitionBindingAdditionalComponent(ElementDefinition.AdditionalBindingPurposeVS purpose,
 String valueSet)

Constructor

Method Details

getPurposeElement

public Enumeration<ElementDefinition.AdditionalBindingPurposeVS> getPurposeElement()

Returns:

purpose (The use of this additional binding.). 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 ElementDefinition.ElementDefinitionBindingAdditionalComponent setPurposeElement(Enumeration<ElementDefinition.AdditionalBindingPurposeVS> value)

Parameters:

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

getPurpose

public ElementDefinition.AdditionalBindingPurposeVS getPurpose()

Returns:

The use of this additional binding.

setPurpose

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setPurpose(ElementDefinition.AdditionalBindingPurposeVS value)

Parameters:

value - The use of this additional binding.

getValueSetElement

public CanonicalType getValueSetElement()

Returns:

valueSet (The valueSet that is being bound for the purpose.). This is the underlying object with id, value and extensions. The accessor "getValueSet" gives direct access to the value

hasValueSetElement

public boolean hasValueSetElement()

hasValueSet

public boolean hasValueSet()

setValueSetElement

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setValueSetElement(CanonicalType value)

Parameters:

value - valueSet (The valueSet that is being bound for the purpose.). This is the underlying object with id, value and extensions. The accessor "getValueSet" gives direct access to the value

getValueSet

public String getValueSet()

Returns:

The valueSet that is being bound for the purpose.

setValueSet

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setValueSet(String value)

Parameters:

value - The valueSet that is being bound for the purpose.

getDocumentationElement

public MarkdownType getDocumentationElement()

Returns:

documentation (Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

hasDocumentationElement

public boolean hasDocumentationElement()

hasDocumentation

public boolean hasDocumentation()

setDocumentationElement

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setDocumentationElement(MarkdownType value)

Parameters:

value - documentation (Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

getDocumentation

public String getDocumentation()

Returns:

Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.

setDocumentation

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setDocumentation(String value)

Parameters:

value - Documentation of the purpose of use of the bindingproviding additional information about how it is intended to be used.

getShortDocoElement

public StringType getShortDocoElement()

Returns:

shortDoco (Concise documentation - for summary tables.). This is the underlying object with id, value and extensions. The accessor "getShortDoco" gives direct access to the value

hasShortDocoElement

public boolean hasShortDocoElement()

hasShortDoco

public boolean hasShortDoco()

setShortDocoElement

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setShortDocoElement(StringType value)

Parameters:

value - shortDoco (Concise documentation - for summary tables.). This is the underlying object with id, value and extensions. The accessor "getShortDoco" gives direct access to the value

getShortDoco

public String getShortDoco()

Returns:

Concise documentation - for summary tables.

setShortDoco

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setShortDoco(String value)

Parameters:

value - Concise documentation - for summary tables.

getUsage

public List<UsageContext> getUsage()

Returns:

usage (Qualifies the usage of the binding. Typically bindings are qualified by jurisdiction, but they may also be qualified by gender, workflow status, clinical domain etc. The information to decide whether a usege context applies is usually outside the resource, determined by context, and this might present challenges for validation tooling.)

setUsage

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setUsage(List<UsageContext> theUsage)

Returns:

Returns a reference to this for easy method chaining

hasUsage

public boolean hasUsage()

addUsage

public UsageContext addUsage()

addUsage

public ElementDefinition.ElementDefinitionBindingAdditionalComponent addUsage(UsageContext t)

getUsageFirstRep

public UsageContext getUsageFirstRep()

Returns:

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

getAnyElement

public BooleanType getAnyElement()

Returns:

any (Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.). This is the underlying object with id, value and extensions. The accessor "getAny" gives direct access to the value

hasAnyElement

public boolean hasAnyElement()

hasAny

public boolean hasAny()

setAnyElement

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setAnyElement(BooleanType value)

Parameters:

value - any (Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.). This is the underlying object with id, value and extensions. The accessor "getAny" gives direct access to the value

getAny

public boolean getAny()

Returns:

Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.

setAny

public ElementDefinition.ElementDefinitionBindingAdditionalComponent setAny(boolean value)

Parameters:

value - Whether the binding applies to all repeats, or just to any one of them. This is only relevant for elements that can repeat.

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

copy

public ElementDefinition.ElementDefinitionBindingAdditionalComponent copy()

Specified by:

copy in class Element

copyValues

public void copyValues(ElementDefinition.ElementDefinitionBindingAdditionalComponent 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

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class Element

Returns:

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