Task - FHIR Resource (r4)


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

Validate an Task FHIR Resource (r4)



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
descriptionfalsestring# Human-readable explanation of task
encounterfalseReference# Healthcare event during which this task originated
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
instantiatesCanonicalfalsecanonical(ActivityDefinition)# Formal definition of task
instantiatesUrifalseuri# Formal definition of task
insurancetrueReference# Associated insurance coverage
intentfalsecode# unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
lastModifiedfalsedateTime# C? Task Last Modified Date
locationfalseReference# Where task occurs
notetrueAnnotation# Comments made about the task
outputtrueData Type# Information produced as part of task
ownerfalseReference# "owner" : { Reference(Practitioner|PractitionerRole|Organization|CareTeam|
partOftrueReference# Composite task
performerTypetrueCodeableConcept# Requested performer
priorityfalsecode# routine | urgent | asap | stat
reasonCodefalseCodeableConcept# Why task is needed
reasonReferencefalseReference# Why task is needed
relevantHistorytrueReference# Key events in history of the Task
requesterfalseReference# "requester" : { Reference(Device|Organization|Patient|Practitioner|
restrictionfalseData Type# Constraints on fulfillment tasks
statusfalsecode# draft | requested | received | accepted | +
statusReasonfalseCodeableConcept# Reason for current status

Task Example

{
  "resourceType": "Task",
  "id": "example1",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example1</p><p><b>contained</b>: </p><p><b>identifier</b>: 20170201-001 (OFFICIAL)</p><p><b>basedOn</b>: General Wellness Careplan</p><p><b>groupIdentifier</b>: G20170201-001 (OFFICIAL)</p><p><b>status</b>: in-progress</p><p><b>businessStatus</b>: waiting for specimen <span>(Details )</span></p><p><b>intent</b>: order</p><p><b>priority</b>: routine</p><p><b>code</b>: Lipid Panel <span>(Details )</span></p><p><b>description</b>: Create order for getting specimen, Set up inhouse testing,  generate order for any sendouts and submit with specimen</p><p><b>focus</b>: <a>Lipid Panel Request</a></p><p><b>for</b>: <a>Peter James Chalmers</a></p><p><b>encounter</b>: <a>Example In-Patient Encounter</a></p><p><b>executionPeriod</b>: 31/10/2016 8:25:05 AM --&gt; (ongoing)</p><p><b>authoredOn</b>: 31/10/2016 8:25:05 AM</p><p><b>lastModified</b>: 31/10/2016 9:45:05 AM</p><p><b>requester</b>: <a>Dr Adam Careful</a></p><p><b>performerType</b>: Performer <span>(Details : {http://terminology.hl7.org/CodeSystem/task-performer-type code 'performer' = 'performer', given as 'Performer'})</span></p><p><b>owner</b>: <a>Clinical Laboratory @ Acme Hospital</a></p><p><b>reasonCode</b>: The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus <span>(Details )</span></p><p><b>note</b>: This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test </p><p><b>relevantHistory</b>: Author's Signature. Generated Summary: id: signature; recorded: 31/10/2016 8:25:05 AM; </p><h3>Restrictions</h3><table><tr><td>-</td><td><b>Repetitions</b></td><td><b>Period</b></td></tr><tr><td>*</td><td>1</td><td>?? --&gt; 02/11/2016 9:45:05 AM</td></tr></table></div>"
  },
  "contained": [
    {
      "resourceType": "Provenance",
      "id": "signature",
      "target": [
        {
          "reference": "ServiceRequest/physiotherapy/_history/1"
        }
      ],
      "recorded": "2016-10-31T08:25:05+10:00",
      "agent": [
        {
          "role": [
            {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
                  "code": "AUT"
                }
              ]
            }
          ],
          "who": {
            "reference": "Practitioner/f202",
            "display": "Luigi Maas"
          }
        }
      ],
      "signature": [
        {
          "type": [
            {
              "system": "urn:iso-astm:E1762-95:2013",
              "code": "1.2.840.10065.1.12.1.1",
              "display": "Author's Signature"
            }
          ],
          "when": "2016-10-31T08:25:05+10:00",
          "who": {
            "reference": "Practitioner/example",
            "display": "Dr Adam Careful"
          },
          "targetFormat": "application/fhir+xml",
          "sigFormat": "application/signature+xml",
          "data": "dGhpcyBibG9iIGlzIHNuaXBwZWQ="
        }
      ]
    }
  ],
  "identifier": [
    {
      "use": "official",
      "system": "http:/goodhealth.org/identifiers",
      "value": "20170201-001"
    }
  ],
  "basedOn": [
    {
      "display": "General Wellness Careplan"
    }
  ],
  "groupIdentifier": {
    "use": "official",
    "system": "http:/goodhealth.org/accession/identifiers",
    "value": "G20170201-001"
  },
  "status": "in-progress",
  "businessStatus": {
    "text": "waiting for specimen"
  },
  "intent": "order",
  "priority": "routine",
  "code": {
    "text": "Lipid Panel"
  },
  "description": "Create order for getting specimen, Set up inhouse testing,  generate order for any sendouts and submit with specimen",
  "focus": {
    "reference": "ServiceRequest/lipid",
    "display": "Lipid Panel Request"
  },
  "for": {
    "reference": "Patient/example",
    "display": "Peter James Chalmers"
  },
  "encounter": {
    "reference": "Encounter/example",
    "display": "Example In-Patient Encounter"
  },
  "executionPeriod": {
    "start": "2016-10-31T08:25:05+10:00"
  },
  "authoredOn": "2016-10-31T08:25:05+10:00",
  "lastModified": "2016-10-31T09:45:05+10:00",
  "requester": {
    "reference": "Practitioner/example",
    "display": "Dr Adam Careful"
  },
  "performerType": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/task-performer-type",
          "code": "performer",
          "display": "Performer"
        }
      ],
      "text": "Performer"
    }
  ],
  "owner": {
    "reference": "Organization/1832473e-2fe0-452d-abe9-3cdb9879522f",
    "display": "Clinical Laboratory @ Acme Hospital"
  },
  "reasonCode": {
    "text": "The Task.reason should only be included if there is no Task.focus or if it differs from the reason indicated on the focus"
  },
  "note": [
    {
      "text": "This is an example to demonstrate using task for actioning a servicerequest and to illustrate how to populate many of the task elements - this is the parent task that will be broken into subtask to grab the specimen and a sendout lab test "
    }
  ],
  "relevantHistory": [
    {
      "reference": "#signature",
      "display": "Author's Signature"
    }
  ],
  "restriction": {
    "repetitions": 1,
    "period": {
      "end": "2016-11-02T09:45:05+10:00"
    }
  }
}

Task Structure

{
  "resourceType" : "Task",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Task Instance Identifier
  "instantiatesCanonical" : { canonical(ActivityDefinition) }, // Formal definition of task
  "instantiatesUri" : "<uri>", // Formal definition of task
  "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!  unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | 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
  "encounter" : { Reference(Encounter) }, // 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" : { Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) }, // Who is asking for task to be done
  "performerType" : [{ CodeableConcept }], // Requested performer
  "owner" : { Reference(Practitioner|PractitionerRole|Organization|CareTeam|
   HealthcareService|Patient|Device|RelatedPerson) }, // Responsible individual
  "location" : { Reference(Location) }, // Where task occurs
  "reasonCode" : { CodeableConcept }, // Why task is needed
  "reasonReference" : { Reference(Any) }, // Why task is needed
  "insurance" : [{ Reference(Coverage|ClaimResponse) }], // Associated insurance coverage
  "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|PractitionerRole|
    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 50:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>
    "valueCanonical" : "<canonical>"
    "valueCode" : "<code>"
    "valueDate" : "<date>"
    "valueDateTime" : "<dateTime>"
    "valueDecimal" : <decimal>
    "valueId" : "<id>"
    "valueInstant" : "<instant>"
    "valueInteger" : <integer>
    "valueMarkdown" : "<markdown>"
    "valueOid" : "<oid>"
    "valuePositiveInt" : "<positiveInt>"
    "valueString" : "<string>"
    "valueTime" : "<time>"
    "valueUnsignedInt" : "<unsignedInt>"
    "valueUri" : "<uri>"
    "valueUrl" : "<url>"
    "valueUuid" : "<uuid>"
    "valueAddress" : { Address }
    "valueAge" : { Age }
    "valueAnnotation" : { Annotation }
    "valueAttachment" : { Attachment }
    "valueCodeableConcept" : { CodeableConcept }
    "valueCoding" : { Coding }
    "valueContactPoint" : { ContactPoint }
    "valueCount" : { Count }
    "valueDistance" : { Distance }
    "valueDuration" : { Duration }
    "valueHumanName" : { HumanName }
    "valueIdentifier" : { Identifier }
    "valueMoney" : { Money }
    "valuePeriod" : { Period }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
    "valueRatio" : { Ratio }
    "valueReference" : { Reference }
    "valueSampledData" : { SampledData }
    "valueSignature" : { Signature }
    "valueTiming" : { Timing }
    "valueContactDetail" : { ContactDetail }
    "valueContributor" : { Contributor }
    "valueDataRequirement" : { DataRequirement }
    "valueExpression" : { Expression }
    "valueParameterDefinition" : { ParameterDefinition }
    "valueRelatedArtifact" : { RelatedArtifact }
    "valueTriggerDefinition" : { TriggerDefinition }
    "valueUsageContext" : { UsageContext }
    "valueDosage" : { Dosage }
    "valueMeta" : { Meta }
  }],
  "output" : [{ // Information produced as part of task
    "type" : { CodeableConcept }, // R!  Label for output
    // value[x]: Result of output. One of these 50:
    "valueBase64Binary" : "<base64Binary>"
    "valueBoolean" : <boolean>
    "valueCanonical" : "<canonical>"
    "valueCode" : "<code>"
    "valueDate" : "<date>"
    "valueDateTime" : "<dateTime>"
    "valueDecimal" : <decimal>
    "valueId" : "<id>"
    "valueInstant" : "<instant>"
    "valueInteger" : <integer>
    "valueMarkdown" : "<markdown>"
    "valueOid" : "<oid>"
    "valuePositiveInt" : "<positiveInt>"
    "valueString" : "<string>"
    "valueTime" : "<time>"
    "valueUnsignedInt" : "<unsignedInt>"
    "valueUri" : "<uri>"
    "valueUrl" : "<url>"
    "valueUuid" : "<uuid>"
    "valueAddress" : { Address }
    "valueAge" : { Age }
    "valueAnnotation" : { Annotation }
    "valueAttachment" : { Attachment }
    "valueCodeableConcept" : { CodeableConcept }
    "valueCoding" : { Coding }
    "valueContactPoint" : { ContactPoint }
    "valueCount" : { Count }
    "valueDistance" : { Distance }
    "valueDuration" : { Duration }
    "valueHumanName" : { HumanName }
    "valueIdentifier" : { Identifier }
    "valueMoney" : { Money }
    "valuePeriod" : { Period }
    "valueQuantity" : { Quantity }
    "valueRange" : { Range }
    "valueRatio" : { Ratio }
    "valueReference" : { Reference }
    "valueSampledData" : { SampledData }
    "valueSignature" : { Signature }
    "valueTiming" : { Timing }
    "valueContactDetail" : { ContactDetail }
    "valueContributor" : { Contributor }
    "valueDataRequirement" : { DataRequirement }
    "valueExpression" : { Expression }
    "valueParameterDefinition" : { ParameterDefinition }
    "valueRelatedArtifact" : { RelatedArtifact }
    "valueTriggerDefinition" : { TriggerDefinition }
    "valueUsageContext" : { UsageContext }
    "valueDosage" : { Dosage }
    "valueMeta" : { Meta }
  }]
}

Task Search Parameters

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

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