Package org.linuxforhealth.fhir.model.resource

Class List.Builder

    • Method Detail

      • id

        public List.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 List.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 List.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 List.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 List.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 List.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 List.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 List.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 List.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 List.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 List.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 List.Builder identifier​(Identifier... identifier)
        Identifier for the List assigned for business purposes outside the context of FHIR.

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

        Parameters:
        identifier - Business identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public List.Builder identifier​(java.util.Collection<Identifier> identifier)
        Identifier for the List assigned for business purposes outside the context of FHIR.

        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:
        identifier - Business identifier
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public List.Builder status​(ListStatus status)
        Indicates the current state of this list.

        This element is required.

        Parameters:
        status - current | retired | entered-in-error
        Returns:
        A reference to this Builder instance

      • mode

        public List.Builder mode​(ListMode mode)
        How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.

        This element is required.

        Parameters:
        mode - working | snapshot | changes
        Returns:
        A reference to this Builder instance

      • title

        public List.Builder title​(String title)
        A label for the list assigned by the author.
        Parameters:
        title - Descriptive name for the list
        Returns:
        A reference to this Builder instance

      • code

        public List.Builder code​(CodeableConcept code)
        This code defines the purpose of the list - why it was created.
        Parameters:
        code - What the purpose of this list is
        Returns:
        A reference to this Builder instance

      • subject

        public List.Builder subject​(Reference subject)
        The common subject (or patient) of the resources that are in the list if there is one.

        Allowed resource types for this reference:

        Parameters:
        subject - If all resources have the same subject
        Returns:
        A reference to this Builder instance

      • encounter

        public List.Builder encounter​(Reference encounter)
        The encounter that is the context in which this list was created.

        Allowed resource types for this reference:

        Parameters:
        encounter - Context in which list created
        Returns:
        A reference to this Builder instance

      • date

        public List.Builder date​(DateTime date)
        The date that the list was prepared.
        Parameters:
        date - When the list was prepared
        Returns:
        A reference to this Builder instance

      • source

        public List.Builder source​(Reference source)
        The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.

        Allowed resource types for this reference:

        Parameters:
        source - Who and/or what defined the list contents (aka Author)
        Returns:
        A reference to this Builder instance

      • orderedBy

        public List.Builder orderedBy​(CodeableConcept orderedBy)
        What order applies to the items in the list.
        Parameters:
        orderedBy - What order the list has
        Returns:
        A reference to this Builder instance

      • note

        public List.Builder note​(Annotation... note)
        Comments that apply to the overall list.

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

        Parameters:
        note - Comments about the list
        Returns:
        A reference to this Builder instance

      • note

        public List.Builder note​(java.util.Collection<Annotation> note)
        Comments that apply to the overall list.

        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:
        note - Comments about the list
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • entry

        public List.Builder entry​(List.Entry... entry)
        Entries in this list.

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

        Parameters:
        entry - Entries in the list
        Returns:
        A reference to this Builder instance

      • entry

        public List.Builder entry​(java.util.Collection<List.Entry> entry)
        Entries in this list.

        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:
        entry - Entries in the list
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • emptyReason

        public List.Builder emptyReason​(CodeableConcept emptyReason)
        If the list is empty, why the list is empty.
        Parameters:
        emptyReason - Why list is empty
        Returns:
        A reference to this Builder instance

      • build

        public List build()
        Build the List

        Required elements:

        • status
        • mode
        Specified by:
        build in interface Builder<Resource>
        Specified by:
        build in class DomainResource.Builder
        Returns:
        An immutable object of type List
        Throws:
        java.lang.IllegalStateException - if the current state cannot be built into a valid List per the base specification

      • validate

        protected void validate​(List list)