Package org.linuxforhealth.fhir.model.resource

Class Task.Builder

    • Method Detail

      • id

        public Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.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 Task.Builder identifier​(Identifier... identifier)
        The business identifier for this task.

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

        Parameters:
        identifier - Task Instance Identifier
        Returns:
        A reference to this Builder instance

      • identifier

        public Task.Builder identifier​(java.util.Collection<Identifier> identifier)
        The business identifier for this task.

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

      • instantiatesCanonical

        public Task.Builder instantiatesCanonical​(Canonical instantiatesCanonical)
        The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
        Parameters:
        instantiatesCanonical - Formal definition of task
        Returns:
        A reference to this Builder instance

      • instantiatesUri

        public Task.Builder instantiatesUri​(Uri instantiatesUri)
        The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
        Parameters:
        instantiatesUri - Formal definition of task
        Returns:
        A reference to this Builder instance

      • basedOn

        public Task.Builder basedOn​(Reference... basedOn)
        BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

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

        Parameters:
        basedOn - Request fulfilled by this task
        Returns:
        A reference to this Builder instance

      • basedOn

        public Task.Builder basedOn​(java.util.Collection<Reference> basedOn)
        BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.

        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:
        basedOn - Request fulfilled by this task
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • groupIdentifier

        public Task.Builder groupIdentifier​(Identifier groupIdentifier)
        An identifier that links together multiple tasks and other requests that were created in the same context.
        Parameters:
        groupIdentifier - Requisition or grouper id
        Returns:
        A reference to this Builder instance

      • partOf

        public Task.Builder partOf​(Reference... partOf)
        Task that this particular task is part of.

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

        Allowed resource types for the references:

        Parameters:
        partOf - Composite task
        Returns:
        A reference to this Builder instance

      • partOf

        public Task.Builder partOf​(java.util.Collection<Reference> partOf)
        Task that this particular task is part of.

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

        Allowed resource types for the references:

        Parameters:
        partOf - Composite task
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • status

        public Task.Builder status​(TaskStatus status)
        The current status of the task.

        This element is required.

        Parameters:
        status - draft | requested | received | accepted | +
        Returns:
        A reference to this Builder instance

      • statusReason

        public Task.Builder statusReason​(CodeableConcept statusReason)
        An explanation as to why this task is held, failed, was refused, etc.
        Parameters:
        statusReason - Reason for current status
        Returns:
        A reference to this Builder instance

      • businessStatus

        public Task.Builder businessStatus​(CodeableConcept businessStatus)
        Contains business-specific nuances of the business state.
        Parameters:
        businessStatus - E.g. "Specimen collected", "IV prepped"
        Returns:
        A reference to this Builder instance

      • intent

        public Task.Builder intent​(TaskIntent intent)
        Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.

        This element is required.

        Parameters:
        intent - unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
        Returns:
        A reference to this Builder instance

      • priority

        public Task.Builder priority​(TaskPriority priority)
        Indicates how quickly the Task should be addressed with respect to other requests.
        Parameters:
        priority - routine | urgent | asap | stat
        Returns:
        A reference to this Builder instance

      • code

        public Task.Builder code​(CodeableConcept code)
        A name or code (or both) briefly describing what the task involves.
        Parameters:
        code - Task Type
        Returns:
        A reference to this Builder instance

      • description

        public Task.Builder description​(String description)
        A free-text description of what is to be performed.
        Parameters:
        description - Human-readable explanation of task
        Returns:
        A reference to this Builder instance

      • focus

        public Task.Builder focus​(Reference focus)
        The request being actioned or the resource being manipulated by this task.
        Parameters:
        focus - What task is acting on
        Returns:
        A reference to this Builder instance

      • _for

        public Task.Builder _for​(Reference _for)
        The entity who benefits from the performance of the service specified in the task (e.g., the patient).
        Parameters:
        _for - Beneficiary of the Task
        Returns:
        A reference to this Builder instance

      • encounter

        public Task.Builder encounter​(Reference encounter)
        The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.

        Allowed resource types for this reference:

        Parameters:
        encounter - Healthcare event during which this task originated
        Returns:
        A reference to this Builder instance

      • executionPeriod

        public Task.Builder executionPeriod​(Period executionPeriod)
        Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
        Parameters:
        executionPeriod - Start and end time of execution
        Returns:
        A reference to this Builder instance

      • authoredOn

        public Task.Builder authoredOn​(DateTime authoredOn)
        The date and time this task was created.
        Parameters:
        authoredOn - Task Creation Date
        Returns:
        A reference to this Builder instance

      • lastModified

        public Task.Builder lastModified​(DateTime lastModified)
        The date and time of last modification to this task.
        Parameters:
        lastModified - Task Last Modified Date
        Returns:
        A reference to this Builder instance

      • performerType

        public Task.Builder performerType​(CodeableConcept... performerType)
        The kind of participant that should perform the task.

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

        Parameters:
        performerType - Requested performer
        Returns:
        A reference to this Builder instance

      • performerType

        public Task.Builder performerType​(java.util.Collection<CodeableConcept> performerType)
        The kind of participant that should perform the task.

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

      • location

        public Task.Builder location​(Reference location)
        Principal physical location where the this task is performed.

        Allowed resource types for this reference:

        Parameters:
        location - Where task occurs
        Returns:
        A reference to this Builder instance

      • reasonCode

        public Task.Builder reasonCode​(CodeableConcept reasonCode)
        A description or code indicating why this task needs to be performed.
        Parameters:
        reasonCode - Why task is needed
        Returns:
        A reference to this Builder instance

      • reasonReference

        public Task.Builder reasonReference​(Reference reasonReference)
        A resource reference indicating why this task needs to be performed.
        Parameters:
        reasonReference - Why task is needed
        Returns:
        A reference to this Builder instance

      • insurance

        public Task.Builder insurance​(Reference... insurance)
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

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

        Allowed resource types for the references:

        Parameters:
        insurance - Associated insurance coverage
        Returns:
        A reference to this Builder instance

      • insurance

        public Task.Builder insurance​(java.util.Collection<Reference> insurance)
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.

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

        Allowed resource types for the references:

        Parameters:
        insurance - Associated insurance coverage
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • note

        public Task.Builder note​(Annotation... note)
        Free-text information captured about the task as it progresses.

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

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

      • note

        public Task.Builder note​(java.util.Collection<Annotation> note)
        Free-text information captured about the task as it progresses.

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

      • relevantHistory

        public Task.Builder relevantHistory​(Reference... relevantHistory)
        Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

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

        Allowed resource types for the references:

        Parameters:
        relevantHistory - Key events in history of the Task
        Returns:
        A reference to this Builder instance

      • relevantHistory

        public Task.Builder relevantHistory​(java.util.Collection<Reference> relevantHistory)
        Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.

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

        Allowed resource types for the references:

        Parameters:
        relevantHistory - Key events in history of the Task
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • restriction

        public Task.Builder restriction​(Task.Restriction restriction)
        If the Task.focus is a request resource and the task is seeking fulfillment (i.e. is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
        Parameters:
        restriction - Constraints on fulfillment tasks
        Returns:
        A reference to this Builder instance

      • input

        public Task.Builder input​(Task.Input... input)
        Additional information that may be needed in the execution of the task.

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

        Parameters:
        input - Information used to perform task
        Returns:
        A reference to this Builder instance

      • input

        public Task.Builder input​(java.util.Collection<Task.Input> input)
        Additional information that may be needed in the execution of the task.

        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:
        input - Information used to perform task
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • output

        public Task.Builder output​(Task.Output... output)
        Outputs produced by the Task.

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

        Parameters:
        output - Information produced as part of task
        Returns:
        A reference to this Builder instance

      • output

        public Task.Builder output​(java.util.Collection<Task.Output> output)
        Outputs produced by the Task.

        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:
        output - Information produced as part of task
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • build

        public Task build()
        Build the Task

        Required elements:

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

      • validate

        protected void validate​(Task task)