FHIR Task

The following describes a Task that can be submitted to the Community of Information Exchange. For detailed information, please visit the HL7 FHIR page https://build.fhir.org/task.html .

A Task represents an activity or work that has been done by either a Social Navigator or the CIE Hub itself. For example, the following are examples of FHIR Tasks

Outreach phone call or email was made to connect with a client
A ticket in the social navigator application to do an outreach to provide help to a client

Operations

The following are operations that can be performed and links to

Submit a new FHIR Task
Get a FHIR Task by Task id

Sample Object - OutReach Ticket


{
  "authoredOn": "2024-07-26T15:53:11.531Z",
  "basedOn": [
    {
      "reference": "ServiceRequest/37a41ab2-1234-4e17-9df0-5caeee9ab2e8"
    }
  ],
  "businessStatus": {
    "coding": [
      {
        "code": "FOLLOW-UP",
        "display": "follow up",
        "system": "https://mi-cie.org"
      }
    ]
  },
  "code": {
    "coding": [
      {
        "code": "OutReachTask_v2",
        "display": "Need to do a outreach to the client",
        "system": "https://mi-cie.org"
      }
    ]
  },
  "description": "OutReach Task for social-navigation created for Subject Patient/c0b416bf-1234-48d6-90e9-2f2471358a62",
  "extension": [
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/task-followUpDate",
      "valueString": "2024-07-29"
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/task-requestType",
      "valueString": "FOLLOW-UP"
    },
    {
      "url": "uri::mi-cie.org/requestedperformertask",
      "valueReference": {
        "display": "Megan Janik",
        "reference": "Practitioner/8de6b5a8-e58a-422c-82e9-b03f9089a307",
        "type": "Practitioner"
      }
    }
  ],
  "for": {
    "display": "Kellie Bridges",
    "reference": "Patient/c0b416bf-6e08-48d6-90e9-2f2471358a62"
  },
  "id": "83a4f0c1-f2e9-4731-ad26-2bd89a1d7faa",
  "input": [
    {
      "type": {
        "coding": [
          {
            "code": "purpose",
            "display": "Purpose of task",
            "system": "http://mi-cie.org/task-purpose"
          }
        ]
      },
      "valueString": "social-navigation"
    }
  ],
  "intent": "order",
  "meta": {
    "lastUpdated": "2024-07-29T22:39:23.756809+00:00",
    "versionId": "MTcyMjI5Mjc2Mzc1NjgwOTAwMA"
  },
  "note": [
    {
      "authorReference": {
        "display": "Megan Janik",
        "reference": "Practitioner/8de6b5a8-e58a-422c-82e9-b03f9089a307"
      },
      "text": "funeral expense",
      "time": "2024-07-29T18:39:21-04:00"
    }
  ],
  "owner": {
    "display": "Michigan 211 Gryphon Place",
    "reference": "Organization/MI211-GRYP",
    "type": "Organization"
  },
  "requester": {
    "display": "Children’s Services Agency (CSA)",
    "reference": "Organization/CSA"
  },
  "resourceType": "Task",
  "status": "requested"
}

Sample Object - Call Attempt

{
  "authoredOn": "2024-07-29T17:27:56-04:00",
  "basedOn": [
    {
      "reference": "ServiceRequest/ca7317e0-1234-4b30-a895-f060c1d05c95"
    },
    {
      "reference": "Task/e9591cce-1234-49e2-aad1-27deb964e6eb"
    }
  ],
  "businessStatus": {
    "coding": [
      {
        "code": "ResultPatientAnswered_v2",
        "display": "Client answered",
        "system": "https://mi-cie.org"
      }
    ]
  },
  "code": {
    "coding": [
      {
        "code": "AttemptContactByPhone_v2",
        "display": "Attempt to reach client by phone.",
        "system": "https://mi-cie.org"
      }
    ]
  },
  "description": "Task to document an attempt to contact the subject",
  "extension": [
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/modified-by-user",
      "valueString": "Megan Janik"
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/task-followUpDate",
      "valueString": "2024-08-12"
    },
    {
      "url": "https://mi-cie.org/fhir/StructureDefinition/task-requestType",
      "valueString": "FOLLOW-UP"
    }
  ],
  "for": {
    "display": "Danica Shier",
    "reference": "Patient/eab83cae-1234-4a3f-8e6c-81d5e07f8ba1"
  },
  "id": "7cfbae4e-6036-1234-8c7c-738390f3ffd5",
  "input": [
    {
      "type": {
        "coding": [
          {
            "code": "purpose",
            "system": "http://mi-cie.org/task-purpose"
          }
        ]
      },
      "valueString": "attempt-to-contact"
    }
  ],
  "intent": "order",
  "meta": {
    "lastUpdated": "2024-07-29T21:41:46.214564+00:00",
    "versionId": "MTcyMjI4OTMwNjIxNDU2NDAwMA"
  },
  "note": [
    {
      "authorReference": {
        "display": "Megan Janik",
        "reference": "Practitioner/8de6b5a8-e58a-422c-82e9-b03f9089a307"
      },
      "text": "rent dep, clothing, auto issues",
      "time": "2024-07-29T17:41:44-04:00"
    }
  ],
  "owner": {
    "display": "MI211-GRYPHON PLACE",
    "reference": "Organization/MI211-GRYP"
  },
  "requester": {
    "display": "Megan Janik",
    "reference": "Practitioner/8de6b5a8-e58a-422c-82e9-b03f9089a307"
  },
  "resourceType": "Task",
  "status": "completed"
}

Field Descriptions

The following are descriptions of the fields that must be passed into the task object.

Field	Description	References	Export Header

Field	Description	References	Export Header
authoredOn	The time that the task was created.	https://build.fhir.org/task-definitions.html#Task.authoredOn	authoredOn
basedOn	An array of FHIR resource identifiers is the basis of this task. This is usually a ServiceRequest, but it could be another task. This is how resources can be linked together.	https://build.fhir.org/task-definitions.html#Task.basedOn	basedOn_0_serviceRequestId basedOn_1_taskId
businessStatus	This field represents the task's status. For outreach tasks, this is the status of the Social Navigation ticket, for example, IN-PROGRESS or NEW. For phone attempt tasks, this would represent the outcome of the call. Status is usually tied to the type of task it represents.	https://build.fhir.org/task-definitions.html#Task.businessStatus	businessStatus_coding_0_code (Status Code) businessStatus_coding_0_display (Friendly Name)
code	This is code that describes the type of task that the CIE Hub needs to complete. It can be an outreach to a client or a document of a phone call.	https://build.fhir.org/task-definitions.html#Task.code	code_coding_0_code (Code) code_coding_0_display( Friendly Description of Code) code_coding_0_system (The coding system of record)
description	A description of the task. The system autogenerates this.	Task - FHIR v6.0.0-ballot2	description
extension.closeReason	This will be the reason why outreach tasks were closed. This is set by Social Navigator when closing a task		task_closeReason_0_value_string
extension.task-followUpDate	This extension contains the follow-up date for Social Navigation.		task_followUpDate_0_value_string
for	This is the patient for whom the task is for.	Task - FHIR v6.0.0-ballot2	for_display (Name of patient) for_patientId (Patient id)
input	This represents additional information on the purpose of the task.	Task - FHIR v6.0.0-ballot2	input_0_type_coding_0_code input_0_type_coding_0_system input_0_value_string
intent		Task - FHIR v6.0.0-ballot2	intent
note	A array of comments associated with this Task. This will include the time of the note and the author of the note.	Task - FHIR v6.0.0-ballot2	note_0_author_reference_display (Name of author) note_0_author_reference_practitionerId (id) note_0_text (text of the note) note_0_time (Time of note)
owner	The organization or person responsible for the work to complete this task	Task - FHIR v6.0.0-ballot2	owner_display owner_organizationId owner_type
requester	The organization or person who is requesting that this task be completed.	Task - FHIR v6.0.0-ballot2	requester_display requester_organizationId (If organization is requestor this will be filled in) requester_practitionerId (If practitioner is requestor this will be filled in) requester_type
status	This represents the overall status of this task. It is tied to specific entries in the FHIR spec, whereas the business status is custom to the type of task.	Task - FHIR v6.0.0-ballot2	status