Package org.linuxforhealth.fhir.model.resource

Class CapabilityStatement.Rest.Resource.Builder

    • Method Detail

      • id

        public CapabilityStatement.Rest.Resource.Builder id​(java.lang.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 BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public CapabilityStatement.Rest.Resource.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. If any of the elements are null, calling build() will fail.

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

      • extension

        public CapabilityStatement.Rest.Resource.Builder extension​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public CapabilityStatement.Rest.Resource.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public CapabilityStatement.Rest.Resource.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • profile

        public CapabilityStatement.Rest.Resource.Builder profile​(Canonical profile)
        A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles] (profiling.html#profile-uses).
        Parameters:
        profile - Base System profile for all uses of resource
        Returns:
        A reference to this Builder instance

      • supportedProfile

        public CapabilityStatement.Rest.Resource.Builder supportedProfile​(Canonical... supportedProfile)
        A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        supportedProfile - Profiles for use cases supported
        Returns:
        A reference to this Builder instance

      • supportedProfile

        public CapabilityStatement.Rest.Resource.Builder supportedProfile​(java.util.Collection<Canonical> supportedProfile)
        A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        supportedProfile - Profiles for use cases supported
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • documentation

        public CapabilityStatement.Rest.Resource.Builder documentation​(Markdown documentation)
        Additional information about the resource type used by the system.
        Parameters:
        documentation - Additional information about the use of the resource type
        Returns:
        A reference to this Builder instance

      • interaction

        public CapabilityStatement.Rest.Resource.Builder interaction​(java.util.Collection<CapabilityStatement.Rest.Resource.Interaction> interaction)
        Identifies a restful operation supported by the solution.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        interaction - What operations are supported?
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • versioning

        public CapabilityStatement.Rest.Resource.Builder versioning​(ResourceVersionPolicy versioning)
        This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
        Parameters:
        versioning - no-version | versioned | versioned-update
        Returns:
        A reference to this Builder instance

      • readHistory

        public CapabilityStatement.Rest.Resource.Builder readHistory​(Boolean readHistory)
        A flag for whether the server is able to return past versions as part of the vRead operation.
        Parameters:
        readHistory - Whether vRead can return past versions
        Returns:
        A reference to this Builder instance

      • updateCreate

        public CapabilityStatement.Rest.Resource.Builder updateCreate​(Boolean updateCreate)
        A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
        Parameters:
        updateCreate - If update can commit to a new identity
        Returns:
        A reference to this Builder instance

      • conditionalCreate

        public CapabilityStatement.Rest.Resource.Builder conditionalCreate​(Boolean conditionalCreate)
        A flag that indicates that the server supports conditional create.
        Parameters:
        conditionalCreate - If allows/uses conditional create
        Returns:
        A reference to this Builder instance

      • conditionalRead

        public CapabilityStatement.Rest.Resource.Builder conditionalRead​(ConditionalReadStatus conditionalRead)
        A code that indicates how the server supports conditional read.
        Parameters:
        conditionalRead - not-supported | modified-since | not-match | full-support
        Returns:
        A reference to this Builder instance

      • conditionalUpdate

        public CapabilityStatement.Rest.Resource.Builder conditionalUpdate​(Boolean conditionalUpdate)
        A flag that indicates that the server supports conditional update.
        Parameters:
        conditionalUpdate - If allows/uses conditional update
        Returns:
        A reference to this Builder instance

      • conditionalDelete

        public CapabilityStatement.Rest.Resource.Builder conditionalDelete​(ConditionalDeleteStatus conditionalDelete)
        A code that indicates how the server supports conditional delete.
        Parameters:
        conditionalDelete - not-supported | single | multiple - how conditional delete is supported
        Returns:
        A reference to this Builder instance

      • referencePolicy

        public CapabilityStatement.Rest.Resource.Builder referencePolicy​(ReferenceHandlingPolicy... referencePolicy)
        A set of flags that defines how references are supported.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        referencePolicy - literal | logical | resolves | enforced | local
        Returns:
        A reference to this Builder instance

      • referencePolicy

        public CapabilityStatement.Rest.Resource.Builder referencePolicy​(java.util.Collection<ReferenceHandlingPolicy> referencePolicy)
        A set of flags that defines how references are supported.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        referencePolicy - literal | logical | resolves | enforced | local
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • searchInclude

        public CapabilityStatement.Rest.Resource.Builder searchInclude​(java.lang.String... searchInclude)
        Convenience method for setting searchInclude.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        searchInclude - _include values supported by the server
        Returns:
        A reference to this Builder instance
        See Also:
        #searchInclude(org.linuxforhealth.fhir.model.type.String)

      • searchInclude

        public CapabilityStatement.Rest.Resource.Builder searchInclude​(String... searchInclude)
        A list of _include values supported by the server.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        searchInclude - _include values supported by the server
        Returns:
        A reference to this Builder instance

      • searchInclude

        public CapabilityStatement.Rest.Resource.Builder searchInclude​(java.util.Collection<String> searchInclude)
        A list of _include values supported by the server.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        searchInclude - _include values supported by the server
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • searchRevInclude

        public CapabilityStatement.Rest.Resource.Builder searchRevInclude​(java.lang.String... searchRevInclude)
        Convenience method for setting searchRevInclude.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        searchRevInclude - _revinclude values supported by the server
        Returns:
        A reference to this Builder instance
        See Also:
        #searchRevInclude(org.linuxforhealth.fhir.model.type.String)

      • searchRevInclude

        public CapabilityStatement.Rest.Resource.Builder searchRevInclude​(String... searchRevInclude)
        A list of _revinclude (reverse include) values supported by the server.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        searchRevInclude - _revinclude values supported by the server
        Returns:
        A reference to this Builder instance

      • searchRevInclude

        public CapabilityStatement.Rest.Resource.Builder searchRevInclude​(java.util.Collection<String> searchRevInclude)
        A list of _revinclude (reverse include) values supported by the server.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        searchRevInclude - _revinclude values supported by the server
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • searchParam

        public CapabilityStatement.Rest.Resource.Builder searchParam​(CapabilityStatement.Rest.Resource.SearchParam... searchParam)
        Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        searchParam - Search parameters supported by implementation
        Returns:
        A reference to this Builder instance

      • searchParam

        public CapabilityStatement.Rest.Resource.Builder searchParam​(java.util.Collection<CapabilityStatement.Rest.Resource.SearchParam> searchParam)
        Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        searchParam - Search parameters supported by implementation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • operation

        public CapabilityStatement.Rest.Resource.Builder operation​(CapabilityStatement.Rest.Resource.Operation... operation)
        Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        operation - Definition of a resource operation
        Returns:
        A reference to this Builder instance

      • operation

        public CapabilityStatement.Rest.Resource.Builder operation​(java.util.Collection<CapabilityStatement.Rest.Resource.Operation> operation)
        Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        operation - Definition of a resource operation
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null