Package org.cqframework.cql.elm.execution

Class Retrieve

  • All Implemented Interfaces:
    org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
    Direct Known Subclasses:
    RetrieveEvaluator
    public class Retrieve
extends Expression
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
    The retrieve expression defines clinical data that will be used by the artifact. This expression allows clinically relevant filtering criteria to be provided in a well-defined and computable way. This operation defines the integration boundary for artifacts. The result of a retrieve is defined to return the same data for subsequent invocations within the same evaluation request. This means in particular that patient data updates made during the evaluation request are not visible to the artifact. In effect, the patient data is a snapshot of the data as of the start of the evaluation. This ensures strict deterministic and functional behavior of the artifact, and allows the implementation engine freedom to cache intermediate results in order to improve performance.

    Java class for Retrieve complex type.

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

     <complexType name="Retrieve">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}Expression">
       <sequence>
         <element name="id" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="codes" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="dateRange" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="context" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="include" type="{urn:hl7-org:elm:r1}IncludeElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="codeFilter" type="{urn:hl7-org:elm:r1}CodeFilterElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="dateFilter" type="{urn:hl7-org:elm:r1}DateFilterElement" maxOccurs="unbounded" minOccurs="0"/>
         <element name="otherFilter" type="{urn:hl7-org:elm:r1}OtherFilterElement" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="dataType" use="required" type="{http://www.w3.org/2001/XMLSchema}QName" />
       <attribute name="templateId" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="idProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="idSearch" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="contextProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="contextSearch" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="codeProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="codeSearch" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="codeComparator" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="valueSetProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dateProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dateLowProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dateHighProperty" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="dateSearch" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="includedIn" type="{http://www.w3.org/2001/XMLSchema}string" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • dataType

        protected javax.xml.namespace.QName dataType

      • templateId

        protected java.lang.String templateId

      • idProperty

        protected java.lang.String idProperty

      • idSearch

        protected java.lang.String idSearch

      • contextProperty

        protected java.lang.String contextProperty

      • contextSearch

        protected java.lang.String contextSearch

      • codeProperty

        protected java.lang.String codeProperty

      • codeSearch

        protected java.lang.String codeSearch

      • codeComparator

        protected java.lang.String codeComparator

      • valueSetProperty

        protected java.lang.String valueSetProperty

      • dateProperty

        protected java.lang.String dateProperty

      • dateLowProperty

        protected java.lang.String dateLowProperty

      • dateHighProperty

        protected java.lang.String dateHighProperty

      • dateSearch

        protected java.lang.String dateSearch

      • includedIn

        protected java.lang.String includedIn

    • Constructor Detail

      • Retrieve

        public Retrieve()

    • Method Detail

      • getId

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

      • setId

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

      • getCodes

        public Expression getCodes()
        Gets the value of the codes property.
        Returns:
        possible object is Expression

      • setCodes

        public void setCodes​(Expression value)
        Sets the value of the codes property.
        Parameters:
        value - allowed object is Expression

      • getDateRange

        public Expression getDateRange()
        Gets the value of the dateRange property.
        Returns:
        possible object is Expression

      • setDateRange

        public void setDateRange​(Expression value)
        Sets the value of the dateRange property.
        Parameters:
        value - allowed object is Expression

      • getContext

        public Expression getContext()
        Gets the value of the context property.
        Returns:
        possible object is Expression

      • setContext

        public void setContext​(Expression value)
        Sets the value of the context property.
        Parameters:
        value - allowed object is Expression

      • getInclude

        public java.util.List<IncludeElement> getInclude()
        Gets the value of the include 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 include property.

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

            getInclude().add(newItem);

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

      • getCodeFilter

        public java.util.List<CodeFilterElement> getCodeFilter()
        Gets the value of the codeFilter 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 codeFilter property.

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

            getCodeFilter().add(newItem);

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

      • getDateFilter

        public java.util.List<DateFilterElement> getDateFilter()
        Gets the value of the dateFilter 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 dateFilter property.

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

            getDateFilter().add(newItem);

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

      • getOtherFilter

        public java.util.List<OtherFilterElement> getOtherFilter()
        Gets the value of the otherFilter 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 otherFilter property.

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

            getOtherFilter().add(newItem);

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

      • getDataType

        public javax.xml.namespace.QName getDataType()
        Gets the value of the dataType property.
        Returns:
        possible object is QName

      • setDataType

        public void setDataType​(javax.xml.namespace.QName value)
        Sets the value of the dataType property.
        Parameters:
        value - allowed object is QName

      • getTemplateId

        public java.lang.String getTemplateId()
        Gets the value of the templateId property.
        Returns:
        possible object is String

      • setTemplateId

        public void setTemplateId​(java.lang.String value)
        Sets the value of the templateId property.
        Parameters:
        value - allowed object is String

      • getIdProperty

        public java.lang.String getIdProperty()
        Gets the value of the idProperty property.
        Returns:
        possible object is String

      • setIdProperty

        public void setIdProperty​(java.lang.String value)
        Sets the value of the idProperty property.
        Parameters:
        value - allowed object is String

      • getIdSearch

        public java.lang.String getIdSearch()
        Gets the value of the idSearch property.
        Returns:
        possible object is String

      • setIdSearch

        public void setIdSearch​(java.lang.String value)
        Sets the value of the idSearch property.
        Parameters:
        value - allowed object is String

      • getContextProperty

        public java.lang.String getContextProperty()
        Gets the value of the contextProperty property.
        Returns:
        possible object is String

      • setContextProperty

        public void setContextProperty​(java.lang.String value)
        Sets the value of the contextProperty property.
        Parameters:
        value - allowed object is String

      • getContextSearch

        public java.lang.String getContextSearch()
        Gets the value of the contextSearch property.
        Returns:
        possible object is String

      • setContextSearch

        public void setContextSearch​(java.lang.String value)
        Sets the value of the contextSearch property.
        Parameters:
        value - allowed object is String

      • getCodeProperty

        public java.lang.String getCodeProperty()
        Gets the value of the codeProperty property.
        Returns:
        possible object is String

      • setCodeProperty

        public void setCodeProperty​(java.lang.String value)
        Sets the value of the codeProperty property.
        Parameters:
        value - allowed object is String

      • getCodeSearch

        public java.lang.String getCodeSearch()
        Gets the value of the codeSearch property.
        Returns:
        possible object is String

      • setCodeSearch

        public void setCodeSearch​(java.lang.String value)
        Sets the value of the codeSearch property.
        Parameters:
        value - allowed object is String

      • getCodeComparator

        public java.lang.String getCodeComparator()
        Gets the value of the codeComparator property.
        Returns:
        possible object is String

      • setCodeComparator

        public void setCodeComparator​(java.lang.String value)
        Sets the value of the codeComparator property.
        Parameters:
        value - allowed object is String

      • getValueSetProperty

        public java.lang.String getValueSetProperty()
        Gets the value of the valueSetProperty property.
        Returns:
        possible object is String

      • setValueSetProperty

        public void setValueSetProperty​(java.lang.String value)
        Sets the value of the valueSetProperty property.
        Parameters:
        value - allowed object is String

      • getDateProperty

        public java.lang.String getDateProperty()
        Gets the value of the dateProperty property.
        Returns:
        possible object is String

      • setDateProperty

        public void setDateProperty​(java.lang.String value)
        Sets the value of the dateProperty property.
        Parameters:
        value - allowed object is String

      • getDateLowProperty

        public java.lang.String getDateLowProperty()
        Gets the value of the dateLowProperty property.
        Returns:
        possible object is String

      • setDateLowProperty

        public void setDateLowProperty​(java.lang.String value)
        Sets the value of the dateLowProperty property.
        Parameters:
        value - allowed object is String

      • getDateHighProperty

        public java.lang.String getDateHighProperty()
        Gets the value of the dateHighProperty property.
        Returns:
        possible object is String

      • setDateHighProperty

        public void setDateHighProperty​(java.lang.String value)
        Sets the value of the dateHighProperty property.
        Parameters:
        value - allowed object is String

      • getDateSearch

        public java.lang.String getDateSearch()
        Gets the value of the dateSearch property.
        Returns:
        possible object is String

      • setDateSearch

        public void setDateSearch​(java.lang.String value)
        Sets the value of the dateSearch property.
        Parameters:
        value - allowed object is String

      • getIncludedIn

        public java.lang.String getIncludedIn()
        Gets the value of the includedIn property.
        Returns:
        possible object is String

      • setIncludedIn

        public void setIncludedIn​(java.lang.String value)
        Sets the value of the includedIn property.
        Parameters:
        value - allowed object is String

      • withDataType

        public Retrieve withDataType​(javax.xml.namespace.QName value)

      • withTemplateId

        public Retrieve withTemplateId​(java.lang.String value)

      • withIdProperty

        public Retrieve withIdProperty​(java.lang.String value)

      • withIdSearch

        public Retrieve withIdSearch​(java.lang.String value)

      • withContextProperty

        public Retrieve withContextProperty​(java.lang.String value)

      • withContextSearch

        public Retrieve withContextSearch​(java.lang.String value)

      • withCodeProperty

        public Retrieve withCodeProperty​(java.lang.String value)

      • withCodeSearch

        public Retrieve withCodeSearch​(java.lang.String value)

      • withCodeComparator

        public Retrieve withCodeComparator​(java.lang.String value)

      • withValueSetProperty

        public Retrieve withValueSetProperty​(java.lang.String value)

      • withDateProperty

        public Retrieve withDateProperty​(java.lang.String value)

      • withDateLowProperty

        public Retrieve withDateLowProperty​(java.lang.String value)

      • withDateHighProperty

        public Retrieve withDateHighProperty​(java.lang.String value)

      • withDateSearch

        public Retrieve withDateSearch​(java.lang.String value)

      • withIncludedIn

        public Retrieve withIncludedIn​(java.lang.String value)

      • equals

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

      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class Expression

      • 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 Expression

      • append

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

      • appendFields

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