Package org.hl7.fhir.r5.model

Class ValueSet.ValueSetExpansionContainsComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.ValueSet.ValueSetExpansionContainsComponent

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.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

ValueSet

public static class ValueSet.ValueSetExpansionContainsComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

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	abstract_	If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
protected CodeType	code	The code for this item in the expansion hierarchy.
protected List<ValueSet.ValueSetExpansionContainsComponent>	contains	Other codes and entries contained under this entry in the hierarchy.
protected List<ValueSet.ConceptReferenceDesignationComponent>	designation	Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc.
protected StringType	display	The recommended display for this item in the expansion.
protected BooleanType	inactive	If the concept is inactive in the code system that defines it.
protected List<ValueSet.ConceptPropertyComponent>	property	A property value for this concept.
protected UriType	system	An absolute URI which is the code system in which the code for this item in the expansion is defined.
protected StringType	version	The version of the code system from this code was taken.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ValueSetExpansionContainsComponent()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ValueSet.ValueSetExpansionContainsComponent	addContains()
ValueSet.ValueSetExpansionContainsComponent	addContains(ValueSet.ValueSetExpansionContainsComponent t)
ValueSet.ConceptReferenceDesignationComponent	addDesignation()
ValueSet.ValueSetExpansionContainsComponent	addDesignation(ValueSet.ConceptReferenceDesignationComponent t)
ValueSet.ConceptPropertyComponent	addProperty()
ValueSet.ValueSetExpansionContainsComponent	addProperty(ValueSet.ConceptPropertyComponent t)
ValueSet.ValueSetExpansionContainsComponent	copy()
void	copyValues(ValueSet.ValueSetExpansionContainsComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAbstract()
BooleanType	getAbstractElement()
String	getCode()
CodeType	getCodeElement()
List<ValueSet.ValueSetExpansionContainsComponent>	getContains()
ValueSet.ValueSetExpansionContainsComponent	getContainsFirstRep()
List<ValueSet.ConceptReferenceDesignationComponent>	getDesignation()
ValueSet.ConceptReferenceDesignationComponent	getDesignationFirstRep()
String	getDisplay()
StringType	getDisplayElement()
boolean	getInactive()
BooleanType	getInactiveElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<ValueSet.ConceptPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
ValueSet.ConceptPropertyComponent	getPropertyFirstRep()
String	getSystem()
UriType	getSystemElement()
String[]	getTypesForProperty(int hash, String name)
String	getVersion()
StringType	getVersionElement()
boolean	hasAbstract()
boolean	hasAbstractElement()
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasContains()
boolean	hasDesignation()
boolean	hasDisplay()
boolean	hasDisplayElement()
boolean	hasInactive()
boolean	hasInactiveElement()
boolean	hasProperty()
boolean	hasSystem()
boolean	hasSystemElement()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ValueSet.ValueSetExpansionContainsComponent	setAbstract(boolean value)
ValueSet.ValueSetExpansionContainsComponent	setAbstractElement(BooleanType value)
ValueSet.ValueSetExpansionContainsComponent	setCode(String value)
ValueSet.ValueSetExpansionContainsComponent	setCodeElement(CodeType value)
ValueSet.ValueSetExpansionContainsComponent	setContains(List<ValueSet.ValueSetExpansionContainsComponent> theContains)
ValueSet.ValueSetExpansionContainsComponent	setDesignation(List<ValueSet.ConceptReferenceDesignationComponent> theDesignation)
ValueSet.ValueSetExpansionContainsComponent	setDisplay(String value)
ValueSet.ValueSetExpansionContainsComponent	setDisplayElement(StringType value)
ValueSet.ValueSetExpansionContainsComponent	setInactive(boolean value)
ValueSet.ValueSetExpansionContainsComponent	setInactiveElement(BooleanType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ValueSet.ValueSetExpansionContainsComponent	setProperty(List<ValueSet.ConceptPropertyComponent> theProperty)
ValueSet.ValueSetExpansionContainsComponent	setSystem(String value)
ValueSet.ValueSetExpansionContainsComponent	setSystemElement(UriType value)
ValueSet.ValueSetExpansionContainsComponent	setVersion(String value)
ValueSet.ValueSetExpansionContainsComponent	setVersionElement(StringType value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, 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

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

system

protected UriType system

An absolute URI which is the code system in which the code for this item in the expansion is defined.

abstract_

protected BooleanType abstract_

If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

inactive

protected BooleanType inactive

If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).

version

protected StringType version

The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

code

protected CodeType code

The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

display

protected StringType display

The recommended display for this item in the expansion.

designation

protected List<ValueSet.ConceptReferenceDesignationComponent> designation

Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.

property

protected List<ValueSet.ConceptPropertyComponent> property

A property value for this concept.

contains

protected List<ValueSet.ValueSetExpansionContainsComponent> contains

Other codes and entries contained under this entry in the hierarchy.

Constructor Details

ValueSetExpansionContainsComponent

public ValueSetExpansionContainsComponent()

Constructor

Method Details

getSystemElement

public UriType getSystemElement()

Returns:

system (An absolute URI which is the code system in which the code for this item in the expansion is defined.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

hasSystemElement

public boolean hasSystemElement()

hasSystem

public boolean hasSystem()

setSystemElement

public ValueSet.ValueSetExpansionContainsComponent setSystemElement(UriType value)

Parameters:

value - system (An absolute URI which is the code system in which the code for this item in the expansion is defined.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value

getSystem

public String getSystem()

Returns:

An absolute URI which is the code system in which the code for this item in the expansion is defined.

setSystem

public ValueSet.ValueSetExpansionContainsComponent setSystem(String value)

Parameters:

value - An absolute URI which is the code system in which the code for this item in the expansion is defined.

getAbstractElement

public BooleanType getAbstractElement()

Returns:

abstract_ (If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

hasAbstractElement

public boolean hasAbstractElement()

hasAbstract

public boolean hasAbstract()

setAbstractElement

public ValueSet.ValueSetExpansionContainsComponent setAbstractElement(BooleanType value)

Parameters:

value - abstract_ (If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.). This is the underlying object with id, value and extensions. The accessor "getAbstract" gives direct access to the value

getAbstract

public boolean getAbstract()

Returns:

If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

setAbstract

public ValueSet.ValueSetExpansionContainsComponent setAbstract(boolean value)

Parameters:

value - If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.

getInactiveElement

public BooleanType getInactiveElement()

Returns:

inactive (If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).). This is the underlying object with id, value and extensions. The accessor "getInactive" gives direct access to the value

hasInactiveElement

public boolean hasInactiveElement()

hasInactive

public boolean hasInactive()

setInactiveElement

public ValueSet.ValueSetExpansionContainsComponent setInactiveElement(BooleanType value)

Parameters:

value - inactive (If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).). This is the underlying object with id, value and extensions. The accessor "getInactive" gives direct access to the value

getInactive

public boolean getInactive()

Returns:

If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).

setInactive

public ValueSet.ValueSetExpansionContainsComponent setInactive(boolean value)

Parameters:

value - If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether a concept is inactive (and it may depend on the context of use).

getVersionElement

public StringType getVersionElement()

Returns:

version (The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

hasVersion

public boolean hasVersion()

setVersionElement

public ValueSet.ValueSetExpansionContainsComponent setVersionElement(StringType value)

Parameters:

value - version (The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Returns:

The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

setVersion

public ValueSet.ValueSetExpansionContainsComponent setVersion(String value)

Parameters:

value - The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

getCodeElement

public CodeType getCodeElement()

Returns:

code (The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

hasCodeElement

public boolean hasCodeElement()

hasCode

public boolean hasCode()

setCodeElement

public ValueSet.ValueSetExpansionContainsComponent setCodeElement(CodeType value)

Parameters:

value - code (The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

getCode

public String getCode()

Returns:

The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

setCode

public ValueSet.ValueSetExpansionContainsComponent setCode(String value)

Parameters:

value - The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.

getDisplayElement

public StringType getDisplayElement()

Returns:

display (The recommended display for this item in the expansion.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

hasDisplayElement

public boolean hasDisplayElement()

hasDisplay

public boolean hasDisplay()

setDisplayElement

public ValueSet.ValueSetExpansionContainsComponent setDisplayElement(StringType value)

Parameters:

value - display (The recommended display for this item in the expansion.). This is the underlying object with id, value and extensions. The accessor "getDisplay" gives direct access to the value

getDisplay

public String getDisplay()

Returns:

The recommended display for this item in the expansion.

setDisplay

public ValueSet.ValueSetExpansionContainsComponent setDisplay(String value)

Parameters:

value - The recommended display for this item in the expansion.

getDesignation

public List<ValueSet.ConceptReferenceDesignationComponent> getDesignation()

Returns:

designation (Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.)

setDesignation

public ValueSet.ValueSetExpansionContainsComponent setDesignation(List<ValueSet.ConceptReferenceDesignationComponent> theDesignation)

Returns:

Returns a reference to this for easy method chaining

hasDesignation

public boolean hasDesignation()

addDesignation

public ValueSet.ConceptReferenceDesignationComponent addDesignation()

addDesignation

public ValueSet.ValueSetExpansionContainsComponent addDesignation(ValueSet.ConceptReferenceDesignationComponent t)

getDesignationFirstRep

public ValueSet.ConceptReferenceDesignationComponent getDesignationFirstRep()

Returns:

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

getProperty

public List<ValueSet.ConceptPropertyComponent> getProperty()

Returns:

property (A property value for this concept.)

setProperty

public ValueSet.ValueSetExpansionContainsComponent setProperty(List<ValueSet.ConceptPropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public ValueSet.ConceptPropertyComponent addProperty()

addProperty

public ValueSet.ValueSetExpansionContainsComponent addProperty(ValueSet.ConceptPropertyComponent t)

getPropertyFirstRep

public ValueSet.ConceptPropertyComponent getPropertyFirstRep()

Returns:

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

getContains

public List<ValueSet.ValueSetExpansionContainsComponent> getContains()

Returns:

contains (Other codes and entries contained under this entry in the hierarchy.)

setContains

public ValueSet.ValueSetExpansionContainsComponent setContains(List<ValueSet.ValueSetExpansionContainsComponent> theContains)

Returns:

Returns a reference to this for easy method chaining

hasContains

public boolean hasContains()

addContains

public ValueSet.ValueSetExpansionContainsComponent addContains()

addContains

public ValueSet.ValueSetExpansionContainsComponent addContains(ValueSet.ValueSetExpansionContainsComponent t)

getContainsFirstRep

public ValueSet.ValueSetExpansionContainsComponent getContainsFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

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

Overrides:

getNamedProperty in class BackboneElement

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 BackboneElement

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 BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public ValueSet.ValueSetExpansionContainsComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ValueSet.ValueSetExpansionContainsComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class BackboneElement

Returns:

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