Package com.babylonhealth.lit.hl7_java.builders

Class StructureDefinitionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(java.lang.String url,
            java.lang.String name,
            com.babylonhealth.lit.hl7.STRUCTURE_DEFINITION_KIND kind,
            java.lang.String _type,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            java.lang.Boolean _abstract)
        Required fields for StructureDefinition
        Parameters:
        url - - An absolute URI that is used to identify this structure definition 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 definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the structure definition is stored on different servers.
        name - - A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
        kind - - Defines the kind of structure that this definition is describing.
        _type - - The type this structure describes. If the derivation kind is 'specialization' then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type). References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
        status - - The status of this structure definition. Enables tracking the life-cycle of the content.
        _abstract - - Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.

    • Method Detail

      • withId

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

      • withTitle

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

      • withVersion

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

      • withPurpose

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

      • withKeyword

        public StructureDefinitionBuilder.Impl withKeyword​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core.model.Coding... keyword)
        Parameters:
        keyword - - A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

      • withKeyword

        public StructureDefinitionBuilder.Impl withKeyword​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.core.model.Coding> keyword)
        Parameters:
        keyword - - A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates nby describing the use of this structure definition, or the content it describes.

      • withKeyword

        public StructureDefinitionBuilder.Impl withKeyword​(@NonNull
                                                   @NonNull com.babylonhealth.lit.core_java.builders.CodingBuilder... keyword)

      • withLanguage

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

      • withContained

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

      • withExtension

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

      • withPublisher

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

      • withCopyright

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

      • withIdentifier

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

      • withIdentifier

        public StructureDefinitionBuilder.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 definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

      • withIdentifier

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

      • withUseContext

        public StructureDefinitionBuilder.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 definition instances.

      • withUseContext

        public StructureDefinitionBuilder.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 definition instances.

      • withUseContext

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

      • withDerivation

        public StructureDefinitionBuilder.Impl withDerivation​(@NonNull
                                                      @NonNull com.babylonhealth.lit.hl7.TYPE_DERIVATION_RULE derivation)
        Parameters:
        derivation - - How the type relates to the baseDefinition.

      • withDescription

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

      • withFhirVersion

        public StructureDefinitionBuilder.Impl withFhirVersion​(@NonNull
                                                       @NonNull com.babylonhealth.lit.hl7.FHIR_VERSION fhirVersion)
        Parameters:
        fhirVersion - - The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.1. for this version.

      • withExperimental

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

      • withJurisdiction

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

      • withJurisdiction

        public StructureDefinitionBuilder.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 definition is intended to be used.

      • withJurisdiction

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

      • withImplicitRules

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

      • withBaseDefinition

        public StructureDefinitionBuilder.Impl withBaseDefinition​(@NonNull
                                                          @NonNull java.lang.String baseDefinition)
        Parameters:
        baseDefinition - - An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.

      • withContextInvariant

        public StructureDefinitionBuilder.Impl withContextInvariant​(@NonNull
                                                            @NonNull java.lang.String... contextInvariant)
        Parameters:
        contextInvariant - - A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

      • withContextInvariant

        public StructureDefinitionBuilder.Impl withContextInvariant​(@NonNull
                                                            @NonNull java.util.Collection<java.lang.String> contextInvariant)
        Parameters:
        contextInvariant - - A set of rules as FHIRPath Invariants about when the extension can be used (e.g. co-occurrence variants for the extension). All the rules must be true.

      • withModifierExtension

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

      • withMapping

        public StructureDefinitionBuilder.Impl withMapping​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.model.StructureDefinition.Mapping... mapping)
        Parameters:
        mapping - - An external specification that the content is mapped to.

      • withMapping

        public StructureDefinitionBuilder.Impl withMapping​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.StructureDefinition.Mapping> mapping)
        Parameters:
        mapping - - An external specification that the content is mapped to.

      • withContext

        public StructureDefinitionBuilder.Impl withContext​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.model.StructureDefinition.Context... context)
        Parameters:
        context - - Identifies the types of resource or data type elements to which the extension can be applied.

      • withContext

        public StructureDefinitionBuilder.Impl withContext​(@NonNull
                                                   @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.StructureDefinition.Context> context)
        Parameters:
        context - - Identifies the types of resource or data type elements to which the extension can be applied.

      • withSnapshot

        public StructureDefinitionBuilder.Impl withSnapshot​(@NonNull
                                                    com.babylonhealth.lit.hl7.model.StructureDefinition.Snapshot snapshot)
        Parameters:
        snapshot - - A snapshot view is expressed in a standalone form that can be used and interpreted without considering the base StructureDefinition.

      • withDifferential

        public StructureDefinitionBuilder.Impl withDifferential​(@NonNull
                                                        com.babylonhealth.lit.hl7.model.StructureDefinition.Differential differential)
        Parameters:
        differential - - A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.

      • build

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