Package org.linuxforhealth.fhir.model.resource

Class Composition.Builder

    • Method Detail

      • id

        public Composition.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public Composition.Builder meta​(Meta 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.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public Composition.Builder implicitRules​(Uri 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.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public Composition.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public Composition.Builder text​(Narrative 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.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public Composition.Builder contained​(Resource... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public Composition.Builder contained​(java.util.Collection<Resource> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public Composition.Builder extension​(Extension... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public Composition.Builder extension​(java.util.Collection<Extension> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public Composition.Builder modifierExtension​(Extension... 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).

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public Composition.Builder modifierExtension​(java.util.Collection<Extension> 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).

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • identifier

        public Composition.Builder identifier​(Identifier identifier)
        A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
        Parameters:
        identifier - Version-independent identifier for the Composition
        Returns:
        A reference to this Builder instance

      • status

        public Composition.Builder status​(CompositionStatus status)
        The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.

        This element is required.

        Parameters:
        status - preliminary | final | amended | entered-in-error
        Returns:
        A reference to this Builder instance

      • type

        public Composition.Builder type​(CodeableConcept 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.

        This element is required.

        Parameters:
        type - Kind of composition (LOINC if possible)
        Returns:
        A reference to this Builder instance

      • category

        public Composition.Builder category​(CodeableConcept... 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.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Categorization of Composition
        Returns:
        A reference to this Builder instance

      • category

        public Composition.Builder category​(java.util.Collection<CodeableConcept> 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.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        category - Categorization of Composition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • subject

        public Composition.Builder subject​(Reference 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).
        Parameters:
        subject - Who and/or what the composition is about
        Returns:
        A reference to this Builder instance

      • encounter

        public Composition.Builder encounter​(Reference encounter)
        Describes the clinical encounter or type of care this documentation is associated with.

        Allowed resource types for this reference:

        Parameters:
        encounter - Context of the Composition
        Returns:
        A reference to this Builder instance

      • date

        public Composition.Builder date​(DateTime date)
        The composition editing time, when the composition was last logically changed by the author.

        This element is required.

        Parameters:
        date - Composition editing time
        Returns:
        A reference to this Builder instance

      • author

        public Composition.Builder author​(Reference... author)
        Identifies who is responsible for the information in the composition, not necessarily who typed it in.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        This element is required.

        Allowed resource types for the references:

        Parameters:
        author - Who and/or what authored the composition
        Returns:
        A reference to this Builder instance

      • author

        public Composition.Builder author​(java.util.Collection<Reference> author)
        Identifies who is responsible for the information in the composition, not necessarily who typed it in.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        This element is required.

        Allowed resource types for the references:

        Parameters:
        author - Who and/or what authored the composition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • title

        public Composition.Builder title​(String title)
        Official human-readable label for the composition.

        This element is required.

        Parameters:
        title - Human Readable name/title
        Returns:
        A reference to this Builder instance

      • confidentiality

        public Composition.Builder confidentiality​(DocumentConfidentiality confidentiality)
        The code specifying the level of confidentiality of the Composition.
        Parameters:
        confidentiality - As defined by affinity domain
        Returns:
        A reference to this Builder instance

      • attester

        public Composition.Builder attester​(Composition.Attester... attester)
        A participant who has attested to the accuracy of the composition/document.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        attester - Attests to accuracy of composition
        Returns:
        A reference to this Builder instance

      • attester

        public Composition.Builder attester​(java.util.Collection<Composition.Attester> attester)
        A participant who has attested to the accuracy of the composition/document.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        attester - Attests to accuracy of composition
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • custodian

        public Composition.Builder custodian​(Reference custodian)
        Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.

        Allowed resource types for this reference:

        Parameters:
        custodian - Organization which maintains the composition
        Returns:
        A reference to this Builder instance

      • relatesTo

        public Composition.Builder relatesTo​(Composition.RelatesTo... relatesTo)
        Relationships that this composition has with other compositions or documents that already exist.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - Relationships to other compositions/documents
        Returns:
        A reference to this Builder instance

      • relatesTo

        public Composition.Builder relatesTo​(java.util.Collection<Composition.RelatesTo> relatesTo)
        Relationships that this composition has with other compositions or documents that already exist.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        relatesTo - Relationships to other compositions/documents
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • event

        public Composition.Builder event​(Composition.Event... event)
        The clinical service, such as a colonoscopy or an appendectomy, being documented.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        event - The clinical service(s) being documented
        Returns:
        A reference to this Builder instance

      • event

        public Composition.Builder event​(java.util.Collection<Composition.Event> event)
        The clinical service, such as a colonoscopy or an appendectomy, being documented.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        event - The clinical service(s) being documented
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • section

        public Composition.Builder section​(Composition.Section... section)
        The root of the sections that make up the composition.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        section - Composition is broken into sections
        Returns:
        A reference to this Builder instance

      • section

        public Composition.Builder section​(java.util.Collection<Composition.Section> section)
        The root of the sections that make up the composition.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        section - Composition is broken into sections
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • validate

        protected void validate​(Composition composition)