Package com.babylonhealth.lit.hl7_java.builders

Class CompositionBuilder.Impl

    • Constructor Detail

      • Impl

        public Impl​(com.babylonhealth.lit.core.model.CodeableConcept _type,
            com.babylonhealth.lit.core.FHIRDateTime date,
            java.lang.String title,
            com.babylonhealth.lit.hl7.COMPOSITION_STATUS status,
            java.util.Collection<com.babylonhealth.lit.core.model.Reference> author)
        Required fields for Composition
        Parameters:
        _type - - Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
        date - - The composition editing time, when the composition was last logically changed by the author.
        title - - Official human-readable label for the composition.
        status - - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
        author - - Identifies who is responsible for the information in the composition, not necessarily who typed it in.

    • Method Detail

      • withId

        public CompositionBuilder.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 CompositionBuilder.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 CompositionBuilder.Impl withMeta​(@NonNull
                                        @NonNull com.babylonhealth.lit.core_java.builders.MetaBuilder meta)

      • withText

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

      • withSubject

        public CompositionBuilder.Impl withSubject​(@NonNull
                                           @NonNull com.babylonhealth.lit.core.model.Reference subject)
        Parameters:
        subject - - Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).

      • withSubject

        public CompositionBuilder.Impl withSubject​(@NonNull
                                           @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder subject)

      • withLanguage

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

      • withCategory

        public CompositionBuilder.Impl withCategory​(@NonNull
                                            @NonNull com.babylonhealth.lit.core.model.CodeableConcept... category)
        Parameters:
        category - - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

      • withCategory

        public CompositionBuilder.Impl withCategory​(@NonNull
                                            @NonNull java.util.Collection<com.babylonhealth.lit.core.model.CodeableConcept> category)
        Parameters:
        category - - A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.

      • withCategory

        public CompositionBuilder.Impl withCategory​(@NonNull
                                            @NonNull com.babylonhealth.lit.core_java.builders.CodeableConceptBuilder... category)

      • withContained

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

      • withExtension

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

      • withEncounter

        public CompositionBuilder.Impl withEncounter​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference encounter)
        Parameters:
        encounter - - Describes the clinical encounter or type of care this documentation is associated with.

      • withEncounter

        public CompositionBuilder.Impl withEncounter​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder encounter)

      • withCustodian

        public CompositionBuilder.Impl withCustodian​(@NonNull
                                             @NonNull com.babylonhealth.lit.core.model.Reference custodian)
        Parameters:
        custodian - - Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

      • withCustodian

        public CompositionBuilder.Impl withCustodian​(@NonNull
                                             @NonNull com.babylonhealth.lit.core_java.builders.ReferenceBuilder custodian)

      • withIdentifier

        public CompositionBuilder.Impl withIdentifier​(@NonNull
                                              @NonNull com.babylonhealth.lit.core.model.Identifier identifier)
        Parameters:
        identifier - - A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.

      • withIdentifier

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

      • withImplicitRules

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

      • withConfidentiality

        public CompositionBuilder.Impl withConfidentiality​(@NonNull
                                                   @NonNull com.babylonhealth.lit.hl7.V3_CONFIDENTIALITYCLASSIFICATION confidentiality)
        Parameters:
        confidentiality - - The code specifying the level of confidentiality of the Composition.

      • withModifierExtension

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

      • withEvent

        public CompositionBuilder.Impl withEvent​(@NonNull
                                         @NonNull com.babylonhealth.lit.hl7.model.Composition.Event... event)
        Parameters:
        event - - The clinical service, such as a colonoscopy or an appendectomy, being documented.

      • withEvent

        public CompositionBuilder.Impl withEvent​(@NonNull
                                         @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Composition.Event> event)
        Parameters:
        event - - The clinical service, such as a colonoscopy or an appendectomy, being documented.

      • withSection

        public CompositionBuilder.Impl withSection​(@NonNull
                                           @NonNull com.babylonhealth.lit.hl7.model.Composition.Section... section)
        Parameters:
        section - - The root of the sections that make up the composition.

      • withSection

        public CompositionBuilder.Impl withSection​(@NonNull
                                           @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Composition.Section> section)
        Parameters:
        section - - The root of the sections that make up the composition.

      • withAttester

        public CompositionBuilder.Impl withAttester​(@NonNull
                                            @NonNull com.babylonhealth.lit.hl7.model.Composition.Attester... attester)
        Parameters:
        attester - - A participant who has attested to the accuracy of the composition/document.

      • withAttester

        public CompositionBuilder.Impl withAttester​(@NonNull
                                            @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Composition.Attester> attester)
        Parameters:
        attester - - A participant who has attested to the accuracy of the composition/document.

      • withRelatesTo

        public CompositionBuilder.Impl withRelatesTo​(@NonNull
                                             @NonNull com.babylonhealth.lit.hl7.model.Composition.RelatesTo... relatesTo)
        Parameters:
        relatesTo - - Relationships that this composition has with other compositions or documents that already exist.

      • withRelatesTo

        public CompositionBuilder.Impl withRelatesTo​(@NonNull
                                             @NonNull java.util.Collection<com.babylonhealth.lit.hl7.model.Composition.RelatesTo> relatesTo)
        Parameters:
        relatesTo - - Relationships that this composition has with other compositions or documents that already exist.

      • build

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