Package com.ibm.fhir.model.type

Class DataRequirement.Builder

    • Method Detail

      • id

        public DataRequirement.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class Element.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public DataRequirement.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public DataRequirement.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class Element.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • type

        public DataRequirement.Builder type​(FHIRAllTypes type)
        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.

        This element is required.

        Parameters:
        type - The type of the required data
        Returns:
        A reference to this Builder instance

      • profile

        public DataRequirement.Builder profile​(Canonical... profile)
        The profile of the required data, specified as the uri of the profile definition.

        Adds new element(s) to the existing list

        Parameters:
        profile - The profile of the required data
        Returns:
        A reference to this Builder instance

      • profile

        public DataRequirement.Builder profile​(Collection<Canonical> profile)
        The profile of the required data, specified as the uri of the profile definition.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        profile - The profile of the required data
        Returns:
        A reference to this Builder instance

      • subject

        public DataRequirement.Builder subject​(Element subject)
        The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

        This is a choice element with the following allowed types:

        When of type Reference, the allowed resource types for this reference are:
        • Group
        Parameters:
        subject - E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
        Returns:
        A reference to this Builder instance

      • mustSupport

        public DataRequirement.Builder mustSupport​(String... mustSupport)
        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).

        Adds new element(s) to the existing list

        Parameters:
        mustSupport - Indicates specific structure elements that are referenced by the knowledge module
        Returns:
        A reference to this Builder instance

      • mustSupport

        public DataRequirement.Builder mustSupport​(Collection<String> mustSupport)
        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).

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        mustSupport - Indicates specific structure elements that are referenced by the knowledge module
        Returns:
        A reference to this Builder instance

      • codeFilter

        public DataRequirement.Builder codeFilter​(DataRequirement.CodeFilter... codeFilter)
        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.

        Adds new element(s) to the existing list

        Parameters:
        codeFilter - What codes are expected
        Returns:
        A reference to this Builder instance

      • codeFilter

        public DataRequirement.Builder codeFilter​(Collection<DataRequirement.CodeFilter> codeFilter)
        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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        codeFilter - What codes are expected
        Returns:
        A reference to this Builder instance

      • dateFilter

        public DataRequirement.Builder dateFilter​(DataRequirement.DateFilter... dateFilter)
        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.

        Adds new element(s) to the existing list

        Parameters:
        dateFilter - What dates/date ranges are expected
        Returns:
        A reference to this Builder instance

      • dateFilter

        public DataRequirement.Builder dateFilter​(Collection<DataRequirement.DateFilter> dateFilter)
        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.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        dateFilter - What dates/date ranges are expected
        Returns:
        A reference to this Builder instance

      • limit

        public DataRequirement.Builder limit​(PositiveInt limit)
        Specifies a maximum number of results that are required (uses the _count search parameter).
        Parameters:
        limit - Number of results
        Returns:
        A reference to this Builder instance

      • sort

        public DataRequirement.Builder sort​(DataRequirement.Sort... sort)
        Specifies the order of the results to be returned.

        Adds new element(s) to the existing list

        Parameters:
        sort - Order of the results
        Returns:
        A reference to this Builder instance

      • sort

        public DataRequirement.Builder sort​(Collection<DataRequirement.Sort> sort)
        Specifies the order of the results to be returned.

        Replaces the existing list with a new one containing elements from the Collection

        Parameters:
        sort - Order of the results
        Returns:
        A reference to this Builder instance