Package com.babylonhealth.lit.hl7_java.builders

Class TerminologyCapabilitiesBuilder.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)
        Required fields for TerminologyCapabilities
        Parameters:
        date - - The date (and optionally time) when the terminology capabilities 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 terminology capabilities 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 terminology capabilities. Enables tracking the life-cycle of the content.

    • Method Detail

      • withId

        public TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.Impl withUrl​(@NonNull
                                                   @NonNull java.lang.String url)
        Parameters:
        url - - An absolute URI that is used to identify this terminology capabilities 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 terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.

      • withMeta

        public TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.Impl withName​(@NonNull
                                                    @NonNull java.lang.String name)
        Parameters:
        name - - A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      • withTitle

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

      • withVersion

        public TerminologyCapabilitiesBuilder.Impl withVersion​(@NonNull
                                                       @NonNull java.lang.String version)
        Parameters:
        version - - The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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 TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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.

      • withPurpose

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

      • withLanguage

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

      • withContained

        public TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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.

      • withExtension

        public TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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.

      • withPublisher

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

      • withCopyright

        public TerminologyCapabilitiesBuilder.Impl withCopyright​(@NonNull
                                                         @NonNull java.lang.String copyright)
        Parameters:
        copyright - - A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.

      • withUseContext

        public TerminologyCapabilitiesBuilder.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 terminology capabilities instances.

      • withUseContext

        public TerminologyCapabilitiesBuilder.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 terminology capabilities instances.

      • withLockedDate

        public TerminologyCapabilitiesBuilder.Impl withLockedDate​(@NonNull
                                                          @NonNull java.lang.Boolean lockedDate)
        Parameters:
        lockedDate - - Whether the server supports lockedDate.

      • withCodeSearch

        public TerminologyCapabilitiesBuilder.Impl withCodeSearch​(@NonNull
                                                          @NonNull com.babylonhealth.lit.hl7.CODE_SEARCH_SUPPORT codeSearch)
        Parameters:
        codeSearch - - The degree to which the server supports the code search parameter on ValueSet, if it is supported.

      • withDescription

        public TerminologyCapabilitiesBuilder.Impl withDescription​(@NonNull
                                                           @NonNull java.lang.String description)
        Parameters:
        description - - A free text natural language description of the terminology capabilities 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.

      • withExperimental

        public TerminologyCapabilitiesBuilder.Impl withExperimental​(@NonNull
                                                            @NonNull java.lang.Boolean experimental)
        Parameters:
        experimental - - A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

      • withJurisdiction

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withImplicitRules

        public TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.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 TerminologyCapabilitiesBuilder.Impl withModifierExtension​(@NonNull
                                                                 @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... modifierExtension)

      • withClosure

        public TerminologyCapabilitiesBuilder.Impl withClosure​(@NonNull
                                                       com.babylonhealth.lit.hl7.model.TerminologyCapabilities.Closure closure)
        Parameters:
        closure - - Whether the $closure operation is supported.

      • withSoftware

        public TerminologyCapabilitiesBuilder.Impl withSoftware​(@NonNull
                                                        com.babylonhealth.lit.hl7.model.TerminologyCapabilities.Software software)
        Parameters:
        software - - Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.

      • withTranslation

        public TerminologyCapabilitiesBuilder.Impl withTranslation​(@NonNull
                                                           com.babylonhealth.lit.hl7.model.TerminologyCapabilities.Translation translation)
        Parameters:
        translation - - Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.

      • withValidateCode

        public TerminologyCapabilitiesBuilder.Impl withValidateCode​(@NonNull
                                                            com.babylonhealth.lit.hl7.model.TerminologyCapabilities.ValidateCode validateCode)
        Parameters:
        validateCode - - Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.

      • withImplementation

        public TerminologyCapabilitiesBuilder.Impl withImplementation​(@NonNull
                                                              com.babylonhealth.lit.hl7.model.TerminologyCapabilities.Implementation implementation)
        Parameters:
        implementation - - Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.

      • withExpansion

        public TerminologyCapabilitiesBuilder.Impl withExpansion​(@NonNull
                                                         com.babylonhealth.lit.hl7.model.TerminologyCapabilities.Expansion expansion)
        Parameters:
        expansion - - Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.

      • withCodeSystem

        public TerminologyCapabilitiesBuilder.Impl withCodeSystem​(@NonNull
                                                          @NonNull com.babylonhealth.lit.hl7.model.TerminologyCapabilities.CodeSystem... codeSystem)
        Parameters:
        codeSystem - - Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.

      • withCodeSystem

        public TerminologyCapabilitiesBuilder.Impl withCodeSystem​(@NonNull
                                                          @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.TerminologyCapabilities.CodeSystem> codeSystem)
        Parameters:
        codeSystem - - Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.