Merge pull request #11 from the-commons-project/add_payer

TCPE-1364 Update Sample App with 1.6.2 SDK/Insurance information

Author: btseytlinTCP

README.md

@@ -30,8 +30,8 @@ Once CommonHealth Developer Edition is installed, you will need to add a sample
 The CommonHealth Client SDK consists of two modules: commonhealth-client and commonhealth-common. CommonHealthClient contains the bulk of functionality for the SDK, while common contains types shared between the CommonHealth application and the CommonHealth Client SDK. You'll need to add the following to your application's list of dependencies:
 
 ```
-implementation "org.thecommonsproject:commonhealth-common:1.3.15"
-implementation "org.thecommonsproject:commonhealth-client:1.3.15"
+implementation "org.thecommonsproject:commonhealth-common:1.6.2"
+implementation "org.thecommonsproject:commonhealth-client:1.6.2"
 ```
 
 The release artifacts are made avalable via the Maven Central repository, so you will need to have the following in your list of dependency repositories:
@@ -187,17 +187,19 @@ Client applications should follow the principle of least privilege and only requ
 
 Client applications must define a `ScopeRequest`, which encapsulates a set of `Scope` objects. Each `Scope` object **must** contain a data type (`DataType`) an access type (`Scope.Access`). If you would like to limit the scope of access to a defined set of codes, you may also provide a list of `ScopedCodeAllowListEntry` objects. `ScopeRequest` contains a `Builder` class to help with implementation.
 
-The following sample creates a `ScopeRequest` object requesting read access to all currently available clinical data types:
+The following sample creates a `ScopeRequest` object requesting read access to all currently available FHIR data types:
 
 ```
-val allDataTypes: List<DataType.ClinicalResource> = listOf(
-    DataType.ClinicalResource.AllergyIntoleranceResource,
-    DataType.ClinicalResource.ClinicalVitalsResource,
-    DataType.ClinicalResource.ConditionsResource,
-    DataType.ClinicalResource.ImmunizationsResource,
-    DataType.ClinicalResource.LaboratoryResultsResource,
-    DataType.ClinicalResource.MedicationResource,
-    DataType.ClinicalResource.ProceduresResource
+val allDataTypes: List<DataType.FHIRResource> = listOf(
+   DataType.ClinicalResource.AllergyIntoleranceResource,
+   DataType.ClinicalResource.ClinicalVitalsResource,
+   DataType.ClinicalResource.ConditionsResource,
+   DataType.ClinicalResource.ImmunizationsResource,
+   DataType.ClinicalResource.LaboratoryResultsResource,
+   DataType.ClinicalResource.MedicationResource,
+   DataType.ClinicalResource.ProceduresResource,
+   DataType.PayerResource.ExplanationOfBenefitResource,
+   DataType.PayerResource.CoverageResource,
 )
 
 val scopeRequest: ScopeRequest by lazy {
@@ -294,16 +296,15 @@ In order to fetch data, the SDK provides the `readSampleQuery` method on the `Co
 
 ```
 suspend fun readSampleQuery(
-    context: Context,
-    connectionAlias: String,
-    dataTypes: Set<DataType>,
-    before: Date? = null,
-    after: Date? = null,
-    fetchedAfter: Date? = null
-): List<DataQueryResult>
+  context: Context,
+  connectionAlias: String,
+  dataTypes: Set<DataType.FHIRResource>,
+  beforeAfterDatePair: Pair<Date?, Date?>,
+  fetchedAfter: Date? = null
+): List<SampleDataQueryResult>
 ```
 
-As you can see, the method returns a list of `SampleDataQueryResult` instances. For requests for clinical data, these can be cast to `FHIRSampleDataQueryResult` instances. Each `FHIRSampleDataQueryResult` instance contains the following:
+As you can see, the method returns a list of `SampleDataQueryResult` instances. For requests for FHIR data, these can be cast to `FHIRSampleDataQueryResult` instances. Each `FHIRSampleDataQueryResult` instance contains the following:
 
  - resourceType: DataType.FHIRResource - the type of the resource
  - json: String - JSON string representation of the FHIR resource
@@ -341,6 +342,18 @@ Upon receiving the NEW_DATA_AVAILABLE notification, you can invoke a method on t
 
  Using these can help you identify when and if you need to pull data from CommonHealth, or if data has been deleted in CommonHealth and should be removed from your local datastore, if persisted.
 
+### Using CMS Blue Button Sandbox -- new in v1.6.2 and currently in beta
+
+_Note: This feature is currently in beta and should not yet be used in production applications. We'd love your feedback as you start using it; please open a Github issue, or email developers [at] commonhealth.org with any thoughts that you have. Thank you!_
+
+Client applications can now request to read Insurance data from CommonHealth. This data flows similarly to the existing clinical data types.
+
+Important note: CMS requires a client id and secret. [Register with CMS](https://sandbox.bluebutton.cms.gov/v1/accounts/create) to get a client id and secret.
+
+Be sure to register your sandbox app with our redirect url: org.thecommonsproject.android.phr.developer://oauth/redirect
+
+We can\'t use our own so you\'ll have to provide one. We will save this id and secret only locally, for your development convenience. We never send this client id/secret anywhere except to the authorization server for OAuth.
+
 ### Reading Verifiable Credentials (SMART® Health Cards) -- new in v1.3.15 and currently in beta 
 
 _Note: This feature is currently in beta and should not yet be used in production applications. We'd love your feedback as you start using it; please open a Github issue, or email developers [at] commonhealth.org with any thoughts that you have. Thank you!_
@@ -375,6 +388,12 @@ CommonHealth performs SMART® Health Card validation prior to ingesting the card
 
 Registering with CommonHealth is not required to begin testing integrations with CommonHealth Developer Edition. However, if you have a client application that you would like to use in staging or production environments, you'll need to register the application with CommonHealth. This is similar to registering an OAuth client, where you would specify information such as required scope, authorization redirect URI, etc. Please reach out to developers [at] commonhealth.org for more information.
 
+## Upgrading from v1.3.15 to v1.6.2
+`v1.6.12` introduced insurance data:
+
+- Support for Insurance data through the CMS Blue Button 2.0 Sandbox. This will require you to register with CMS an app with a redirect url to CommonHealth, and then for you to provide the client id/secret locally into CommonHealth so that you can download the data. Please see section "Using CMS Blue Button Sandbox" above.
+- Minor change to readSampleQuery(..) parameters
+
 ## Upgrading from v1.1.2 to v1.3.15
 `v1.3.15` introduced a small number of changes:
 

app/src/main/java/org/thecommonsproject/android/commonhealth/sampleapp/MainViewModel.kt

@@ -40,14 +40,16 @@ class MainViewModel(
 
     var storedVCResults = emptyList<VerifiableRecordSampleDataQueryResult>()
 
-    val allDataTypes: List<DataType.ClinicalResource> = listOf(
+    val allDataTypes: List<DataType.FHIRResource> = listOf(
         DataType.ClinicalResource.AllergyIntoleranceResource,
         DataType.ClinicalResource.ClinicalVitalsResource,
         DataType.ClinicalResource.ConditionsResource,
         DataType.ClinicalResource.ImmunizationsResource,
         DataType.ClinicalResource.LaboratoryResultsResource,
         DataType.ClinicalResource.MedicationResource,
-        DataType.ClinicalResource.ProceduresResource
+        DataType.ClinicalResource.ProceduresResource,
+        DataType.PayerResource.ExplanationOfBenefitResource,
+        DataType.PayerResource.CoverageResource,
     )
 
 
@@ -60,12 +62,12 @@ class MainViewModel(
     }
 
     sealed class ResultHolderMessage {
-        class SetResults(val resourceType: DataType.ClinicalResource, val results: List<FHIRSampleDataQueryResult>) : ResultHolderMessage()
+        class SetResults(val resourceType: DataType.FHIRResource, val results: List<FHIRSampleDataQueryResult>) : ResultHolderMessage()
         class SetRecordUpdateResults(val results: List<RecordUpdateQueryResult>) : ResultHolderMessage()
     }
 
-    private var resultsMap: Map<DataType.ClinicalResource, List<FHIRSampleDataQueryResult>> = emptyMap()
-    var resultsLiveData: MutableLiveData<Map<DataType.ClinicalResource, List<FHIRSampleDataQueryResult>>> = MutableLiveData(resultsMap)
+    private var resultsMap: Map<DataType.FHIRResource, List<FHIRSampleDataQueryResult>> = emptyMap()
+    var resultsLiveData: MutableLiveData<Map<DataType.FHIRResource, List<FHIRSampleDataQueryResult>>> = MutableLiveData(resultsMap)
     val recordUpdatesLiveData = MutableLiveData<List<RecordUpdateQueryResult>>()
 
     // This function launches a new counter actor
@@ -126,12 +128,13 @@ class MainViewModel(
         )
     }
 
-    private suspend fun fetchData(context: Context, clinicalResource: DataType.ClinicalResource) : List<DataQueryResult>{
+    private suspend fun fetchData(context: Context, dataType: DataType.FHIRResource) : List<DataQueryResult>{
         return try {
             commonHealthStore.readSampleQuery(
                 context,
                 connectionAlias,
-                setOf(clinicalResource)
+                setOf(dataType),
+                Pair(null, null)
             )
         } catch (e: Throwable) {
             Timber.e( e, "Exception fetching data")
@@ -153,12 +156,12 @@ class MainViewModel(
 
     suspend fun fetchAllData(context: Context) {
         val typesToFetch = allDataTypes
-        val sampleQueryFetchJobs = typesToFetch.map { clinicalResource ->
+        val sampleQueryFetchJobs = typesToFetch.map { dataType ->
             CoroutineScope(Dispatchers.IO).launch {
-                val results = fetchData(context, clinicalResource).mapNotNull { it as? FHIRSampleDataQueryResult }
+                val results = fetchData(context, dataType).mapNotNull { it as? FHIRSampleDataQueryResult }
                 resultsHolderActor!!.send(
                     ResultHolderMessage.SetResults(
-                        clinicalResource,
+                        dataType,
                         results
                     )
                 )

app/src/main/java/org/thecommonsproject/android/commonhealth/sampleapp/fragments/CategoryListFragment.kt

@@ -137,11 +137,11 @@ class CategoryListFragment : Fragment() {
     private fun updateUI() {
         viewModel.viewModelScope.launch {
             when(viewModel.getCommonHealthAvailability(requireContext())) {
-                CommonHealthAvailability.AVAILABLE -> {
+                CommonHealthAvailability.Available -> {
                     requestShcsButton.isEnabled = true
                 }
-                CommonHealthAvailability.NOT_INSTALLED,
-                CommonHealthAvailability.ACCOUNT_NOT_CONFIGURED_FOR_SHARING -> {
+                CommonHealthAvailability.NotInstalled,
+                CommonHealthAvailability.NotConfiguredForSharing -> {
                     Toast.makeText(
                         requireContext(),
                         "Please make sure CommonHealth is installed and setup",
@@ -202,12 +202,12 @@ class CategoryListFragment : Fragment() {
     }
 
     class ContentAdapter(
-        private val categories: List<DataType.ClinicalResource>,
+        private val categories: List<DataType>,
         private val generateOnClickListener: (DataType) -> View.OnClickListener
     ) : RecyclerView.Adapter<CategoryListItemViewHolder>() {
 
-        private var resultsCounts: Map<DataType.ClinicalResource, Int>? = null
-        fun updateResultsCounts(newResultsCounts: Map<DataType.ClinicalResource, Int>) {
+        private var resultsCounts: Map<DataType.FHIRResource, Int>? = null
+        fun updateResultsCounts(newResultsCounts: Map<DataType.FHIRResource, Int>) {
             resultsCounts = newResultsCounts
             notifyDataSetChanged()
         }

app/src/main/java/org/thecommonsproject/android/commonhealth/sampleapp/fragments/ResourceListFragment.kt

@@ -40,7 +40,7 @@ class ResourceListFragment : Fragment() {
         super.onViewCreated(view, savedInstanceState)
 
         val safeArgs: ResourceListFragmentArgs by navArgs()
-        val dataType = (safeArgs.dataType as? DataType.ClinicalResource) ?: run {
+        val dataType = (safeArgs.dataType as? DataType.FHIRResource) ?: run {
             throw Exception("Unsupported data type")
         }
 

build.gradle

@@ -12,7 +12,7 @@ buildscript {
         maven { url "https://jcenter.bintray.com" }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.0.1'
+        classpath 'com.android.tools.build:gradle:7.2.2'
         classpath "androidx.navigation:navigation-safe-args-gradle-plugin:$navigationVersion"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         // NOTE: Do not place your application dependencies here; they belong
@@ -43,7 +43,7 @@ ext {
     targetSdkVersion = 31
     compileSdkVersion = 31
 
-    commonHealthVersion = '1.3.15'
+    commonHealthVersion = '1.6.2'
 
     appCompatVersion = '1.4.1'
     androidXVersion = '1.7.0'

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 #Fri Feb 25 11:23:37 EST 2022
 distributionBase=GRADLE_USER_HOME
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
 distributionPath=wrapper/dists
 zipStorePath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME