Retrieve Tasks for a User

Retrieving User Tasks

Overview

The getTasks method in the b.well SDK is designed for retrieving personalized tasks for users, which can include general health activities, user specific care needs, or next best actions. These tasks are FHIR-compliant and can be linked to other FHIR resources or external content.

Method Signature

suspend fun getTasks(request: TasksRequest): BWellResult<Task>

• request: A TasksRequest object containing search criteria.
• BWellResult<Task>: Returns a collection of FHIR Task resources, FHIR OperationOutcome, and paging information.

TasksRequest Object

The TasksRequest object facilitates precise task searches with various parameters:

1. Id: Filters to a specific Task with the given ID, if provided.
2. ActivityId: Narrows results to Tasks based on listed ActivityDefinition IDs, if provided.
3. ActivityType: Filters Tasks that match provided activity type codes, if provided.
4. ActivityTopic: Focuses on Tasks with matching topic codes, if provided.
5. Status: Searches for Tasks with a specified status. Tasks that should be displayed to a user as prompts for action typically have the status READY. Please reference Update Task Status for a full list of supported status values.
6. EnrichContent: If true, retrieves related CMS content, adding it to the Task's extension field.
7. SmartSort: Enables prioritization of Tasks for improved user consumption.
8. ContentLanguage: Specifies the language of the content to be searched.

Please note that in some cases, search options must be used in combination in order to return results. For example:

• When using .enrichContent(true) you must also search by .id("taskId") or .activityId("activityId") to return specific extension elements (see below Content Extension Elements for more detail)
• When requesting translated content by using a parameter such as .contentLanguage("es") you must also include .enrichContent(true) in order for the retrieved content to be translated.

Example Usage

The following is an example of a common implementation of the getTasks method.

First, getTasks is called to retrieve a list of tasks (aka activities) for the given user.

Once the list is retrieved, getTasks can then be used to retrieve details about a specific task.

// Retrieve all tasks for a user
private fun getTasks() {
        val taskRequest = TasksRequest.Builder() // Build the task request
            .smartSort(true) // sort list based on prioritization
            .status(listOf(TaskStatus.READY)) // retrieve tasks of status READY
            .page(0)
            .pageSize(100)
            .build()
        healthJourneyViewModel.getTasks(taskRequest)
        viewLifecycleOwner.lifecycleScope.launch {
            healthJourneyViewModel.taskResults.collect { result ->
                if (result != null) {
                    Log.e("result","health journey result>>>>>>>>>>>>>>> "+result)
                    setAdapter(result)
                }
            }
        }
    }

// Retrieve details of a specific task
private fun showDetails() {
        val request = TasksRequest.Builder()
            .id(taskId) // Retrieve a specific task based on the taskId returned above. activityId can also be used.
            .enrichContent(true) // Include task details
            .build()
        healthJourneyViewModel.getTasks(request)
        viewLifecycleOwner.lifecycleScope.launch {
            healthJourneyViewModel.taskResults.collect { result ->
                if (result != null) {
                    when (result) {
                        is BWellResult.ResourceCollection -> {
                            val dataList = result.data
                            for (i in 0 until (dataList?.size ?: 0)) {
                                val task = dataList?.get(i)

Understanding the Task Object in b.well SDK

Overview

The Task object in the b.well SDK represents a task to be performed, encapsulating various details and attributes related to healthcare tasks.

Properties and Types

• resourceType (String): Type of the FHIR resource.
• id (String): Unique identifier of the Task.
• identifier (List<Identifier>): Task Instance Identifiers.
  • Includes activityId, activityName, activityTitle, sourceId, uuid.
• code (CodeableConcept): Task activityType.
• meta (Meta): Metadata about the Task.
  • Includes activityClass in meta.tag.
• extension (List<Extension>): Optional Extensions Element.
• instantiatesCanonical (String): Formal definition of the task.
• status (TaskStatus): Current status of the task.
• description (String): Human-readable explanation of the task.
• executionPeriod (Period): Start and end time of task execution.
• lastModified (Date): Task Last Modified Date.
• basedOn (List<Reference>): Request fulfilled by this task.
• focus (Reference): Focus of the task.
• for (Reference): Beneficiary of the Task.

Task activityType and activityClass

The Task activityType declares the type of activity of the task.
The Task activityClass further identifies the specific topic of the task. Found in meta.tag.

The following table outlines the specific activityType and activityClass that can be expected.

Tasks extension Element

Overview

The getTasks method in the b.well SDK includes task extensions that enrich task data with visual elements and interactive features.

Image/Icon URLs

• Content Image and Icon: URLs for images and icons are provided via the API with a time-limited security key for S3 bucket access.
• Timely Retrieval: It's essential to retrieve and use these URLs shortly after fetching the Task (preferably within minutes) as the access expires. Avoid holding onto these URLs for long-term use.

Insights and Layout

• Current Format: All Insights, such as Care Needs, Health Activities, and Next Best Actions, follow the same format.
• Layout Components:
  1. Image (contentImage): Visual representation.
  2. Title (identifier/activityTitle): Descriptive title of the task.
  3. Description (contentDescription): Detailed explanation.
  4. Call to Action Button (contentButtonText): For MVP Insights, this button indicates an intent to perform the activity, changing to a success message upon completion. Future Insights may redirect users within the app for task completion.
  5. References (contentReferences): Additional resources, shown only when available.

Future Considerations

• Video Links: Guidance on handling video links will be provided if they are included in future tasks and Insights. Currently, no MVP Insights involve video links.

Content Extension Definitions