Share via


Release notes for DAXKit SDK version 0.8.0

Changes

  • Fixed numerous issues.
  • Updated the public APIs.
  • Added partnerId to the DAX.start() method. For more information, see: Initialize DAXKit.
  • Added explicit keys for the DAX.configure() method. For more information, see: Configure the user.
  • Additional provider and product identifiers are now passed via the DAX.configure() method. For more information, see: Configure the user.
  • Patient and appointment data can now be passed to the DAX system. For more information, see: Configure the session.
  • Added a queryable SDK version inside DAXKit: Version.
  • Added log uploading to DAX servers for debugging purposes.

Note: DAXKit logs don't include any PHI information.

Technical notes

This is a collection of technical notes that are to be taken into account with DAXKit SDK version 0.8.0.

API changes

A number of changes have been applied to the APIs that can be called by our partners or that DAXKit can call on the hosting app.

Additions

  • Version defines the version of DAXKit currently installed via its static fields: major minor patch along with a helper versionString that properly formats the version into a Semantic Versioning compliant string.
  • DAX.shared.disableLogging() disables the upload of logs from DAXKit. If you disable logging, it will be turned on again with the next launch. For more information, see: Logging.

Updates

  • DAX.start() has a new required parameter: partnerId; this parameter is provided by the Nuance partner relations team. For more information, see: Initialize DAXKit.
  • DAX.shared.encounter(withIdentifier:) has a new field: ehrData. This is an optional field that allows you to pass patient and appointment data to the DAX system. For more information, see: Configure the session.
  • DAX.shared.configure() has new keys that allow you to configure the current user. For more information, see: Configure the user.

Note that within Objective-C, nested classes aren't supported so these values can be found at DAXConfigurationKeys* (currently only DAXConfigurationKeysProvider).

  • DAX.shared.prepareToRecord() now triggers the audio system to get ready to start recording. If recording permissions haven't been requested yet, it will do so.

Removals

The following internal development APIs have been removed:

  • DAX.shared.deleteAllRecordings()
  • DAX.shared.resetUnfinishedUploads()
  • DAX.shared.resetFinishedUploads()
  • DAX.shared.allRecordings()
  • DAXKitDelegate.updatedRecording(recordingIdentifier:,encounterIdentifier:)