Skip to content

Latest commit

 

History

History
376 lines (222 loc) · 19.6 KB

RELEASE-NOTES.md

File metadata and controls

376 lines (222 loc) · 19.6 KB
Raw

CareKit Release Notes

CareKit 3.0 Release Notes

CareKit 3.0 supports iOS and watchOS and requires Xcode 14.0 or later. The minimum supported Base SDK is 13.0 for iOS and 6.0 for watchOS.

CareKit 3.0 includes the following new features and enhancements by Apple Inc. (https://github.com/carekit-apple)

Major API Changes

The following types have been deprecated:

Aggregators

  • OCKAdherenceAggregator
  • OCKEventAggregator

View Synchronizers

  • OCKCalendarViewSynchronizerProtocol
  • OCKChartViewSynchronizerProtocol
  • OCKAnyContactViewSynchronizerProtocol
  • OCKContactViewSynchronizerProtocol
  • OCKAnyTaskViewSynchronizerProtocol
  • OCKTaskViewSynchronizerProtocol

The following types are now unavailable:

Controllers

  • OCKTaskController
  • OCKInstructionsTaskController
  • OCKSimpleTaskController
  • OCKCalendarController
  • OCKContactController
  • OCKChartController
  • OCKCartesianChartController
  • OCKDetailedContactController
  • OCKSimpleContactController
  • OCKNumericProgressTaskController
  • OCKButtonLogTaskController
  • OCKChecklistTaskController
  • OCKGridTaskController
  • OCKLabeledValueTaskController
  • OCKWeekCalendarController

Notifications

  • OCKStoreNotification
  • OCKStoreNotificationCategory
  • OCKPatientNotification
  • OCKCarePlanNotification
  • OCKContactNotification
  • OCKTaskNotification
  • OCKOutcomeNotification
  • OCKUnknownChangeNotification
  • OCKSynchronizedStoreManager
  • OCKCarePlanStoreDelegate
  • OCKContactStoreDelegate
  • OCKOutcomeStoreDelegate
  • OCKPatientStoreDelegate
  • OCKTaskStoreDelegate

SwiftUI Support

  • Adds a SwiftUI state property that retrieves and stays synchronized with data in a care store (CareStoreFetchRequest).

  • Adds the ability to pass a care store through the SwiftUI environment. Accessing the store in the environment without first setting it will trigger a runtime crash.

  • Adds new types for results fetched from a care store (CareStoreFetchedResults, CareStoreFetchedResult).

  • Adds convenience initializers for CareKitUI views using data fetched from a care store (InstructionsTaskView, SimpleTaskView, LabeledValueTaskView, NumericProgressTaskView)

UIKit View Controllers

  • Initializers that previously required a synchronized store manager now require a store that conforms to OCKAnyStoreProtocol instead.

  • Removes the concept of a controller from the view controllers that display care data. The responsibilities previously handled by the controller are now handled by the view controllers and the streams outputting live data from the care store.

  • Adds initialization parameters to a few view controllers that allow for specifying a task progress computation strategy for a particular task (EX: OCKWeekCalendarPageViewController).

  • Individual view synchronizers have been replaced with a single protocol (OCKViewSynchronizing) with requirements for synchronizing a UIKit view with data fetched from the care store.

  • Initializers that previously accepted an adherence aggregator now require a closure that's used to compute task progress instead.

  • View controllers that display data from a care store now subclass SynchronizedViewController. This class can be subclassed to create a custom view controller that is synchronized with data in a care store.

Store

  • Adds the ability to stream data from a care store using Swift Concurrency (CareStoreQueryResults). Data can either be streamed from Core Data (OCKStore) or HealthKit (OCKHealthKitPassthroughStore).

  • Removes the OCKSynchronizedStoreManager as mechanism for synchronizing with data in the care store. Changes can now be observed using async streams available on a store directly (EX: store.tasks(query:)).

  • Adds a new type CareTaskProgress that can be used for computing task progress. The new type replaces the adherence and event aggregators. See OCKAnyEvent.computeProgress(strategy:) for more info.

  • Adds a new type AggregatedCareTaskProgress that can be used for aggregating task progress. The new type is especially useful for populating progress bars.

  • Improvements to storing outcomes in the OCKStore.

  • Improvement to fetching events from the OCKStore

  • When previously fetching events from the OCKStore, events were returned if they were fully contained in the query interval. That is, if they started after the start of the interval and ended before the end of the interval. Now events are returned if they occur at any point in the query interval.

  • When previously fetching events and outcomes, an outcome was returned if it was the newest version in the query interval. Now the most recent version of an outcome whose event occurs in the query interval is returned.

  • Adds new requirements to protocols such as OCKAnyCarePlan, OCKAnyContact, OCKAnyOutcome, OCKAnyPatient, and the individual store protocols.

  • OCKEvent now conforms to Equatable.

  • The OCKEventQuery now has additional properties useful for filtering tasks (taskIDs, taskGroupIdentifiers, taskTags).

  • The default duration for an OCKScheduleElement has been changed from zero seconds to one hour.

UI

  • Only the headers for each view are generic and customizable.
  • Minor bug fixes and accessibility improvements.

Project

  • Removes SPM support for MacOS.

  • There is now a single multi-platform target for each framework, instead of a unique target for each platform.

  • Adds a configuration (.xcconfig) file that is shared across framework targets.

CareKit 2.1 Release Notes

CareKit 2.1 supports iOS and watchOS and requires Xcode 12.0 or later. The minimum supported Base SDK is 13.0 for iOS and 7.0 for watchOS.

CareKit 2.1 includes the following new features and enhancements by Apple Inc. (https://github.com/carekit-apple)

New Views

  • SimpleTaskView (SwiftUI)
  • InstructionsTaskView (SwiftUI)
  • LabeledValueTaskView (SwiftUI)
  • NumericProgressTaskView (SwiftUI)
  • LinkView (SwiftUI)
  • OCKFeaturedContentView (UIKit)
  • DetailView enhancements (UIKit)

watchOS Support

  • CareKit, CareKitUI, CareKitStore and the new CareKitFHIR now build for watchOS

HealthKit Driven Tasks

  • HealthKit data can now be used to autocomplete CareKit tasks
  • OCKStoreCoordinator
  • OCKHealthKitPassthroughStore
  • OCKHealthKitTask & OCKHealthKitOutcome

FHIR Compatibility

  • A new package, CareKitFHIR, for converting to and from FHIR resources
  • Support for DSTU2 Patient, CarePlanActivity, and MedicationOrder resources
  • Support for R4 Patient resources

Remote Synchronization

  • Extension on OCKStore for synchronization with a remote server
  • OCKRemoteSynchronizable protocol for adding new integrations
  • OCKWatchConnectivityPeer for synchronizing a store on watchOS with a store on iOS

Miscellaneous

  • Updated sample app
  • Enhanced catalog app
  • Minor bug fixes

CareKit 2.0 Release Notes

CareKit 2.0 supports iOS and requires Xcode 11.0 or later. The minimum supported Base SDK is 13.0. CareKit 2.0 includes the following new features and enhancements by Apple Inc. (https://github.com/carekit-apple)

  • New Architecture

CareKit 2.0 has been rewritten from the ground up entirely in Swift 5. The new architecture has been reconstructed to allow for maximum customization and modularity. Splitting the framework out into various layers now enables users to tailor-make their care apps to the desired look and feel for their users.

  • CareKitUI

Now a whole new separate project inside the CareKit repository, CareKitUI can be compiled and imported as a stand-alone framework without any dependencies on CareKit or the CareKitStore. CareKitUI consists of prepackaged views that developers can easily embed anywhere within their apps and populate it with personalized content.

  • CareKitStore

Just like CareKitUI, the CareKitStore too can be imported in as a stand-alone framework without any dependencies. Built as a wrapper on top of CoreData, the CareKitStore offers an on-device datastore that is exclusive to your app. It comes with a predefined schema that facilitates persistence of Care Plans and associated Tasks. Developers can choose to update and modify the schema depending on their individual use cases.

  • CareKit

CareKit, the framework, imports CareKitUI and CareKitStore under the hood. CareKit is all about providing complete synchronization between the UI and the underlying database and this synchronization is powered by the all new Combine feature available in Swift 5. Another key highlight of CareKit is its modularity. This modularity gives developers the freedom to utilize the CareKitStore or plug-in their own custom store that conforms to the OCKStore protocol in order to leverage the synchronization functionality for free. Additionally, developers can now use custom views or inject custom views that conform to our protocols to get the synchronization functionality at no cost.

  • Tasks

The two entities previously know as Assessments and Interventions have been collapsed into a single Task entity. Tasks can be displayed in cards using any of a number of styles. Task card styles exist for a number of common use cases, simple tasks that only need to be performed once, tasks that should be performed several times, and tasks that can be performed any number of times.

  • Charts

CareKit offers views and view controllers that display charts. The views can be styled and filled with custom data, and support multiple data series. The view controllers fetch and display data in the view, and update the view when the data changes. CareKit currently supports line, scatter, and bar charts.

  • Contacts

CareKit offers views and view controllers that display contacts. The views can be styled and filled with custom data. The view controllers fetch and display data in the view, and update the view when the data changes. CareKit currently supports a simple and detailed contact view.

  • List View Controllers

CareKit provides higher order view controllers that easily fetch and display data in a store. The first is a view controller that displays tasks and completion for a given day in the week. The second is a list of contacts.

  • Styling

All CareKit views can be easily styled for a custom user interface by injecting a list of style constants. Views inherit the style of their parent, making it easy to quickly style or brand an app.

  • Updated Database Schema

The database schema has been updated to handle new care-centric data types. The store now models Patients, Care Plans, Contacts, Tasks, Schedules, Outcomes, Outcome Values, and Notes. The store has been reinvented as an append only versioned database, and now allows you to keep a fully versioned history of key records.

  • Scheduling

Task scheduling has been greatly improved in CareKit 2.0. It is now possible to create arbitrarily complex and precise schedules.

  • Sample App

The Sample App (OCKSample project in CareKit's workspace) serves as a template application that combines different modules from the CareKit framework. It's a great starting point for your own CareKit apps.

  • Catalog App

The Catalog App (OCKCatalog project in CareKit's workspace) showcases the views and controllers available in CareKit. It's an excellent reference for the visual building blocks available in CareKit, and is useful for designers and engineers who want to know what building blocks are available to them.

CareKit 1.2 Release Notes

CareKit 1.2 supports iOS and requires Xcode 8.0 or later. The minimum supported Base SDK is 9.0. CareKit 1.2 includes the following new features and enhancements by Apple Inc.

  • Care Contents Card

The Sample App (OCKSample project in CareKit's workspace) now includes a Care Contents view controller, which allows for activities and interventions to be seen in the same place. You may still choose to use the *Care Card *and Symptom Tracker view controllers independently to separate out care “to-do’s” and measurement tracking if desired.

  • Optional Activities

Intervention and assessment activity types can now be tagged as “optional”. Completion of optional activities do not contribute to a user’s daily completion goals, and are well suited for “take as needed” care activities – such as pain medications or optional physical activities.

  • Read Only Activity Type

You can now create a new class of activity called “read only” by utilizing the ReadOnly initializer. Read only activities can be used to display information which do not require any action from the user. Examples can include day-of-surgery dietary instructions, or tricks and tips that might be interesting to share throughout a user’s care journey.

  • Updated Header View and 28 Glyph Icons

The header view across Care Card, Symptom Tracker and the New Care Contents has been updated to display a daily ring view with customizable glyphs inside to represent completion of care activities. The Apple team has designed 28 icons that can be used within the ring view, and are compatible as Apple Watch complications. Once a user reaches 100%, the ring will fill in and a star badge will appear to easily identify days of full compliance.

  • Updated Insights Tab with Thresholds

The Insights view controller has been updated to include the ability to display thresholds. You can now set thresholds in your assessment or intervention activities, and display alert UI and tint colors on the Insights view controller if thresholds are broken.

  • Inbox Feature in Connect

We’ve updated the Inbox view controller to include UI for messaging between consumers and care teams, friends, and family members. Developers can choose to include this functionality in use cases where asynchronous messaging might play a crucial role in a consumer’s care journey.

  • Cloud Bridge API

We’re making data sharing between CareKit apps even easier with the new addition of our Cloud Bridge API. The bridge API is an Abstract cloud API that conforms to the CareKit schema and enables data syncing without any additional configuration. It’s designed to allow CareKit based apps to seamlessly integrate with backend cloud solutions, and is based upon the current CareKit data model and architecture The bridge API provides all of the necessary hooks through delegate functions for cloud bridge’s to seamlessly hook into the CareKit framework, allowing developers or current cloud providers to conform to the CareKit schema with reduced effort and create backend solutions that fit directly into the current framework architecture.

CareKit 1.1 Release Notes

CareKit 1.1 supports iOS and requires Xcode 8.0 or later. The minimum supported Base SDK is 9.0.

CareKit 1.1 includes the following new features and enhancements.

  • Care Card on Apple Watch

Contributed by Apple Inc..

The Sample App (OCKSample project in CareKit's workspace) now includes a watch app. The app works out of the box. Included in the Watch group is the Watch Connectivity Manager which abstracts the logic of communicating the Care Card data between the phone and the watch.

The Care Plan Store has also been updated to support Apple Watch.

  • New Test App

Contributed by Apple Inc..

The New Test App is written entirely in Swift and provides extensive coverage for all CareKit Modules.

  • Other Improvements

  • 3D Touch Support

Contributed by Troy Tsubota.

The Care Card and Connect view controllers have been updated to support 3D Touch. In the Care Card view controller, a user can 3D Touch on an activity to peek and pop. In the Connect view controller, a user can peek, pop, and use perform actions right from the master screen.

  • FaceTime in Connect

Contributed by Micah Hainline.

FaceTime calls can now be made from within the Connect module. Apart from FaceTime support, Connect now has the ability to create any custom method of communication (such as fax).

CareKit 1.0 Release Notes

CareKit 1.0 supports iOS and requires Xcode 6.3 or later. The minimum supported Base SDK is 9.0.

CareKit 1.0 includes the following new features and enhancements.

  • Care Plan Store

Contributed by Apple Inc..

CareKit stores activities in a database called the Care Plan Store. This database is located at the URL provided by the developer. The Care Plan Store is encrypted using standard file-system encryption.

The Care Plan Store can store intervention and assessment activities. Each activity has a schedule that the Care Plan Store uses to create event objects. The store can be dynamically updated and modified.

  • Care Card

Contributed by Apple Inc..

Care Card is a view controller that displays the intervention activities for a selected date. It provides a way to track activity completion and user adherence.

A developer can modify the Care Plan Store by adding, removing, or modifying an activity and the Care Card responds by automatically updating the user interface.

The mask image on the Care Card can be customized to provide a themed user experience.

  • Symptom and Measurement Tracker

Contributed by Apple Inc..

Symptom and Measurement Tracker is a view controller that displays the assessment activities for a selected date. It provides a way to monitor subjective and objective measurements.

A developer can modify the Care Plan Store by adding, removing, or modifying an activity and the Symptom and Measurement Tracker responds by automatically updating the user interface.

  • Insights Dashboard

    Contributed by Apple Inc..

    The Insights Dashboard is a view controller that displays message items, such as an alert or tip, and charts, such as the grouped bar chart.

    A developer can subclass the OCKInsightItem and OCKChart classes to create new message items and charts.

  • Grouped Bar Chart

    Contributed by Apple Inc..

    The Grouped Bar Chart displays a series of data grouped into categories. The chart can be used with the Insights Dashboard using the OCKBarChart object, or it can be used directly using OCKGroupedBarChartView.

  • Connect

    Contributed by Apple Inc..

    Connect is a view controller that displays contact information for care team members, friends, and family. Connect supports communicating with contacts through email, messaging, and phone. It also supports a user interface for sending reports that you can create using the Document Exporter module

  • Document Exporter

    Contributed by Apple Inc..

    The Document Exporter module supports creating an HTML or PDF document. Although you can provide any data you’d like, the intent is to export data from the Care Plan Store. The exporter can display text, charts, images, and tables.

  • Sample App

    Contributed by Apple Inc..

    The Sample App (OCKSample project in CareKit's workspace) serves as a template application that combines different modules from the CareKit framework. It also shows how to use ResearchKit surveys and active tasks with CareKit.

  • Test App

    Contributed by Apple Inc..

    The Test App (OCKTest project in CareKit's workspace) serves as an application to test different modules and features from the CareKit framework.