Class Task

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Task extends DomainResource
A task to be performed.
See Also:
Serialized Form
  • Field Details

    • identifier

      The business identifier for this task.
    • definition

      protected Type definition
      A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
    • basedOn

      protected List<Reference> basedOn
      BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
    • basedOnTarget

      The actual objects that are the target of the reference (BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.)
    • groupIdentifier

      An identifier that links together multiple tasks and other requests that were created in the same context.
    • partOf

      protected List<Reference> partOf
      Task that this particular task is part of.
    • partOfTarget

      protected List<Task> partOfTarget
      The actual objects that are the target of the reference (Task that this particular task is part of.)
    • status

      The current status of the task.
    • statusReason

      An explanation as to why this task is held, failed, was refused, etc.
    • businessStatus

      Contains business-specific nuances of the business state.
    • intent

      Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
    • priority

      Indicates how quickly the Task should be addressed with respect to other requests.
    • code

      protected CodeableConcept code
      A name or code (or both) briefly describing what the task involves.
    • description

      A free-text description of what is to be performed.
    • focus

      protected Reference focus
      The request being actioned or the resource being manipulated by this task.
    • focusTarget

      protected Resource focusTarget
      The actual object that is the target of the reference (The request being actioned or the resource being manipulated by this task.)
    • for_

      protected Reference for_
      The entity who benefits from the performance of the service specified in the task (e.g., the patient).
    • for_Target

      protected Resource for_Target
      The actual object that is the target of the reference (The entity who benefits from the performance of the service specified in the task (e.g., the patient).)
    • context

      protected Reference context
      The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
    • contextTarget

      The actual object that is the target of the reference (The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.)
    • 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).
    • authoredOn

      The date and time this task was created.
    • lastModified

      The date and time of last modification to this task.
    • requester

      The creator of the task.
    • performerType

      The type of participant that can execute the task.
    • owner

      protected Reference owner
      Individual organization or Device currently responsible for task execution.
    • ownerTarget

      protected Resource ownerTarget
      The actual object that is the target of the reference (Individual organization or Device currently responsible for task execution.)
    • reason

      A description or code indicating why this task needs to be performed.
    • note

      protected List<Annotation> note
      Free-text information captured about the task as it progresses.
    • 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.
    • relevantHistoryTarget

      The actual objects that are the target of the reference (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.)
    • 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.
    • input

      Additional information that may be needed in the execution of the task.
    • output

      Outputs produced by the Task.
    • SP_OWNER

      public static final String SP_OWNER
      Search parameter: owner

      Description: Search by task owner
      Type: reference
      Path: Task.owner

      See Also:
      Constant Field Values
    • OWNER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam OWNER
      Fluent Client search parameter constant for owner

      Description: Search by task owner
      Type: reference
      Path: Task.owner

    • INCLUDE_OWNER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_OWNER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:owner".
    • SP_REQUESTER

      public static final String SP_REQUESTER
      Search parameter: requester

      Description: Search by task requester
      Type: reference
      Path: Task.requester.agent

      See Also:
      Constant Field Values
    • REQUESTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
      Fluent Client search parameter constant for requester

      Description: Search by task requester
      Type: reference
      Path: Task.requester.agent

    • INCLUDE_REQUESTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:requester".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Search for a task instance by its business identifier
      Type: token
      Path: Task.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: Search for a task instance by its business identifier
      Type: token
      Path: Task.identifier

    • SP_BUSINESS_STATUS

      public static final String SP_BUSINESS_STATUS
      Search parameter: business-status

      Description: Search by business status
      Type: token
      Path: Task.businessStatus

      See Also:
      Constant Field Values
    • BUSINESS_STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam BUSINESS_STATUS
      Fluent Client search parameter constant for business-status

      Description: Search by business status
      Type: token
      Path: Task.businessStatus

    • SP_PERIOD

      public static final String SP_PERIOD
      Search parameter: period

      Description: Search by period Task is/was underway
      Type: date
      Path: Task.executionPeriod

      See Also:
      Constant Field Values
    • PERIOD

      public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
      Fluent Client search parameter constant for period

      Description: Search by period Task is/was underway
      Type: date
      Path: Task.executionPeriod

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Search by task code
      Type: token
      Path: Task.code

      See Also:
      Constant Field Values
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Search by task code
      Type: token
      Path: Task.code

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter: performer

      Description: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
      Type: token
      Path: Task.performerType

      See Also:
      Constant Field Values
    • PERFORMER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PERFORMER
      Fluent Client search parameter constant for performer

      Description: Search by recommended type of performer (e.g., Requester, Performer, Scheduler).
      Type: token
      Path: Task.performerType

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter: subject

      Description: Search by subject
      Type: reference
      Path: Task.for

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description: Search by subject
      Type: reference
      Path: Task.for

    • INCLUDE_SUBJECT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:subject".
    • SP_FOCUS

      public static final String SP_FOCUS
      Search parameter: focus

      Description: Search by task focus
      Type: reference
      Path: Task.focus

      See Also:
      Constant Field Values
    • FOCUS

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FOCUS
      Fluent Client search parameter constant for focus

      Description: Search by task focus
      Type: reference
      Path: Task.focus

    • INCLUDE_FOCUS

      public static final ca.uhn.fhir.model.api.Include INCLUDE_FOCUS
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:focus".
    • SP_PART_OF

      public static final String SP_PART_OF
      Search parameter: part-of

      Description: Search by task this task is part of
      Type: reference
      Path: Task.partOf

      See Also:
      Constant Field Values
    • PART_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
      Fluent Client search parameter constant for part-of

      Description: Search by task this task is part of
      Type: reference
      Path: Task.partOf

    • INCLUDE_PART_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:part-of".
    • SP_PRIORITY

      public static final String SP_PRIORITY
      Search parameter: priority

      Description: Search by task priority
      Type: token
      Path: Task.priority

      See Also:
      Constant Field Values
    • PRIORITY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY
      Fluent Client search parameter constant for priority

      Description: Search by task priority
      Type: token
      Path: Task.priority

    • SP_AUTHORED_ON

      public static final String SP_AUTHORED_ON
      Search parameter: authored-on

      Description: Search by creation date
      Type: date
      Path: Task.authoredOn

      See Also:
      Constant Field Values
    • AUTHORED_ON

      public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED_ON
      Fluent Client search parameter constant for authored-on

      Description: Search by creation date
      Type: date
      Path: Task.authoredOn

    • SP_INTENT

      public static final String SP_INTENT
      Search parameter: intent

      Description: Search by task intent
      Type: token
      Path: Task.intent

      See Also:
      Constant Field Values
    • INTENT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
      Fluent Client search parameter constant for intent

      Description: Search by task intent
      Type: token
      Path: Task.intent

    • SP_GROUP_IDENTIFIER

      public static final String SP_GROUP_IDENTIFIER
      Search parameter: group-identifier

      Description: Search by group identifier
      Type: token
      Path: Task.groupIdentifier

      See Also:
      Constant Field Values
    • GROUP_IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP_IDENTIFIER
      Fluent Client search parameter constant for group-identifier

      Description: Search by group identifier
      Type: token
      Path: Task.groupIdentifier

    • SP_BASED_ON

      public static final String SP_BASED_ON
      Search parameter: based-on

      Description: Search by requests this task is based on
      Type: reference
      Path: Task.basedOn

      See Also:
      Constant Field Values
    • BASED_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
      Fluent Client search parameter constant for based-on

      Description: Search by requests this task is based on
      Type: reference
      Path: Task.basedOn

    • INCLUDE_BASED_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:based-on".
    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Search by patient
      Type: reference
      Path: Task.for

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description: Search by patient
      Type: reference
      Path: Task.for

    • INCLUDE_PATIENT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:patient".
    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter: organization

      Description: Search by responsible organization
      Type: reference
      Path: Task.requester.onBehalfOf

      See Also:
      Constant Field Values
    • ORGANIZATION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
      Fluent Client search parameter constant for organization

      Description: Search by responsible organization
      Type: reference
      Path: Task.requester.onBehalfOf

    • INCLUDE_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:organization".
    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: Search by encounter or episode
      Type: reference
      Path: Task.context

      See Also:
      Constant Field Values
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: Search by encounter or episode
      Type: reference
      Path: Task.context

    • INCLUDE_CONTEXT

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Task:context".
    • SP_MODIFIED

      public static final String SP_MODIFIED
      Search parameter: modified

      Description: Search by last modification date
      Type: date
      Path: Task.lastModified

      See Also:
      Constant Field Values
    • MODIFIED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam MODIFIED
      Fluent Client search parameter constant for modified

      Description: Search by last modification date
      Type: date
      Path: Task.lastModified

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Search by task status
      Type: token
      Path: Task.status

      See Also:
      Constant Field Values
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: Search by task status
      Type: token
      Path: Task.status

  • Constructor Details

  • Method Details