Package org.cqframework.cql.elm.execution

Class ValueSetDef

java.lang.Object
org.opencds.cqf.cql.engine.elm.execution.Executable
org.cqframework.cql.elm.execution.Element
org.cqframework.cql.elm.execution.ValueSetDef
All Implemented Interfaces:
org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
public class ValueSetDef extends Element implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
The ValueSetDef type defines a value set identifier that can be referenced by name anywhere within an expression. The id specifies the globally unique identifier for the value set. This may be an HL7 OID, a FHIR URL, or a CTS2 value set URL. If version is specified, it will be used to resolve the version of the value set definition to be used. Otherwise, the most current published version of the value set is assumed. If codeSystems are specified, they will be used to resolve the code systems used within the value set definition to construct the expansion set. Note that the recommended approach to statically binding to an expansion set is to use a value set definition that specifies the version of each code system used. The codeSystemVersions attribute is provided only to ensure static binding can be achieved when the value set definition does not specify code system versions as part of the definition header.

Java class for ValueSetDef complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="ValueSetDef">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}Element">
       <sequence>
         <element name="codeSystem" type="{urn:hl7-org:elm:r1}CodeSystemRef" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="accessLevel" type="{urn:hl7-org:elm:r1}AccessModifier" default="Public" />
     </extension>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • ValueSetDef

      public ValueSetDef()

  • Method Details

    • getCodeSystem

      public List<CodeSystemRef> getCodeSystem()
      Gets the value of the codeSystem property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the codeSystem property.

      For example, to add a new item, do as follows: 

          getCodeSystem().add(newItem);

      Objects of the following type(s) are allowed in the list CodeSystemRef

    • getName

      public String getName()
      Gets the value of the name property.
      Returns:
      possible object is String

    • setName

      public void setName(String value)
      Sets the value of the name property.
      Parameters:
      value - allowed object is String

    • getId

      public String getId()
      Gets the value of the id property.
      Returns:
      possible object is String

    • setId

      public void setId(String value)
      Sets the value of the id property.
      Parameters:
      value - allowed object is String

    • getVersion

      public String getVersion()
      Gets the value of the version property.
      Returns:
      possible object is String

    • setVersion

      public void setVersion(String value)
      Sets the value of the version property.
      Parameters:
      value - allowed object is String

    • getAccessLevel

      public AccessModifier getAccessLevel()
      Gets the value of the accessLevel property.
      Returns:
      possible object is AccessModifier

    • setAccessLevel

      public void setAccessLevel(AccessModifier value)
      Sets the value of the accessLevel property.
      Parameters:
      value - allowed object is AccessModifier

    • withCodeSystem

      public ValueSetDef withCodeSystem(CodeSystemRef... values)

    • withCodeSystem

      public ValueSetDef withCodeSystem(Collection<CodeSystemRef> values)

    • withName

      public ValueSetDef withName(String value)

    • withId

      public ValueSetDef withId(String value)

    • withVersion

      public ValueSetDef withVersion(String value)

    • withAccessLevel

      public ValueSetDef withAccessLevel(AccessModifier value)

    • withAnnotation

      public ValueSetDef withAnnotation(CqlToElmBase... values)
      Overrides:
      withAnnotation in class Element

    • withAnnotation

      public ValueSetDef withAnnotation(Collection<CqlToElmBase> values)
      Overrides:
      withAnnotation in class Element

    • withResultTypeSpecifier

      public ValueSetDef withResultTypeSpecifier(TypeSpecifier value)
      Overrides:
      withResultTypeSpecifier in class Element

    • withLocalId

      public ValueSetDef withLocalId(String value)
      Overrides:
      withLocalId in class Element

    • withLocator

      public ValueSetDef withLocator(String value)
      Overrides:
      withLocator in class Element

    • withResultTypeName

      public ValueSetDef withResultTypeName(QName value)
      Overrides:
      withResultTypeName in class Element

    • equals

      public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
      Specified by:
      equals in interface org.jvnet.jaxb2_commons.lang.Equals2
      Overrides:
      equals in class Element

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Element

    • hashCode

      public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
      Specified by:
      hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
      Overrides:
      hashCode in class Element

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Element

    • toString

      public String toString()
      Overrides:
      toString in class Element

    • append

      public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      append in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      append in class Element

    • appendFields

      public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2
      Overrides:
      appendFields in class Element