Package com.babylonhealth.lit.hl7_java.builders

Class StructureMapBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String url,
            java.lang.String name,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.util.Collection<com.babylonhealth.lit.hl7.model.StructureMap.Group> group)
        Required fields for StructureMap
        Parameters:
        url - - An absolute URI that is used to identify this structure map 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 structure map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure map is stored on different servers.
        name - - A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        status - - The status of this structure map. Enables tracking the life-cycle of the content.
        group - - Organizes the mapping into manageable chunks for human review/ease of maintenance.

    • Method Detail

      • withId

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

      • withMeta

        public StructureMapBuilder.Impl withMeta​(@NonNull
                                         @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

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

      • withTitle

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

      • withImport

        public StructureMapBuilder.Impl withImport​(@NonNull
                                           @NonNull java.lang.String... _import)
        Parameters:
        _import - - Other maps used by this map (canonical URLs).

      • withImport

        public StructureMapBuilder.Impl withImport​(@NonNull
                                           @NonNull java.util.Collection<java.lang.String> _import)
        Parameters:
        _import - - Other maps used by this map (canonical URLs).

      • withVersion

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

      • withPurpose

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

      • withLanguage

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

      • withContained

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

      • withExtension

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

      • withPublisher

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

      • withCopyright

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

      • withIdentifier

        public StructureMapBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull com.babylonhealth.lit.core.model.Identifier... identifier)
        Parameters:
        identifier - - A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.

      • withIdentifier

        public StructureMapBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Identifier> identifier)
        Parameters:
        identifier - - A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.

      • withIdentifier

        public StructureMapBuilder.Impl withIdentifier​(@NonNull
                                               @NonNull com.babylonhealth.lit.core_java.builders.IdentifierBuilder... identifier)

      • withUseContext

        public StructureMapBuilder.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 structure map instances.

      • withUseContext

        public StructureMapBuilder.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 structure map instances.

      • withUseContext

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

      • withDescription

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

      • withExperimental

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withImplicitRules

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

      • withStructure

        public StructureMapBuilder.Impl withStructure​(@NonNull
                                              @NonNull com.babylonhealth.lit.hl7.model.StructureMap.Structure... structure)
        Parameters:
        structure - - A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

      • withStructure

        public StructureMapBuilder.Impl withStructure​(@NonNull
                                              @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.StructureMap.Structure> structure)
        Parameters:
        structure - - A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.

      • build

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