Package com.babylonhealth.lit.hl7_java.builders

Class MessageDefinitionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.core.FHIRDateTime date,
            com.babylonhealth.lit.hl7.PUBLICATION_STATUS status,
            @NonNull
            @NonNull Unions.ChoiceCodingOrUri event)
        Required fields for MessageDefinition
        Parameters:
        date - - The date (and optionally time) when the message 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 message definition changes.
        status - - The status of this message definition. Enables tracking the life-cycle of the content.
        event - - Event code or link to the EventDefinition. Field is a 'choice' field. Type should be one of Coding, String. To pass the value in, wrap with one of the MessageDefinitionBuilder.event static methods

    • Method Detail

      • withId

        public MessageDefinitionBuilder.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 MessageDefinitionBuilder.Impl withUrl​(@NonNull
                                             @NonNull java.lang.String url)
        Parameters:
        url - - The business identifier that is used to reference the MessageDefinition and *is* expected to be consistent from server to server.

      • withMeta

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

      • withBase

        public MessageDefinitionBuilder.Impl withBase​(@NonNull
                                              @NonNull java.lang.String base)
        Parameters:
        base - - The MessageDefinition that is the basis for the contents of this resource.

      • withTitle

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

      • withGraph

        public MessageDefinitionBuilder.Impl withGraph​(@NonNull
                                               @NonNull java.lang.String... graph)
        Parameters:
        graph - - Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

      • withGraph

        public MessageDefinitionBuilder.Impl withGraph​(@NonNull
                                               @NonNull java.util.Collection<java.lang.String> graph)
        Parameters:
        graph - - Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a [GraphDefinition](graphdefinition.html) that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

      • withParent

        public MessageDefinitionBuilder.Impl withParent​(@NonNull
                                                @NonNull java.lang.String... parent)
        Parameters:
        parent - - Identifies a protocol or workflow that this MessageDefinition represents a step in.

      • withParent

        public MessageDefinitionBuilder.Impl withParent​(@NonNull
                                                @NonNull java.util.Collection<java.lang.String> parent)
        Parameters:
        parent - - Identifies a protocol or workflow that this MessageDefinition represents a step in.

      • withVersion

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

      • withPurpose

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

      • withLanguage

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

      • withReplaces

        public MessageDefinitionBuilder.Impl withReplaces​(@NonNull
                                                  @NonNull java.lang.String... replaces)
        Parameters:
        replaces - - A MessageDefinition that is superseded by this definition.

      • withReplaces

        public MessageDefinitionBuilder.Impl withReplaces​(@NonNull
                                                  @NonNull java.util.Collection<java.lang.String> replaces)
        Parameters:
        replaces - - A MessageDefinition that is superseded by this definition.

      • withCategory

        public MessageDefinitionBuilder.Impl withCategory​(@NonNull
                                                  @NonNull com.babylonhealth.lit.hl7.MESSAGE_SIGNIFICANCE_CATEGORY category)
        Parameters:
        category - - The impact of the content of the message.

      • withContained

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

      • withExtension

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

      • withPublisher

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

      • withCopyright

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

      • withIdentifier

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

      • withIdentifier

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

      • withIdentifier

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

      • withUseContext

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

      • withUseContext

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

      • withUseContext

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

      • withDescription

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

      • withExperimental

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withJurisdiction

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

      • withImplicitRules

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

      • withResponseRequired

        public MessageDefinitionBuilder.Impl withResponseRequired​(@NonNull
                                                          @NonNull com.babylonhealth.lit.hl7.MESSAGEHEADER_RESPONSE_REQUEST responseRequired)
        Parameters:
        responseRequired - - Declare at a message definition level whether a response is required or only upon error or success, or never.

      • withModifierExtension

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

      • withFocus

        public MessageDefinitionBuilder.Impl withFocus​(@NonNull
                                               @NonNull com.babylonhealth.lit.hl7.model.MessageDefinition.Focus... focus)
        Parameters:
        focus - - Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

      • withFocus

        public MessageDefinitionBuilder.Impl withFocus​(@NonNull
                                               @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.MessageDefinition.Focus> focus)
        Parameters:
        focus - - Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.

      • withAllowedResponse

        public MessageDefinitionBuilder.Impl withAllowedResponse​(@NonNull
                                                         @NonNull com.babylonhealth.lit.hl7.model.MessageDefinition.AllowedResponse... allowedResponse)
        Parameters:
        allowedResponse - - Indicates what types of messages may be sent as an application-level response to this message.

      • withAllowedResponse

        public MessageDefinitionBuilder.Impl withAllowedResponse​(@NonNull
                                                         @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.MessageDefinition.AllowedResponse> allowedResponse)
        Parameters:
        allowedResponse - - Indicates what types of messages may be sent as an application-level response to this message.

      • build

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