Package com.ibm.fhir.model.resource

Class CapabilityStatement.Builder

    • Method Detail

      • id

        public CapabilityStatement.Builder id​(String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public CapabilityStatement.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public CapabilityStatement.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • text

        public CapabilityStatement.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public CapabilityStatement.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

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

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public CapabilityStatement.Builder contained​(Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        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:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • extension

        public CapabilityStatement.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public CapabilityStatement.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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 DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • modifierExtension

        public CapabilityStatement.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public CapabilityStatement.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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 DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • url

        public CapabilityStatement.Builder url​(Uri url)
        An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
        Parameters:
        url - Canonical identifier for this capability statement, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • version

        public CapabilityStatement.Builder version​(String version)
        The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Parameters:
        version - Business version of the capability statement
        Returns:
        A reference to this Builder instance

      • name

        public CapabilityStatement.Builder name​(String name)
        A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        Parameters:
        name - Name for this capability statement (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public CapabilityStatement.Builder title​(String title)
        A short, descriptive, user-friendly title for the capability statement.
        Parameters:
        title - Name for this capability statement (human friendly)
        Returns:
        A reference to this Builder instance

      • status

        public CapabilityStatement.Builder status​(PublicationStatus status)
        The status of this capability statement. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public CapabilityStatement.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public CapabilityStatement.Builder date​(DateTime date)
        The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.

        This element is required.

        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public CapabilityStatement.Builder publisher​(String publisher)
        The name of the organization or individual that published the capability statement.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public CapabilityStatement.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

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

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public CapabilityStatement.Builder contact​(Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        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:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • description

        public CapabilityStatement.Builder description​(Markdown description)
        A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
        Parameters:
        description - Natural language description of the capability statement
        Returns:
        A reference to this Builder instance

      • useContext

        public CapabilityStatement.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.

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

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public CapabilityStatement.Builder useContext​(Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.

        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:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • jurisdiction

        public CapabilityStatement.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the capability statement is intended to be used.

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

        Parameters:
        jurisdiction - Intended jurisdiction for capability statement (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public CapabilityStatement.Builder jurisdiction​(Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the capability statement is intended to be used.

        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:
        jurisdiction - Intended jurisdiction for capability statement (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • purpose

        public CapabilityStatement.Builder purpose​(Markdown purpose)
        Explanation of why this capability statement is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this capability statement is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public CapabilityStatement.Builder copyright​(Markdown copyright)
        A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • kind

        public CapabilityStatement.Builder kind​(CapabilityStatementKind kind)
        The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

        This element is required.

        Parameters:
        kind - instance | capability | requirements
        Returns:
        A reference to this Builder instance

      • instantiates

        public CapabilityStatement.Builder instantiates​(Canonical... instantiates)
        Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

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

        Parameters:
        instantiates - Canonical URL of another capability statement this implements
        Returns:
        A reference to this Builder instance

      • instantiates

        public CapabilityStatement.Builder instantiates​(Collection<Canonical> instantiates)
        Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.

        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:
        instantiates - Canonical URL of another capability statement this implements
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • imports

        public CapabilityStatement.Builder imports​(Canonical... imports)
        Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

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

        Parameters:
        imports - Canonical URL of another capability statement this adds to
        Returns:
        A reference to this Builder instance

      • imports

        public CapabilityStatement.Builder imports​(Collection<Canonical> imports)
        Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.

        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:
        imports - Canonical URL of another capability statement this adds to
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • software

        public CapabilityStatement.Builder software​(CapabilityStatement.Software software)
        Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
        Parameters:
        software - Software that is covered by this capability statement
        Returns:
        A reference to this Builder instance

      • implementation

        public CapabilityStatement.Builder implementation​(CapabilityStatement.Implementation implementation)
        Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
        Parameters:
        implementation - If this describes a specific instance
        Returns:
        A reference to this Builder instance

      • fhirVersion

        public CapabilityStatement.Builder fhirVersion​(FHIRVersion fhirVersion)
        The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.

        This element is required.

        Parameters:
        fhirVersion - FHIR Version the system supports
        Returns:
        A reference to this Builder instance

      • format

        public CapabilityStatement.Builder format​(Code... format)
        A list of the formats supported by this implementation using their content types.

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

        This element is required.

        Parameters:
        format - formats supported (xml | json | ttl | mime type)
        Returns:
        A reference to this Builder instance

      • format

        public CapabilityStatement.Builder format​(Collection<Code> format)
        A list of the formats supported by this implementation using their content types.

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

        This element is required.

        Parameters:
        format - formats supported (xml | json | ttl | mime type)
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • patchFormat

        public CapabilityStatement.Builder patchFormat​(Code... patchFormat)
        A list of the patch formats supported by this implementation using their content types.

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

        Parameters:
        patchFormat - Patch formats supported
        Returns:
        A reference to this Builder instance

      • patchFormat

        public CapabilityStatement.Builder patchFormat​(Collection<Code> patchFormat)
        A list of the patch formats supported by this implementation using their content types.

        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:
        patchFormat - Patch formats supported
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • implementationGuide

        public CapabilityStatement.Builder implementationGuide​(Canonical... implementationGuide)
        A list of implementation guides that the server does (or should) support in their entirety.

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

        Parameters:
        implementationGuide - Implementation guides supported
        Returns:
        A reference to this Builder instance

      • implementationGuide

        public CapabilityStatement.Builder implementationGuide​(Collection<Canonical> implementationGuide)
        A list of implementation guides that the server does (or should) support in their entirety.

        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:
        implementationGuide - Implementation guides supported
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • rest

        public CapabilityStatement.Builder rest​(CapabilityStatement.Rest... rest)
        A definition of the restful capabilities of the solution, if any.

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

        Parameters:
        rest - If the endpoint is a RESTful one
        Returns:
        A reference to this Builder instance

      • rest

        public CapabilityStatement.Builder rest​(Collection<CapabilityStatement.Rest> rest)
        A definition of the restful capabilities of the solution, if any.

        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:
        rest - If the endpoint is a RESTful one
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • messaging

        public CapabilityStatement.Builder messaging​(CapabilityStatement.Messaging... messaging)
        A description of the messaging capabilities of the solution.

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

        Parameters:
        messaging - If messaging is supported
        Returns:
        A reference to this Builder instance

      • messaging

        public CapabilityStatement.Builder messaging​(Collection<CapabilityStatement.Messaging> messaging)
        A description of the messaging capabilities of 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:
        messaging - If messaging is supported
        Returns:
        A reference to this Builder instance
        Throws:
        NullPointerException - If the passed collection is null

      • document

        public CapabilityStatement.Builder document​(CapabilityStatement.Document... document)
        A document definition.

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

        Parameters:
        document - Document definition
        Returns:
        A reference to this Builder instance