Skip to main content

Task

PropertyValue
Publisher
NameTask
URLhttp://hl7.org/fhir/StructureDefinition/Task
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Task0..*TaskA task to be performed.
Task.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Task.meta0..1MetaThe 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.
Task.implicitRules0..1uriA 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.
Task.language0..1codeThe base language in which the resource is written.
Task.text0..1NarrativeA 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.
Task.contained0..*ResourceThese 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.
Task.extension0..*ExtensionMay 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.
Task.modifierExtension0..*ExtensionMay 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).
Task.identifier0..*IdentifierThe business identifier for this task.
Task.instantiatesCanonical0..1canonicalThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Task.instantiatesUri0..1uriThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Task.basedOn0..*ReferenceBasedOn 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.
Task.groupIdentifier0..1IdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
Task.partOf0..*ReferenceTask that this particular task is part of.
Task.status1..1codeThe current status of the task.
Task.statusReason0..1CodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
Task.businessStatus0..1CodeableConceptContains business-specific nuances of the business state.
Task.intent1..1codeIndicates 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.
Task.priority0..1codeIndicates how quickly the Task should be addressed with respect to other requests.
Task.code0..1CodeableConceptA name or code (or both) briefly describing what the task involves.
Task.description0..1stringA free-text description of what is to be performed.
Task.focus0..1ReferenceThe request being actioned or the resource being manipulated by this task.
Task.for0..1ReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
Task.encounter0..1ReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
Task.executionPeriod0..1PeriodIdentifies 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).
Task.authoredOn0..1dateTimeThe date and time this task was created.
Task.lastModified0..1dateTimeThe date and time of last modification to this task.
Task.requester0..1ReferenceThe creator of the task.
Task.performerType0..*CodeableConceptThe kind of participant that should perform the task.
Task.owner0..1ReferenceIndividual organization or Device currently responsible for task execution.
Task.location0..1ReferencePrincipal physical location where the this task is performed.
Task.reasonCode0..1CodeableConceptA description or code indicating why this task needs to be performed.
Task.reasonReference0..1ReferenceA resource reference indicating why this task needs to be performed.
Task.insurance0..*ReferenceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
Task.note0..*AnnotationFree-text information captured about the task as it progresses.
Task.relevantHistory0..*ReferenceLinks 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.
Task.restriction0..1BackboneElementIf 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.
Task.restriction.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Task.restriction.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
Task.restriction.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Task.restriction.repetitions0..1positiveIntIndicates the number of times the requested action should occur.
Task.restriction.period0..1PeriodOver what time-period is fulfillment sought.
Task.restriction.recipient0..*ReferenceFor requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
Task.input0..*BackboneElementAdditional information that may be needed in the execution of the task.
Task.input.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Task.input.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
Task.input.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Task.input.type1..1CodeableConceptA code or description indicating how the input is intended to be used as part of the task execution.
Task.input.value[x]1..1base64BinaryThe value of the input parameter as a basic type.
Task.output0..*BackboneElementOutputs produced by the Task.
Task.output.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Task.output.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. 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.
Task.output.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).
Task.output.type1..1CodeableConceptThe name of the Output parameter.
Task.output.value[x]1..1base64BinaryThe value of the Output parameter as a basic type.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
authored-ondateSearch by creation dateTask.authoredOn
based-onreferenceSearch by requests this task is based onTask.basedOn
business-statustokenSearch by business statusTask.businessStatus
codetokenSearch by task codeTask.code
encounterreferenceSearch by encounterTask.encounter
focusreferenceSearch by task focusTask.focus
group-identifiertokenSearch by group identifierTask.groupIdentifier
identifiertokenSearch for a task instance by its business identifierTask.identifier
intenttokenSearch by task intentTask.intent
modifieddateSearch by last modification dateTask.lastModified
ownerreferenceSearch by task ownerTask.owner
part-ofreferenceSearch by task this task is part ofTask.partOf
patientreferenceSearch by patientTask.for.where(resolve() is Patient)
performertokenSearch by recommended type of performer (e.g., Requester, Performer, Scheduler).Task.performerType
perioddateSearch by period Task is/was underwayTask.executionPeriod
prioritytokenSearch by task priorityTask.priority
requesterreferenceSearch by task requesterTask.requester
statustokenSearch by task statusTask.status
subjectreferenceSearch by subjectTask.for