Package org.hl7.fhir.r5.model

Class ValueSet.ValueSetExpansionComponent

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.ValueSetExpansionComponent

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.ValueSetExpansionComponent
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 List<ValueSet.ValueSetExpansionContainsComponent>	contains	The codes that are contained in the value set expansion.
protected UriType	identifier	An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc.
protected UriType	next	As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.
protected IntegerType	offset	If paging is being used, the offset at which this resource starts.
protected List<ValueSet.ValueSetExpansionParameterComponent>	parameter	A parameter that controlled the expansion process.
protected List<ValueSet.ValueSetExpansionPropertyComponent>	property	A property defines an additional slot through which additional information can be provided about a concept.
protected DateTimeType	timestamp	The time at which the expansion was produced by the expanding system.
protected IntegerType	total	The total number of concepts in the expansion.

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
ValueSetExpansionComponent()	Constructor
ValueSetExpansionComponent(Date timestamp)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ValueSet.ValueSetExpansionContainsComponent	addContains()
ValueSet.ValueSetExpansionComponent	addContains(ValueSet.ValueSetExpansionContainsComponent t)
ValueSet.ValueSetExpansionParameterComponent	addParameter()
void	addParameter(String name, DataType value)
ValueSet.ValueSetExpansionComponent	addParameter(ValueSet.ValueSetExpansionParameterComponent t)
ValueSet.ValueSetExpansionPropertyComponent	addProperty()
ValueSet.ValueSetExpansionComponent	addProperty(ValueSet.ValueSetExpansionPropertyComponent t)
ValueSet.ValueSetExpansionComponent	copy()
void	copyValues(ValueSet.ValueSetExpansionComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ValueSet.ValueSetExpansionContainsComponent>	getContains()
ValueSet.ValueSetExpansionContainsComponent	getContainsFirstRep()
String	getIdentifier()
UriType	getIdentifierElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getNext()
UriType	getNextElement()
int	getOffset()
IntegerType	getOffsetElement()
List<ValueSet.ValueSetExpansionParameterComponent>	getParameter()
ValueSet.ValueSetExpansionParameterComponent	getParameterFirstRep()
List<ValueSet.ValueSetExpansionPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
ValueSet.ValueSetExpansionPropertyComponent	getPropertyFirstRep()
Date	getTimestamp()
DateTimeType	getTimestampElement()
int	getTotal()
IntegerType	getTotalElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasContains()
boolean	hasIdentifier()
boolean	hasIdentifierElement()
boolean	hasNext()
boolean	hasNextElement()
boolean	hasOffset()
boolean	hasOffsetElement()
boolean	hasParameter()
boolean	hasParameterValue(String name, String value)
boolean	hasProperty()
boolean	hasTimestamp()
boolean	hasTimestampElement()
boolean	hasTotal()
boolean	hasTotalElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ValueSet.ValueSetExpansionComponent	setContains(List<ValueSet.ValueSetExpansionContainsComponent> theContains)
ValueSet.ValueSetExpansionComponent	setIdentifier(String value)
ValueSet.ValueSetExpansionComponent	setIdentifierElement(UriType value)
ValueSet.ValueSetExpansionComponent	setNext(String value)
ValueSet.ValueSetExpansionComponent	setNextElement(UriType value)
ValueSet.ValueSetExpansionComponent	setOffset(int value)
ValueSet.ValueSetExpansionComponent	setOffsetElement(IntegerType value)
ValueSet.ValueSetExpansionComponent	setParameter(List<ValueSet.ValueSetExpansionParameterComponent> theParameter)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ValueSet.ValueSetExpansionComponent	setProperty(List<ValueSet.ValueSetExpansionPropertyComponent> theProperty)
ValueSet.ValueSetExpansionComponent	setTimestamp(Date value)
ValueSet.ValueSetExpansionComponent	setTimestampElement(DateTimeType value)
ValueSet.ValueSetExpansionComponent	setTotal(int value)
ValueSet.ValueSetExpansionComponent	setTotalElement(IntegerType 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

identifier

protected UriType identifier

An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

next

protected UriType next

As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.

timestamp

protected DateTimeType timestamp

The time at which the expansion was produced by the expanding system.

total

protected IntegerType total

The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

offset

protected IntegerType offset

If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.

parameter

protected List<ValueSet.ValueSetExpansionParameterComponent> parameter

A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.

property

protected List<ValueSet.ValueSetExpansionPropertyComponent> property

A property defines an additional slot through which additional information can be provided about a concept.

contains

protected List<ValueSet.ValueSetExpansionContainsComponent> contains

The codes that are contained in the value set expansion.

Constructor Details

ValueSetExpansionComponent

public ValueSetExpansionComponent()

Constructor

ValueSetExpansionComponent

public ValueSetExpansionComponent(Date timestamp)

Constructor

Method Details

getIdentifierElement

public UriType getIdentifierElement()

Returns:

identifier (An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.). This is the underlying object with id, value and extensions. The accessor "getIdentifier" gives direct access to the value

hasIdentifierElement

public boolean hasIdentifierElement()

hasIdentifier

public boolean hasIdentifier()

setIdentifierElement

public ValueSet.ValueSetExpansionComponent setIdentifierElement(UriType value)

Parameters:

value - identifier (An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.). This is the underlying object with id, value and extensions. The accessor "getIdentifier" gives direct access to the value

getIdentifier

public String getIdentifier()

Returns:

An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

setIdentifier

public ValueSet.ValueSetExpansionComponent setIdentifier(String value)

Parameters:

value - An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.

getNextElement

public UriType getNextElement()

Returns:

next (As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.). This is the underlying object with id, value and extensions. The accessor "getNext" gives direct access to the value

hasNextElement

public boolean hasNextElement()

hasNext

public boolean hasNext()

setNextElement

public ValueSet.ValueSetExpansionComponent setNextElement(UriType value)

Parameters:

value - next (As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.). This is the underlying object with id, value and extensions. The accessor "getNext" gives direct access to the value

getNext

public String getNext()

Returns:

As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.

setNext

public ValueSet.ValueSetExpansionComponent setNext(String value)

Parameters:

value - As per paging Search results, the next URLs are opaque to the client, have no dictated structure, and only the server understands them.

getTimestampElement

public DateTimeType getTimestampElement()

Returns:

timestamp (The time at which the expansion was produced by the expanding system.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value

hasTimestampElement

public boolean hasTimestampElement()

hasTimestamp

public boolean hasTimestamp()

setTimestampElement

public ValueSet.ValueSetExpansionComponent setTimestampElement(DateTimeType value)

Parameters:

value - timestamp (The time at which the expansion was produced by the expanding system.). This is the underlying object with id, value and extensions. The accessor "getTimestamp" gives direct access to the value

getTimestamp

public Date getTimestamp()

Returns:

The time at which the expansion was produced by the expanding system.

setTimestamp

public ValueSet.ValueSetExpansionComponent setTimestamp(Date value)

Parameters:

value - The time at which the expansion was produced by the expanding system.

getTotalElement

public IntegerType getTotalElement()

Returns:

total (The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.). This is the underlying object with id, value and extensions. The accessor "getTotal" gives direct access to the value

hasTotalElement

public boolean hasTotalElement()

hasTotal

public boolean hasTotal()

setTotalElement

public ValueSet.ValueSetExpansionComponent setTotalElement(IntegerType value)

Parameters:

value - total (The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.). This is the underlying object with id, value and extensions. The accessor "getTotal" gives direct access to the value

getTotal

public int getTotal()

Returns:

The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

setTotal

public ValueSet.ValueSetExpansionComponent setTotal(int value)

Parameters:

value - The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.

getOffsetElement

public IntegerType getOffsetElement()

Returns:

offset (If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.). This is the underlying object with id, value and extensions. The accessor "getOffset" gives direct access to the value

hasOffsetElement

public boolean hasOffsetElement()

hasOffset

public boolean hasOffset()

setOffsetElement

public ValueSet.ValueSetExpansionComponent setOffsetElement(IntegerType value)

Parameters:

value - offset (If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.). This is the underlying object with id, value and extensions. The accessor "getOffset" gives direct access to the value

getOffset

public int getOffset()

Returns:

If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.

setOffset

public ValueSet.ValueSetExpansionComponent setOffset(int value)

Parameters:

value - If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.

getParameter

public List<ValueSet.ValueSetExpansionParameterComponent> getParameter()

Returns:

parameter (A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.)

setParameter

public ValueSet.ValueSetExpansionComponent setParameter(List<ValueSet.ValueSetExpansionParameterComponent> theParameter)

Returns:

Returns a reference to this for easy method chaining

hasParameter

public boolean hasParameter()

addParameter

public ValueSet.ValueSetExpansionParameterComponent addParameter()

addParameter

public ValueSet.ValueSetExpansionComponent addParameter(ValueSet.ValueSetExpansionParameterComponent t)

getParameterFirstRep

public ValueSet.ValueSetExpansionParameterComponent getParameterFirstRep()

Returns:

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

getProperty

public List<ValueSet.ValueSetExpansionPropertyComponent> getProperty()

Returns:

property (A property defines an additional slot through which additional information can be provided about a concept.)

setProperty

public ValueSet.ValueSetExpansionComponent setProperty(List<ValueSet.ValueSetExpansionPropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public ValueSet.ValueSetExpansionPropertyComponent addProperty()

addProperty

public ValueSet.ValueSetExpansionComponent addProperty(ValueSet.ValueSetExpansionPropertyComponent t)

getPropertyFirstRep

public ValueSet.ValueSetExpansionPropertyComponent 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 (The codes that are contained in the value set expansion.)

setContains

public ValueSet.ValueSetExpansionComponent 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.ValueSetExpansionComponent 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.ValueSetExpansionComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(ValueSet.ValueSetExpansionComponent 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

hasParameterValue

public boolean hasParameterValue(String name,
 String value)

addParameter

public void addParameter(String name,
 DataType value)

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)