xCaliber healthCare Data Mesh

Task

Overview

The Task resource represents a request for performing an activity such as obtaining measurements, documenting care gaps, fulfilling prior authorizations etc.

Use Cases

  • Care Coordination - Create and assign tasks to care team members to implement care plans.
  • Referral Management - Generate and track referral-related tasks like specialist scheduling.
  • Home Health - Manage tasks for home health nurses and aides during patient visits.
  • Patient Monitoring - Create tasks to follow-up on patient lab results, symptoms reported.
  • Clinic Workflows - Standardize clinic processes into checklists and workflows with tasks.
  • Task Assignment - Assign tasks to appropriate clinical or non-clinical resources based on rules.
  • Patient Engagement - Send patient reminder tasks for care plan adherence.

EHR Data Model

EHRSupported?Mapped Source Object
Athena✅Inbox Tasks
Elation✅N/A
Epic✅N/A

Object Definition

{
  "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"
    }
  },
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeTaskThis is a Task resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedBackboneElementThese 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.
extensionExtensionMay 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.
modifierExtensionExtensionMay 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).
identifierIdentifierThe business identifier for this task.
instantiatesCanonicalcanonicalThe URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
instantiatesUriuriThe URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
basedOnReferenceBasedOn 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.
groupIdentifierIdentifierAn identifier that links together multiple tasks and other requests that were created in the same context.
partOfReferenceTask that this particular task is part of.
statuscodeThe current status of the task.
statusReasonCodeableConceptAn explanation as to why this task is held, failed, was refused, etc.
businessStatusCodeableConceptContains business-specific nuances of the business state.
intentcodeIndicates 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.
prioritycodeIndicates how quickly the Task should be addressed with respect to other requests.
codeCodeableConceptA name or code (or both) briefly describing what the task involves.
descriptionstringA free-text description of what is to be performed.
focusReferenceThe request being actioned or the resource being manipulated by this task.
forReferenceThe entity who benefits from the performance of the service specified in the task (e.g., the patient).
encounterReferenceThe healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
executionPeriodPeriodIdentifies 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).
authoredOndateTimeThe date and time this task was created.
lastModifieddateTimeThe date and time of last modification to this task.
requesterReferenceThe creator of the task.
performerTypeCodeableConceptThe kind of participant that should perform the task.
ownerReferenceIndividual organization or Device currently responsible for task execution.
locationReferencePrincipal physical location where the this task is performed.
reasonCodeCodeableConceptA description or code indicating why this task needs to be performed.
reasonReferenceReferenceA resource reference indicating why this task needs to be performed.
insuranceReferenceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
noteAnnotationFree-text information captured about the task as it progresses.
relevantHistoryReferenceLinks 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.
restrictionBackboneElementIf 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.
restriction.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
restriction.extensionExtensionMay 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.
restriction.modifierExtensionExtensionMay 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).
restriction.repetitionspositiveIntIndicates the number of times the requested action should occur.
restriction.periodPeriodOver what time-period is fulfillment sought.
restriction.recipientReferenceFor requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
inputBackboneElementAdditional information that may be needed in the execution of the task.
input.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
input.extensionExtensionMay 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.
input.modifierExtensionExtensionMay 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).
input.typeCodeableConceptA code or description indicating how the input is intended to be used as part of the task execution.
input.valueBase64BinarystringThe value of the input parameter as a basic type.
input.valueBooleanbooleanThe value of the input parameter as a basic type.
input.valueCanonicalstringThe value of the input parameter as a basic type.
input.valueCodestringThe value of the input parameter as a basic type.
input.valueDatestringThe value of the input parameter as a basic type.
input.valueDateTimestringThe value of the input parameter as a basic type.
input.valueDecimalnumberThe value of the input parameter as a basic type.
input.valueIdstringThe value of the input parameter as a basic type.
input.valueInstantstringThe value of the input parameter as a basic type.
input.valueIntegernumberThe value of the input parameter as a basic type.
input.valueMarkdownstringThe value of the input parameter as a basic type.
input.valueOidstringThe value of the input parameter as a basic type.
input.valuePositiveIntnumberThe value of the input parameter as a basic type.
input.valueStringstringThe value of the input parameter as a basic type.
input.valueTimestringThe value of the input parameter as a basic type.
input.valueUnsignedIntnumberThe value of the input parameter as a basic type.
input.valueUristringThe value of the input parameter as a basic type.
input.valueUrlstringThe value of the input parameter as a basic type.
input.valueUuidstringThe value of the input parameter as a basic type.
input.valueAddressAddressThe value of the input parameter as a basic type.
input.valueAgeAgeThe value of the input parameter as a basic type.
input.valueAnnotationAnnotationThe value of the input parameter as a basic type.
input.valueAttachmentAttachmentThe value of the input parameter as a basic type.
input.valueCodeableConceptCodeableConceptThe value of the input parameter as a basic type.
input.valueCodingCodingThe value of the input parameter as a basic type.
input.valueContactPointContactPointThe value of the input parameter as a basic type.
input.valueCountCountThe value of the input parameter as a basic type.
input.valueDistanceDistanceThe value of the input parameter as a basic type.
input.valueDurationDurationThe value of the input parameter as a basic type.
input.valueHumanNameHumanNameThe value of the input parameter as a basic type.
input.valueIdentifierIdentifierThe value of the input parameter as a basic type.
input.valueMoneyMoneyThe value of the input parameter as a basic type.
input.valuePeriodPeriodThe value of the input parameter as a basic type.
input.valueQuantityQuantityThe value of the input parameter as a basic type.
input.valueRangeRangeThe value of the input parameter as a basic type.
input.valueRatioRatioThe value of the input parameter as a basic type.
input.valueReferenceReferenceThe value of the input parameter as a basic type.
input.valueSampledDataSampledDataThe value of the input parameter as a basic type.
input.valueSignatureSignatureThe value of the input parameter as a basic type.
input.valueTimingTimingThe value of the input parameter as a basic type.
input.valueContactDetailContactDetailThe value of the input parameter as a basic type.
input.valueContributorContributorThe value of the input parameter as a basic type.
input.valueDataRequirementDataRequirementThe value of the input parameter as a basic type.
input.valueExpressionExpressionThe value of the input parameter as a basic type.
input.valueParameterDefinitionParameterDefinitionThe value of the input parameter as a basic type.
input.valueRelatedArtifactRelatedArtifactThe value of the input parameter as a basic type.
input.valueTriggerDefinitionTriggerDefinitionThe value of the input parameter as a basic type.
input.valueUsageContextUsageContextThe value of the input parameter as a basic type.
input.valueDosageDosageThe value of the input parameter as a basic type.
input.valueMetaMetaThe value of the input parameter as a basic type.
outputBackboneElementOutputs produced by the Task.
output.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
output.extensionExtensionMay 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.
output.modifierExtensionExtensionMay 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).
output.typeCodeableConceptThe name of the Output parameter.
output.valueBase64BinarystringThe value of the Output parameter as a basic type.
output.valueBooleanbooleanThe value of the Output parameter as a basic type.
output.valueCanonicalstringThe value of the Output parameter as a basic type.
output.valueCodestringThe value of the Output parameter as a basic type.
output.valueDatestringThe value of the Output parameter as a basic type.
output.valueDateTimestringThe value of the Output parameter as a basic type.
output.valueDecimalnumberThe value of the Output parameter as a basic type.
output.valueIdstringThe value of the Output parameter as a basic type.
output.valueInstantstringThe value of the Output parameter as a basic type.
output.valueIntegernumberThe value of the Output parameter as a basic type.
output.valueMarkdownstringThe value of the Output parameter as a basic type.
output.valueOidstringThe value of the Output parameter as a basic type.
output.valuePositiveIntnumberThe value of the Output parameter as a basic type.
output.valueStringstringThe value of the Output parameter as a basic type.
output.valueTimestringThe value of the Output parameter as a basic type.
output.valueUnsignedIntnumberThe value of the Output parameter as a basic type.
output.valueUristringThe value of the Output parameter as a basic type.
output.valueUrlstringThe value of the Output parameter as a basic type.
output.valueUuidstringThe value of the Output parameter as a basic type.
output.valueAddressAddressThe value of the Output parameter as a basic type.
output.valueAgeAgeThe value of the Output parameter as a basic type.
output.valueAnnotationAnnotationThe value of the Output parameter as a basic type.
output.valueAttachmentAttachmentThe value of the Output parameter as a basic type.
output.valueCodeableConceptCodeableConceptThe value of the Output parameter as a basic type.
output.valueCodingCodingThe value of the Output parameter as a basic type.
output.valueContactPointContactPointThe value of the Output parameter as a basic type.
output.valueCountCountThe value of the Output parameter as a basic type.
output.valueDistanceDistanceThe value of the Output parameter as a basic type.
output.valueDurationDurationThe value of the Output parameter as a basic type.
output.valueHumanNameHumanNameThe value of the Output parameter as a basic type.
output.valueIdentifierIdentifierThe value of the Output parameter as a basic type.
output.valueMoneyMoneyThe value of the Output parameter as a basic type.
output.valuePeriodPeriodThe value of the Output parameter as a basic type.
output.valueQuantityQuantityThe value of the Output parameter as a basic type.
output.valueRangeRangeThe value of the Output parameter as a basic type.
output.valueRatioRatioThe value of the Output parameter as a basic type.
output.valueReferenceReferenceThe value of the Output parameter as a basic type.
output.valueSampledDataSampledDataThe value of the Output parameter as a basic type.
output.valueSignatureSignatureThe value of the Output parameter as a basic type.
output.valueTimingTimingThe value of the Output parameter as a basic type.
output.valueContactDetailContactDetailThe value of the Output parameter as a basic type.
output.valueContributorContributorThe value of the Output parameter as a basic type.
output.valueDataRequirementDataRequirementThe value of the Output parameter as a basic type.
output.valueExpressionExpressionThe value of the Output parameter as a basic type.
output.valueParameterDefinitionParameterDefinitionThe value of the Output parameter as a basic type.
output.valueRelatedArtifactRelatedArtifactThe value of the Output parameter as a basic type.
output.valueTriggerDefinitionTriggerDefinitionThe value of the Output parameter as a basic type.
output.valueUsageContextUsageContextThe value of the Output parameter as a basic type.
output.valueDosageDosageThe value of the Output parameter as a basic type.
output.valueMetaMetaThe value of the Output parameter as a basic type.

Extensions

NameURL
ABNORMALCOUNThttp://xcaliber-fhir/structureDefinition/abnormal-count
COUNThttp://xcaliber-fhir/structureDefinition/count
CRITICALCOUNThttp://xcaliber-fhir/structureDefinition/critical-count
INBOXCATEGORYhttp://xcaliber-fhir/structureDefinition/inbox-category

Operations & APIs

Task-GET

Task-POST

Task ID-GET

Task ID-PUT

Task ID-DELETE

Previous
Slot-POST
Next
Task-GET