Task

@POJOBoilerplate
class Task(val id: Option[String], `for`: Option[Reference], val meta: Option[Meta], val text: Option[Narrative], val code: Option[CodeableConcept], val note: LitSeq[Annotation], val focus: Option[Reference], val owner: Option[Reference], val partOf: LitSeq[Reference], val status: TASK_STATUS, val intent: TASK_INTENT, val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val priority: Option[REQUEST_PRIORITY], val location: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: Option[CodeableConcept], val description: Option[String], val statusReason: Option[CodeableConcept], val lastModified: Option[FHIRDateTime], val implicitRules: Option[UriStr], val performerType: LitSeq[CodeableConcept], val businessStatus: Option[CodeableConcept], val instantiatesUri: Option[UriStr], val groupIdentifier: Option[Identifier], val executionPeriod: Option[Period], val reasonReference: Option[Reference], val relevantHistory: LitSeq[Reference], val modifierExtension: LitSeq[Extension], val instantiatesCanonical: Option[Canonical], val input: LitSeq[Input], val output: LitSeq[Output], val restriction: Option[Restriction], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

A task to be performed.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
`for`
  • The entity who benefits from the performance of the service specified in the task (e.g., the patient).
authoredOn
  • The date and time this task was created.
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.
businessStatus
  • Contains business-specific nuances of the business state.
code
  • A name or code (or both) briefly describing what the task involves.
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.
description
  • A free-text description of what is to be performed.
encounter
  • 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).
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.
focus
  • The request being actioned or the resource being manipulated by this task.
groupIdentifier
  • An identifier that links together multiple tasks and other requests that were created in the same context.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • The business identifier for this task.
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.
input
  • Additional information that may be needed in the execution of the task.
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.
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.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
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.
language
  • The base language in which the resource is written.
lastModified
  • The date and time of last modification to this task.
location
  • Principal physical location where the this task is performed.
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.
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).
note
  • Free-text information captured about the task as it progresses.
output
  • Outputs produced by the Task.
owner
  • Individual organization or Device currently responsible for task execution.
partOf
  • Task that this particular task is part of.
performerType
  • The kind of participant that should perform the task.
priority
  • Indicates how quickly the Task should be addressed with respect to other requests.
reasonCode
  • A description or code indicating why this task needs to be performed.
reasonReference
  • A resource reference indicating why this task needs to be performed.
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.
requester
  • The creator 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.
status
  • The current status of the task.
statusReason
  • An explanation as to why this task is held, failed, was refused, etc.
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.
Constructor:

Introduces the fields for, code, note, focus, owner, partOf, status, intent, basedOn, priority, location, encounter, requester, insurance, identifier, authoredOn, reasonCode, description, statusReason, lastModified, performerType, businessStatus, instantiatesUri, groupIdentifier, executionPeriod, reasonReference, relevantHistory, instantiatesCanonical, input, output, restriction.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Task

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Task]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Task <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Task <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Task

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Task <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Task <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Task
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Task <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Task <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Task <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Task
Inherited from:
FHIRObject

Concrete fields

val `for`: Option[Reference]
val authoredOn: Option[FHIRDateTime]
val basedOn: LitSeq[Reference]
val businessStatus: Option[CodeableConcept]
val code: Option[CodeableConcept]
override val contained: LitSeq[Resource]
val description: Option[String]
val encounter: Option[Reference]
val executionPeriod: Option[Period]
override val extension: LitSeq[Extension]
val focus: Option[Reference]
val groupIdentifier: Option[Identifier]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val input: LitSeq[Input]
val instantiatesCanonical: Option[Canonical]
val instantiatesUri: Option[UriStr]
val insurance: LitSeq[Reference]
override val language: Option[LANGUAGES]
val lastModified: Option[FHIRDateTime]
val location: Option[Reference]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val note: LitSeq[Annotation]
val output: LitSeq[Output]
val owner: Option[Reference]
val partOf: LitSeq[Reference]
val performerType: LitSeq[CodeableConcept]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val reasonCode: Option[CodeableConcept]
val reasonReference: Option[Reference]
val relevantHistory: LitSeq[Reference]
val requester: Option[Reference]
val statusReason: Option[CodeableConcept]
override val text: Option[Narrative]
override val thisTypeName: String

Inherited fields

val companion: CompanionFor[Task]
Inherited from:
FHIRObject