Task class
Task A task to be performed.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
Task({@Default(R5ResourceType.Task) @JsonKey(unknownEnumValue: R5ResourceType.Task) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCanonical? instantiatesCanonical, FhirUri? instantiatesUri, @JsonKey(name: '_instantiatesUri') Element? instantiatesUriElement, List<Reference> ? basedOn, Identifier? groupIdentifier, List<Reference> ? partOf, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableReference? statusReason, CodeableConcept? businessStatus, FhirCode? intent, @JsonKey(name: '_intent') Element? intentElement, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, FhirBoolean? doNotPerform, @JsonKey(name: '_doNotPerform') Element? doNotPerformElement, CodeableConcept? code, String? description, @JsonKey(name: '_description') Element? descriptionElement, Reference? focus, @JsonKey(name: 'for') Reference? for_, Reference? encounter, Period? requestedPeriod, Period? executionPeriod, FhirDateTime? authoredOn, @JsonKey(name: '_authoredOn') Element? authoredOnElement, FhirDateTime? lastModified, @JsonKey(name: '_lastModified') Element? lastModifiedElement, Reference? requester, List<CodeableReference> ? requestedPerformer, Reference? owner, List<TaskPerformer> ? performer, Reference? location, List<CodeableReference> ? reason, List<Reference> ? insurance, List<Annotation> ? note, List<Reference> ? relevantHistory, TaskRestriction? restriction, List<TaskInput> ? input, List<TaskOutput> ? output}) -
Task A task to be performed.
constfactory
-
Task.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- Task.fromJsonString(String source)
-
Acts like a constructor, returns a Task, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- Task.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
authoredOn The date and time this task was created.
no setterinherited
-
authoredOnElement ("_authoredOn") Extensions for authoredOn
no setterinherited
-
basedOn
→ 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 ServiceRequest, MedicationRequest, CarePlan, etc. which is distinct
from the "request" resource the task is seeking to fulfill. This
latter resource is referenced by focus. For example, based on a
CarePlan (= basedOn), a task is created to fulfill a ServiceRequest (
= focus ) to collect a specimen from a patient.
no setterinherited
- businessStatus → CodeableConcept?
-
businessStatus Contains business-specific nuances of the business
state.
no setterinherited
- code → CodeableConcept?
-
code A name or code (or both) briefly describing what the task
involves.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $TaskCopyWith<
Task> -
no setterinherited
- dbId → int?
-
no setterinherited
- description → String?
-
description A free-text description of what is to be performed.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- doNotPerform → FhirBoolean?
-
doNotPerform If true indicates that the Task is asking for the
specified action to not occur.
no setterinherited
- doNotPerformElement → Element?
-
doNotPerformElement ("_doNotPerform") Extensions for doNotPerform
no setterinherited
- encounter → Reference?
-
encounter The healthcare event (e.g. a patient and healthcare
provider interaction) during which this task was created.
no setterinherited
- 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).
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
- focus → Reference?
-
focus The request being fulfilled or the resource being manipulated
(changed, suspended, etc.) by this task.
no setterinherited
- for_ → Reference?
-
for_ ("for") The entity who benefits from the performance of the
service specified in the task (e.g., the patient).
no setterinherited
- groupIdentifier → Identifier?
-
groupIdentifier A shared identifier common to multiple independent
Task and Request instances that were activated/authorized more or less
simultaneously by a single author. The presence of the same
identifier on each request ties those requests together and may have
business ramifications in terms of reporting of results, billing, etc.
E.g. a requisition number shared by a set of lab tests ordered
together, or a prescription number shared by all meds ordered at one
time.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier The business identifier for this task.
no setterinherited
- implicitRules → FhirUri?
-
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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
-
input
→ List<
TaskInput> ? -
input Additional information that may be needed in the execution of
the task.
no setterinherited
- instantiatesCanonical → FhirCanonical?
-
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.
no setterinherited
- instantiatesUri → FhirUri?
-
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.
no setterinherited
- instantiatesUriElement → Element?
-
instantiatesUriElement ("_instantiatesUri") Extensions for
instantiatesUri
no setterinherited
-
insurance
→ List<
Reference> ? -
insurance Insurance plans, coverage extensions, pre-authorizations
and/or pre-determinations that may be relevant to the Task.
no setterinherited
- intent → FhirCode?
-
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.no setterinherited - intentElement → Element?
-
intentElement ("_intent") Extensions for intent
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- lastModified → FhirDateTime?
-
lastModified The date and time of last modification to this task.
no setterinherited
- lastModifiedElement → Element?
-
lastModifiedElement ("_lastModified") Extensions for lastModified
no setterinherited
- location → Reference?
-
location Principal physical location where this task is performed.
no setterinherited
- meta → FhirMeta?
-
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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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 managable, 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).
no setterinherited
-
note
→ List<
Annotation> ? -
note Free-text information captured about the task as it progresses.
no setterinherited
-
output
→ List<
TaskOutput> ? -
output Outputs produced by the Task.
no setterinherited
- owner → Reference?
-
owner Party responsible for managing task execution.
no setterinherited
-
partOf
→ List<
Reference> ? -
partOf Task that this particular task is part of.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
performer
→ List<
TaskPerformer> ? -
performer The entity who performed the requested task.
no setterinherited
- priority → FhirCode?
-
priority Indicates how quickly the Task should be addressed with
respect to other requests.
no setterinherited
- priorityElement → Element?
-
priorityElement ("_priority") Extensions for priority
no setterinherited
-
reason
→ List<
CodeableReference> ? -
reason A description, code, or reference indicating why this task
needs to be performed.
no setterinherited
-
relevantHistory
→ List<
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.
no setterinherited
-
requestedPerformer
→ List<
CodeableReference> ? -
requestedPerformer The kind of participant or specific participant
that should perform the task.
no setterinherited
- requestedPeriod → Period?
-
requestedPeriod Indicates the start and/or end of the period of time
when completion of the task is desired to take place.
no setterinherited
- requester → Reference?
-
requester The creator of the task.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a Task resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- restriction → TaskRestriction?
-
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.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The current status of the task.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- statusReason → CodeableReference?
-
statusReason An explanation as to why this task is held, failed, was
refused, etc.
no setterinherited
- 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.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited