Package com.babylonhealth.lit.hl7_java.builders

Class CapabilityStatementBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.core.FHIRDateTime date,
            com.babylonhealth.lit.hl7.CAPABILITY_STATEMENT_KIND kind,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.util.Collection<java.lang.String> format,
            com.babylonhealth.lit.hl7.FHIR_VERSION fhirVersion)
        Required fields for CapabilityStatement
        Parameters:
        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.
        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).
        status - - The status of this capability statement. Enables tracking the life-cycle of the content.
        format - - A list of the formats supported by this implementation using their content types.
        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.

    • Method Detail

      • withId

        public CapabilityStatementBuilder.Impl withId​(@NonNull
                                              @NonNull java.lang.String id)
        Parameters:
        id - - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      • withUrl

        public CapabilityStatementBuilder.Impl withUrl​(@NonNull
                                               @NonNull java.lang.String url)
        Parameters:
        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.

      • withMeta

        public CapabilityStatementBuilder.Impl withMeta​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.model.Meta meta)
        Parameters:
        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.

      • withText

        public CapabilityStatementBuilder.Impl withText​(@NonNull
                                                @NonNull com.babylonhealth.lit.hl7.model.Narrative text)
        Parameters:
        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.

      • withName

        public CapabilityStatementBuilder.Impl withName​(@NonNull
                                                @NonNull java.lang.String name)
        Parameters:
        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.

      • withTitle

        public CapabilityStatementBuilder.Impl withTitle​(@NonNull
                                                 @NonNull java.lang.String title)
        Parameters:
        title - - A short, descriptive, user-friendly title for the capability statement.

      • withVersion

        public CapabilityStatementBuilder.Impl withVersion​(@NonNull
                                                   @NonNull java.lang.String version)
        Parameters:
        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.

      • withContact

        public CapabilityStatementBuilder.Impl withContact​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.ContactDetail... contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public CapabilityStatementBuilder.Impl withContact​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.ContactDetail> contact)
        Parameters:
        contact - - Contact details to assist a user in finding and communicating with the publisher.

      • withContact

        public CapabilityStatementBuilder.Impl withContact​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... contact)

      • withPurpose

        public CapabilityStatementBuilder.Impl withPurpose​(@NonNull
                                                   @NonNull java.lang.String purpose)
        Parameters:
        purpose - - Explanation of why this capability statement is needed and why it has been designed as it has.

      • withImports

        public CapabilityStatementBuilder.Impl withImports​(@NonNull
                                                   @NonNull java.lang.String... imports)
        Parameters:
        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.

      • withImports

        public CapabilityStatementBuilder.Impl withImports​(@NonNull
                                                   @NonNull java.util.Collection<java.lang.String> imports)
        Parameters:
        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.

      • withLanguage

        public CapabilityStatementBuilder.Impl withLanguage​(@NonNull
                                                    @NonNull com.babylonhealth.lit.core.LANGUAGES language)
        Parameters:
        language - - The base language in which the resource is written.

      • withContained

        public CapabilityStatementBuilder.Impl withContained​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.Resource... contained)
        Parameters:
        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.

      • withContained

        public CapabilityStatementBuilder.Impl withContained​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Resource> contained)
        Parameters:
        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.

      • withContained

        public CapabilityStatementBuilder.Impl withContained​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public CapabilityStatementBuilder.Impl withExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core.model.Extension... extension)
        Parameters:
        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.

      • withExtension

        public CapabilityStatementBuilder.Impl withExtension​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> extension)
        Parameters:
        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.

      • withExtension

        public CapabilityStatementBuilder.Impl withExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withPublisher

        public CapabilityStatementBuilder.Impl withPublisher​(@NonNull
                                                     @NonNull java.lang.String publisher)
        Parameters:
        publisher - - The name of the organization or individual that published the capability statement.

      • withCopyright

        public CapabilityStatementBuilder.Impl withCopyright​(@NonNull
                                                     @NonNull java.lang.String copyright)
        Parameters:
        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.

      • withUseContext

        public CapabilityStatementBuilder.Impl withUseContext​(@NonNull
                                                      @NonNull com.babylonhealth.lit.core.model.UsageContext... useContext)
        Parameters:
        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.

      • withUseContext

        public CapabilityStatementBuilder.Impl withUseContext​(@NonNull
                                                      @NonNull java.util.Collection<com.babylonhealth.lit.core.model.UsageContext> useContext)
        Parameters:
        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.

      • withUseContext

        public CapabilityStatementBuilder.Impl withUseContext​(@NonNull
                                                      @NonNull com.babylonhealth.lit.core_java.builders.UsageContextBuilder... useContext)

      • withDescription

        public CapabilityStatementBuilder.Impl withDescription​(@NonNull
                                                       @NonNull java.lang.String description)
        Parameters:
        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.

      • withPatchFormat

        public CapabilityStatementBuilder.Impl withPatchFormat​(@NonNull
                                                       @NonNull java.lang.String... patchFormat)
        Parameters:
        patchFormat - - A list of the patch formats supported by this implementation using their content types.

      • withPatchFormat

        public CapabilityStatementBuilder.Impl withPatchFormat​(@NonNull
                                                       @NonNull java.util.Collection<java.lang.String> patchFormat)
        Parameters:
        patchFormat - - A list of the patch formats supported by this implementation using their content types.

      • withExperimental

        public CapabilityStatementBuilder.Impl withExperimental​(@NonNull
                                                        @NonNull java.lang.Boolean experimental)
        Parameters:
        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.

      • withJurisdiction

        public CapabilityStatementBuilder.Impl withJurisdiction​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core.model.CodeableConcept... jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the capability statement is intended to be used.

      • withJurisdiction

        public CapabilityStatementBuilder.Impl withJurisdiction​(@NonNull
                                                        @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> jurisdiction)
        Parameters:
        jurisdiction - - A legal or geographic region in which the capability statement is intended to be used.

      • withJurisdiction

        public CapabilityStatementBuilder.Impl withJurisdiction​(@NonNull
                                                        @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... jurisdiction)

      • withInstantiates

        public CapabilityStatementBuilder.Impl withInstantiates​(@NonNull
                                                        @NonNull java.lang.String... instantiates)
        Parameters:
        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.

      • withInstantiates

        public CapabilityStatementBuilder.Impl withInstantiates​(@NonNull
                                                        @NonNull java.util.Collection<java.lang.String> instantiates)
        Parameters:
        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.

      • withImplicitRules

        public CapabilityStatementBuilder.Impl withImplicitRules​(@NonNull
                                                         @NonNull java.lang.String implicitRules)
        Parameters:
        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.

      • withModifierExtension

        public CapabilityStatementBuilder.Impl withModifierExtension​(@NonNull
                                                             @NonNull com.babylonhealth.lit.core.model.Extension... modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public CapabilityStatementBuilder.Impl withModifierExtension​(@NonNull
                                                             @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Extension> modifierExtension)
        Parameters:
        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).

      • withModifierExtension

        public CapabilityStatementBuilder.Impl withModifierExtension​(@NonNull
                                                             @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withImplementationGuide

        public CapabilityStatementBuilder.Impl withImplementationGuide​(@NonNull
                                                               @NonNull java.lang.String... implementationGuide)
        Parameters:
        implementationGuide - - A list of implementation guides that the server does (or should) support in their entirety.

      • withImplementationGuide

        public CapabilityStatementBuilder.Impl withImplementationGuide​(@NonNull
                                                               @NonNull java.util.Collection<java.lang.String> implementationGuide)
        Parameters:
        implementationGuide - - A list of implementation guides that the server does (or should) support in their entirety.

      • withSoftware

        public CapabilityStatementBuilder.Impl withSoftware​(@NonNull
                                                    com.babylonhealth.lit.hl7.model.CapabilityStatement.Software software)
        Parameters:
        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.

      • withDocument

        public CapabilityStatementBuilder.Impl withDocument​(@NonNull
                                                    @NonNull com.babylonhealth.lit.hl7.model.CapabilityStatement.Document... document)
        Parameters:
        document - - A document definition.

      • withDocument

        public CapabilityStatementBuilder.Impl withDocument​(@NonNull
                                                    @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.CapabilityStatement.Document> document)
        Parameters:
        document - - A document definition.

      • withImplementation

        public CapabilityStatementBuilder.Impl withImplementation​(@NonNull
                                                          com.babylonhealth.lit.hl7.model.CapabilityStatement.Implementation implementation)
        Parameters:
        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.

      • withRest

        public CapabilityStatementBuilder.Impl withRest​(@NonNull
                                                @NonNull com.babylonhealth.lit.hl7.model.CapabilityStatement.Rest... rest)
        Parameters:
        rest - - A definition of the restful capabilities of the solution, if any.

      • withRest

        public CapabilityStatementBuilder.Impl withRest​(@NonNull
                                                @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.CapabilityStatement.Rest> rest)
        Parameters:
        rest - - A definition of the restful capabilities of the solution, if any.

      • withMessaging

        public CapabilityStatementBuilder.Impl withMessaging​(@NonNull
                                                     @NonNull com.babylonhealth.lit.hl7.model.CapabilityStatement.Messaging... messaging)
        Parameters:
        messaging - - A description of the messaging capabilities of the solution.

      • withMessaging

        public CapabilityStatementBuilder.Impl withMessaging​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.CapabilityStatement.Messaging> messaging)
        Parameters:
        messaging - - A description of the messaging capabilities of the solution.

      • build

        public com.babylonhealth.lit.hl7.model.CapabilityStatement build()
        Specified by:
        build in interface CapabilityStatementBuilder
        Specified by:
        build in interface DomainResourceBuilder
        Specified by:
        build in interface com.babylonhealth.lit.core_java.builders.ResourceBuilder