Task - FHIR Resource (stu3)

This Task Resource uses the FHIR API standard for access and structure.

Validate an Task FHIR Resource (stu3)

Task Attributes

AttributeField is listTypeDescription

Description: Constraints on fulfillment tasks

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"restriction":

Learn more about the (Task) restriction FHIR attribute

Description: Task Type

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"code":

Learn more about the (Task) code FHIR attribute

Description: Start and end time of execution

FHIR Version: stu3

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"executionPeriod":

Learn more about the (Task) executionPeriod FHIR attribute

Description: What task is acting on

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"focus":

Learn more about the (Task) focus FHIR attribute

Description: Reason for current status

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"statusReason":

Learn more about the (Task) statusReason FHIR attribute

Description: "owner" : { Reference(Device|Organization|Patient|Practitioner|

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"owner":

Learn more about the (Task) owner FHIR attribute

Description: "definitionReference" : { Reference(ActivityDefinition) },

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"definitionReference":

Learn more about the (Task) definitionReference FHIR attribute

Description: normal | urgent | asap | stat

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"priority":

Learn more about the (Task) priority FHIR attribute

Description: Beneficiary of the Task

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"for":

Learn more about the (Task) for FHIR attribute

Description: Request fulfilled by this task

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"basedOn":

Learn more about the (Task) basedOn FHIR attribute

Description: Comments made about the task

FHIR Version: stu3

Attribute Type : Annotation

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"note":

Learn more about the (Task) note FHIR attribute

Description: Information used to perform task

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"input":

Learn more about the (Task) input FHIR attribute

Description: draft | requested | received | accepted | +

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"status":

Learn more about the (Task) status FHIR attribute

Description: Human-readable explanation of task

FHIR Version: stu3

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"description":

Learn more about the (Task) description FHIR attribute

Description: Requisition or grouper id

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"groupIdentifier":

Learn more about the (Task) groupIdentifier FHIR attribute

Description: "definitionUri" : "<uri>",

FHIR Version: stu3

Attribute Type : uri

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"definitionUri":

Learn more about the (Task) definitionUri FHIR attribute

Description: Why task is needed

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reason":

Learn more about the (Task) reason FHIR attribute

Description: proposal | plan | order +

FHIR Version: stu3

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"intent":

Learn more about the (Task) intent FHIR attribute

Description: Key events in history of the Task

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"relevantHistory":

Learn more about the (Task) relevantHistory FHIR attribute

Description: Who is asking for task to be done

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"requester":

Learn more about the (Task) requester FHIR attribute

Description: E.g. "Specimen collected", "IV prepped"

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"businessStatus":

Learn more about the (Task) businessStatus FHIR attribute

Description: C? Task Creation Date

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"authoredOn":

Learn more about the (Task) authoredOn FHIR attribute

FHIR Version: stu3

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"performerType":

Learn more about the (Task) performerType FHIR attribute

Description: C? Task Last Modified Date

FHIR Version: stu3

Attribute Type : dateTime

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"lastModified":

Learn more about the (Task) lastModified FHIR attribute

Description: Healthcare event during which this task originated

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"context":

Learn more about the (Task) context FHIR attribute

Description: Information produced as part of task

FHIR Version: stu3

Attribute Type : Data Type

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"output":

Learn more about the (Task) output FHIR attribute

Description: Task Instance Identifier

FHIR Version: stu3

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier":

Learn more about the (Task) identifier FHIR attribute

Description: Composite task

FHIR Version: stu3

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"partOf":

Learn more about the (Task) partOf FHIR attribute

Task Structure


  
{
  "resourceType" : "Task",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Task Instance Identifier
  // definition[x]: Formal definition of task. One of these 2:
  "definitionUri" : "<uri>",
  "definitionReference" : { Reference(ActivityDefinition) },
  "basedOn" : [{ Reference(Any) }], // Request fulfilled by this task
  "groupIdentifier" : { Identifier }, // Requisition or grouper id
  "partOf" : [{ Reference(Task) }], // Composite task
  "status" : "<code>", // R!  draft | requested | received | accepted | +
  "statusReason" : { CodeableConcept }, // Reason for current status
  "businessStatus" : { CodeableConcept }, // E.g. "Specimen collected", "IV prepped"
  "intent" : "<code>", // R!  proposal | plan | order +
  "priority" : "<code>", // normal | urgent | asap | stat
  "code" : { CodeableConcept }, // Task Type
  "description" : "<string>", // Human-readable explanation of task
  "focus" : { Reference(Any) }, // What task is acting on
  "for" : { Reference(Any) }, // Beneficiary of the Task
  "context" : { Reference(Encounter|EpisodeOfCare) }, // Healthcare event during which this task originated
  "executionPeriod" : { Period }, // Start and end time of execution
  "authoredOn" : "<dateTime>", // C? Task Creation Date
  "lastModified" : "<dateTime>", // C? Task Last Modified Date
  "requester" : { // Who is asking for task to be done
    "agent" : { Reference(Device|Organization|Patient|Practitioner|
    RelatedPerson) }, // R!  Individual asking for task
    "onBehalfOf" : { Reference(Organization) } // Organization individual is acting for
  },
  "performerType" : [{ CodeableConcept }], // requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
  "owner" : { Reference(Device|Organization|Patient|Practitioner|
   RelatedPerson) }, // Responsible individual
  "reason" : { CodeableConcept }, // Why task is needed
  "note" : [{ Annotation }], // Comments made about the task
  "relevantHistory" : [{ Reference(Provenance) }], // Key events in history of the Task
  "restriction" : { // Constraints on fulfillment tasks
    "repetitions" : "<positiveInt>", // How many times to repeat
    "period" : { Period }, // When fulfillment sought
    "recipient" : [{ Reference(Patient|Practitioner|RelatedPerson|Group|
    Organization) }] // For whom is fulfillment sought?
  },
  "input" : [{ // Information used to perform task
    "type" : { CodeableConcept }, // R!  Label for the input
    // value[x]: Content to use in performing the task. One of these 23:
    "valueInteger" : <integer>
    "valueDecimal" : <decimal>
    "valueDateTime" : "<dateTime>"
    "valueDate" : "<date>"
    "valueInstant" : "<instant>"
    "valueString" : "<string>"
    "valueUri" : "<uri>"
    "valueBoolean" : <boolean>
    "valueCode" : "<code>"
    "valueBase64Binary" : "<base64Binary>"
    "valueCoding" : { Coding }
    "valueCodeableConcept" : { CodeableConcept }
    "valueAttachment" : { Attachment }
    "valueIdentifier" : { Identifier }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
    "valuePeriod" : { Period }
    "valueRatio" : { Ratio }
    "valueHumanName" : { HumanName }
    "valueAddress" : { Address }
    "valueContactPoint" : { ContactPoint }
    "valueSchedule" : { Schedule }
    "valueReference" : { Reference }
  }],
  "output" : [{ // Information produced as part of task
    "type" : { CodeableConcept }, // R!  Label for output
    // value[x]: Result of output. One of these 23:
    "valueInteger" : <integer>
    "valueDecimal" : <decimal>
    "valueDateTime" : "<dateTime>"
    "valueDate" : "<date>"
    "valueInstant" : "<instant>"
    "valueString" : "<string>"
    "valueUri" : "<uri>"
    "valueBoolean" : <boolean>
    "valueCode" : "<code>"
    "valueBase64Binary" : "<base64Binary>"
    "valueCoding" : { Coding }
    "valueCodeableConcept" : { CodeableConcept }
    "valueAttachment" : { Attachment }
    "valueIdentifier" : { Identifier }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
    "valuePeriod" : { Period }
    "valueRatio" : { Ratio }
    "valueHumanName" : { HumanName }
    "valueAddress" : { Address }
    "valueContactPoint" : { ContactPoint }
    "valueSchedule" : { Schedule }
    "valueReference" : { Reference }
  }]
}

Task Search Parameters

The following search parameters can be used to query Task resources. Just submit them like so:

https://api.1up.health/fhir/stu3/Task?query-param=queryvalue

Search Parameter	Field Type	Resource Fields Searched
`authored-on`	`date`	`authoredOn`
`based-on`	`reference`	`basedOn`
`business-status`	`text`	`businessStatus`
`code`	`text`	`code`
`context`	`reference`	`context`
`focus`	`reference`	`focus`
`group-identifier`	`text`	`groupIdentifier`
`identifier`	`text`	`identifier`
`intent`	`text`	`intent`
`modified`	`date`	`lastModified`
`organization`	`reference`	`requester.onBehalfOf`
`owner`	`reference`	`owner`
`part-of`	`reference`	`partOf`
`patient`	`reference`	`for`
`performer`	`text`	`performerType`
`period`	`date`	`executionPeriod`
`priority`	`text`	`priority`
`requester`	`reference`	`requester.agent`
`status`	`text`	`status`
`subject`	`reference`	`for`