Package com.babylonhealth.lit.hl7_java.builders

Class ImplementationGuideBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String url,
            java.lang.String name,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.lang.String packageId,
            java.util.Collection<com.babylonhealth.lit.hl7.FHIR_VERSION> fhirVersion)
        Required fields for ImplementationGuide
        Parameters:
        url - - An absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.
        name - - A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        status - - The status of this implementation guide. Enables tracking the life-cycle of the content.
        packageId - - The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.
        fhirVersion - - The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

    • Method Detail

      • withId

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

      • withMeta

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

      • withDate

        public ImplementationGuideBuilder.Impl withDate​(@NonNull
                                                @NonNull com.babylonhealth.lit.core.FHIRDateTime date)
        Parameters:
        date - - The date (and optionally time) when the implementation guide 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 implementation guide changes.

      • withTitle

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

      • withVersion

        public ImplementationGuideBuilder.Impl withVersion​(@NonNull
                                                   @NonNull java.lang.String version)
        Parameters:
        version - - The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 ImplementationGuideBuilder.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 ImplementationGuideBuilder.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 ImplementationGuideBuilder.Impl withContact​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.ContactDetailBuilder... contact)

      • withLicense

        public ImplementationGuideBuilder.Impl withLicense​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.SPDX_LICENSE license)
        Parameters:
        license - - The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.

      • withLanguage

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

      • withContained

        public ImplementationGuideBuilder.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 ImplementationGuideBuilder.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 ImplementationGuideBuilder.Impl withContained​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ResourceBuilder... contained)

      • withExtension

        public ImplementationGuideBuilder.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 ImplementationGuideBuilder.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 ImplementationGuideBuilder.Impl withExtension​(@NonNull
                                                     @NonNull com.babylonhealth.lit.core_java.builders.ExtensionBuilder... extension)

      • withPublisher

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

      • withCopyright

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

      • withUseContext

        public ImplementationGuideBuilder.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 implementation guide instances.

      • withUseContext

        public ImplementationGuideBuilder.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 implementation guide instances.

      • withUseContext

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

      • withDescription

        public ImplementationGuideBuilder.Impl withDescription​(@NonNull
                                                       @NonNull java.lang.String description)
        Parameters:
        description - - A free text natural language description of the implementation guide from a consumer's perspective.

      • withExperimental

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withImplicitRules

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

      • withGlobal

        public ImplementationGuideBuilder.Impl withGlobal​(@NonNull
                                                  @NonNull com.babylonhealth.lit.hl7.model.ImplementationGuide.Global... global)
        Parameters:
        global - - A set of profiles that all resources covered by this implementation guide must conform to.

      • withGlobal

        public ImplementationGuideBuilder.Impl withGlobal​(@NonNull
                                                  @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ImplementationGuide.Global> global)
        Parameters:
        global - - A set of profiles that all resources covered by this implementation guide must conform to.

      • withDependsOn

        public ImplementationGuideBuilder.Impl withDependsOn​(@NonNull
                                                     @NonNull com.babylonhealth.lit.hl7.model.ImplementationGuide.DependsOn... dependsOn)
        Parameters:
        dependsOn - - Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

      • withDependsOn

        public ImplementationGuideBuilder.Impl withDependsOn​(@NonNull
                                                     @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.ImplementationGuide.DependsOn> dependsOn)
        Parameters:
        dependsOn - - Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

      • withManifest

        public ImplementationGuideBuilder.Impl withManifest​(@NonNull
                                                    com.babylonhealth.lit.hl7.model.ImplementationGuide.Manifest manifest)
        Parameters:
        manifest - - Information about an assembled implementation guide, created by the publication tooling.

      • withDefinition

        public ImplementationGuideBuilder.Impl withDefinition​(@NonNull
                                                      com.babylonhealth.lit.hl7.model.ImplementationGuide.Definition definition)
        Parameters:
        definition - - The information needed by an IG publisher tool to publish the whole implementation guide.

      • build

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