Task - FHIR Resource (stu3)


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

Validate an Task FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
authoredOnfalsedateTime# C? Task Creation Date
basedOntrueReference# Request fulfilled by this task
businessStatusfalseCodeableConcept# E.g. "Specimen collected", "IV prepped"
codefalseCodeableConcept# Task Type
contextfalseReference# Healthcare event during which this task originated
definitionReferencefalseReference# "definitionReference" : { Reference(ActivityDefinition) },
definitionUrifalseuri# "definitionUri" : "<uri>",
descriptionfalsestring# Human-readable explanation of task
executionPeriodfalsePeriod# Start and end time of execution
focusfalseReference# What task is acting on
forfalseReference# Beneficiary of the Task
groupIdentifierfalseIdentifier# Requisition or grouper id
identifiertrueIdentifier# Task Instance Identifier
inputtrueData Type# Information used to perform task
intentfalsecode# proposal | plan | order +
lastModifiedfalsedateTime# C? Task Last Modified Date
notetrueAnnotation# Comments made about the task
outputtrueData Type# Information produced as part of task
ownerfalseReference# "owner" : { Reference(Device|Organization|Patient|Practitioner|
partOftrueReference# Composite task
performerTypetrueCodeableConcept# requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
priorityfalsecode# normal | urgent | asap | stat
reasonfalseCodeableConcept# Why task is needed
relevantHistorytrueReference# Key events in history of the Task
requesterfalseData Type# Who is asking for task to be done
restrictionfalseData Type# Constraints on fulfillment tasks
statusfalsecode# draft | requested | received | accepted | +
statusReasonfalseCodeableConcept# Reason for current status

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 the like so:

https://api.1up.health/fhir/stu3/Task?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authored-ondateauthoredOn
based-onreferencebasedOn
business-statustextbusinessStatus
codetextcode
contextreferencecontext
focusreferencefocus
group-identifiertextgroupIdentifier
identifiertextidentifier
intenttextintent
modifieddatelastModified
organizationreferencerequester.onBehalfOf
ownerreferenceowner
part-ofreferencepartOf
patientreferencefor
performertextperformerType
perioddateexecutionPeriod
prioritytextpriority
requesterreferencerequester.agent
statustextstatus
subjectreferencefor