Package com.ibm.fhir.model.resource

Class Task

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Task
extends DomainResource
    A task to be performed.

    Maturity level: FMM2 (Trial Use)

    • Method Detail

      • getIdentifier

        public List<Identifier> getIdentifier()
        The business identifier for this task.
        Returns:
        An unmodifiable list containing immutable objects of type Identifier that may be empty.

      • getInstantiatesCanonical

        public Canonical getInstantiatesCanonical()
        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.
        Returns:
        An immutable object of type Canonical that may be null.

      • getInstantiatesUri

        public Uri getInstantiatesUri()
        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.
        Returns:
        An immutable object of type Uri that may be null.

      • getBasedOn

        public List<Reference> getBasedOn()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getGroupIdentifier

        public Identifier getGroupIdentifier()
        An identifier that links together multiple tasks and other requests that were created in the same context.
        Returns:
        An immutable object of type Identifier that may be null.

      • getPartOf

        public List<Reference> getPartOf()
        Task that this particular task is part of.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getStatus

        public TaskStatus getStatus()
        The current status of the task.
        Returns:
        An immutable object of type TaskStatus that is non-null.

      • getStatusReason

        public CodeableConcept getStatusReason()
        An explanation as to why this task is held, failed, was refused, etc.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getBusinessStatus

        public CodeableConcept getBusinessStatus()
        Contains business-specific nuances of the business state.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getIntent

        public TaskIntent getIntent()
        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.
        Returns:
        An immutable object of type TaskIntent that is non-null.

      • getPriority

        public TaskPriority getPriority()
        Indicates how quickly the Task should be addressed with respect to other requests.
        Returns:
        An immutable object of type TaskPriority that may be null.

      • getCode

        public CodeableConcept getCode()
        A name or code (or both) briefly describing what the task involves.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getDescription

        public String getDescription()
        A free-text description of what is to be performed.
        Returns:
        An immutable object of type String that may be null.

      • getFocus

        public Reference getFocus()
        The request being actioned or the resource being manipulated by this task.
        Returns:
        An immutable object of type Reference that may be null.

      • getFor

        public Reference getFor()
        The entity who benefits from the performance of the service specified in the task (e.g., the patient).
        Returns:
        An immutable object of type Reference that may be null.

      • getEncounter

        public Reference getEncounter()
        The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
        Returns:
        An immutable object of type Reference that may be null.

      • getExecutionPeriod

        public Period getExecutionPeriod()
        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).
        Returns:
        An immutable object of type Period that may be null.

      • getAuthoredOn

        public DateTime getAuthoredOn()
        The date and time this task was created.
        Returns:
        An immutable object of type DateTime that may be null.

      • getLastModified

        public DateTime getLastModified()
        The date and time of last modification to this task.
        Returns:
        An immutable object of type DateTime that may be null.

      • getRequester

        public Reference getRequester()
        The creator of the task.
        Returns:
        An immutable object of type Reference that may be null.

      • getPerformerType

        public List<CodeableConcept> getPerformerType()
        The kind of participant that should perform the task.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getOwner

        public Reference getOwner()
        Individual organization or Device currently responsible for task execution.
        Returns:
        An immutable object of type Reference that may be null.

      • getLocation

        public Reference getLocation()
        Principal physical location where the this task is performed.
        Returns:
        An immutable object of type Reference that may be null.

      • getReasonCode

        public CodeableConcept getReasonCode()
        A description or code indicating why this task needs to be performed.
        Returns:
        An immutable object of type CodeableConcept that may be null.

      • getReasonReference

        public Reference getReasonReference()
        A resource reference indicating why this task needs to be performed.
        Returns:
        An immutable object of type Reference that may be null.

      • getInsurance

        public List<Reference> getInsurance()
        Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getNote

        public List<Annotation> getNote()
        Free-text information captured about the task as it progresses.
        Returns:
        An unmodifiable list containing immutable objects of type Annotation that may be empty.

      • getRelevantHistory

        public List<Reference> getRelevantHistory()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Reference that may be empty.

      • getRestriction

        public Task.Restriction getRestriction()
        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.
        Returns:
        An immutable object of type Task.Restriction that may be null.

      • getInput

        public List<Task.Input> getInput()
        Additional information that may be needed in the execution of the task.
        Returns:
        An unmodifiable list containing immutable objects of type Task.Input that may be empty.

      • getOutput

        public List<Task.Output> getOutput()
        Outputs produced by the Task.
        Returns:
        An unmodifiable list containing immutable objects of type Task.Output that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object