Package com.ibm.fhir.model.type

Class DataRequirement

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class DataRequirement
extends Element
    Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

    • Method Detail

      • getType

        public FHIRAllTypes getType()
        The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
        Returns:
        An immutable object of type FHIRAllTypes that is non-null.

      • getProfile

        public List<Canonical> getProfile()
        The profile of the required data, specified as the uri of the profile definition.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.

      • getSubject

        public Element getSubject()
        The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
        Returns:
        An immutable object of type Element that may be null.

      • getMustSupport

        public List<String> getMustSupport()
        Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

        The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).

        Returns:
        An unmodifiable list containing immutable objects of type String that may be empty.

      • getCodeFilter

        public List<DataRequirement.CodeFilter> getCodeFilter()
        Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
        Returns:
        An unmodifiable list containing immutable objects of type DataRequirement.CodeFilter that may be empty.

      • getDateFilter

        public List<DataRequirement.DateFilter> getDateFilter()
        Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
        Returns:
        An unmodifiable list containing immutable objects of type DataRequirement.DateFilter that may be empty.

      • getLimit

        public PositiveInt getLimit()
        Specifies a maximum number of results that are required (uses the _count search parameter).
        Returns:
        An immutable object of type PositiveInt that may be null.

      • 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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object