Class ValueSet.Compose
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.ValueSet.Compose
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- ValueSet
public static class ValueSet.Compose extends BackboneElement
A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ValueSet.Compose.Builder
static class
ValueSet.Compose.Include
Include one or more codes from a code system or other value set(s).
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ValueSet.Compose.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<ValueSet.Compose.Include>
getExclude()
Exclude one or more codes from the value set based on code system filters and/or other value sets.Boolean
getInactive()
Whether inactive codes - codes that are not approved for current use - are in the value set.java.util.List<ValueSet.Compose.Include>
getInclude()
Include one or more codes from a code system or other value set(s).Date
getLockedDate()
The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.boolean
hasChildren()
int
hashCode()
ValueSet.Compose.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getLockedDate
public Date getLockedDate()
The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.- Returns:
- An immutable object of type
Date
that may be null.
-
getInactive
public Boolean getInactive()
Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).- Returns:
- An immutable object of type
Boolean
that may be null.
-
getInclude
public java.util.List<ValueSet.Compose.Include> getInclude()
Include one or more codes from a code system or other value set(s).- Returns:
- An unmodifiable list containing immutable objects of type
ValueSet.Compose.Include
that is non-empty.
-
getExclude
public java.util.List<ValueSet.Compose.Include> getExclude()
Exclude one or more codes from the value set based on code system filters and/or other value sets.- Returns:
- An unmodifiable list containing immutable objects of type
ValueSet.Compose.Include
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ValueSet.Compose.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static ValueSet.Compose.Builder builder()
-
-