Package com.ibm.fhir.model.resource

Class ValueSet.Compose

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.BackboneElement

com.ibm.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 com.ibm.fhir.model.type.BackboneElement

modifierExtension

Fields inherited from class com.ibm.fhir.model.type.Element

extension, hashCode, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static ValueSet.Compose.Builder	builder()
boolean	equals(Object obj)
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.
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 com.ibm.fhir.model.type.BackboneElement

getModifierExtension

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

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 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 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 class BackboneElement

accept

public void accept(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 interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class 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 class BackboneElement

builder

public static ValueSet.Compose.Builder builder()