How do we save the download configs into the application?

[dubdabasoduba]

Feature context

• We are downloading a couple of resources and config settings to the app.
• We would like to have a table that would help us easily map and reference the different downloaded resources.
• These tables would be named SettingsEntity & BinaryEntity
  • SettingsEntitiy -- Holds the settings that cannot be mapped to a resource or binary e.g the composition_id
  • BinaryEntity -- Holds the files that are attached to a binary resource.

Feature implementation details
Table Structures

• Create the tables named SettingsEntity & BinaryEntity, make sure we add them using migrations.

SettingsEntity

CREATE TABLE SettingsEntity (
    [id]       VARCHAR PRIMARY KEY,
    value       BLOB,
    type        TEXT
);

BinaryEntity

CREATE TABLE BinaryEntity (
    [id]       VARCHAR PRIMARY KEY,
    file       BLOB,
    resourceId     TEXT,
    resourcetype        TEXT
);

[pld]

Could we store these in a Parameters instead of these tables?

[dubdabasoduba]

Could we store these in a Parameters instead of these tables?

• I think the Parameters can be used for the JSON configs. We could use the valueset strings to store them.

• I think this just helps us forgo the need for the BinaryEntity Table. I think we still need the settings tables even to map some of the things returned by the practitioner details endpoint e.g ROLES

[dubdabasoduba]

Application Workflow parameters
Current JSON design.

[
  {
    "appId": "covax",
    "title": "EIR Covax app workflow",
    "mapping": [
      {
        "workflowPoint": "registration",
        "resource": "RegisterViewConfiguration",
        "classification": "patient_register",
        "description": "Configurations for patient register"
      },
      {
        "workflowPoint": "immunization_profile_view",
        "resource": "ImmunizationProfileViewConfiguration",
        "classification": "immunization_profile",
        "description": "Configurations for immunization profile "
      },
      {
        "workflowPoint": "login",
        "resource": "LoginViewConfiguration",
        "classification": "login",
        "description": "Configurations for login"
      }
    ]
  }
]

Parameter resource proposal

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "appId",
      "valueString": "covax",
      "part": [
        {
          "name": "title",
          "valueString": "EIR Covax app workflow"
        },
        {
          "name": "mapping",
          "part": [
            {
              "name": "workflowPoint",
              "valueString": "registration",
              "part": [
                {
                  "name": "resource",
                  "valueString": "RegisterViewConfiguration"
                },
                {
                  "name": "classification",
                  "valueString": "patient_register"
                },
                {
                  "name": "description",
                  "valueString": "Configurations for patient register"
                }
              ]
            },
            {
              "name": "workflowPoint",
              "valueString": "immunization_profile_view",
              "part": [
                {
                  "name": "resource",
                  "valueString": "ImmunizationProfileViewConfiguration"
                },
                {
                  "name": "classification",
                  "valueString": "immunization_profile"
                },
                {
                  "name": "description",
                  "valueString": "Configurations for immunization profile"
                }
              ]
            },
            {
              "name": "workflowPoint",
              "valueString": "login",
              "part": [
                {
                  "name": "resource",
                  "valueString": "LoginViewConfiguration"
                },
                {
                  "name": "classification",
                  "valueString": "login"
                },
                {
                  "name": "description",
                  "valueString": "Configurations for login"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

[dubdabasoduba]

Form Configurations parameters
Current JSON design.

[
  {
    "appId": "covax",
    "form": "patient-registration",
    "title": "Add Patient",
    "identifier": "207"
  },
  {
    "appId": "covax",
    "form": "record-vaccine",
    "title": "Record Vaccine",
    "identifier": "800"
  },
  {
    "appId": "jnj",
    "form": "patient-registration",
    "title": "Add Patient",
    "identifier": "754"
  },
  {
    "appId": "jnj",
    "form": "record-vaccine",
    "title": "Record Vaccine",
    "identifier": "800"
  },
  {
    "appId": "jnj",
    "form": "adverse-event",
    "title": "Adverse Event",
    "identifier": "1568"
  }
]

Parameter resource proposal

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "appId",
      "valueString": "covax",
      "part": [
        {
          "name": "mapping",
          "part": [
            {
              "name": "form",
              "valueString": "patient-registration",
              "part": [
                {
                  "name": "title",
                  "valueString": "Add Patient"
                },
                {
                  "name": "identifier",
                  "valueString": "207"
                }
              ]
            },
            {
              "name": "form",
              "valueString": "record-vaccine",
              "part": [
                {
                  "name": "title",
                  "valueString": "Record Vaccine"
                },
                {
                  "name": "identifier",
                  "valueString": "800"
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "name": "appId",
      "valueString": "jnj",
      "part": [
        {
          "name": "mapping",
          "part": [
            {
              "name": "form",
              "valueString": "patient-registration",
              "part": [
                {
                  "name": "title",
                  "valueString": "Add Patient"
                },
                {
                  "name": "identifier",
                  "valueString": "754"
                }
              ]
            },
            {
              "name": "form",
              "valueString": "record-vaccine",
              "part": [
                {
                  "name": "title",
                  "valueString": "Record Vaccine"
                },
                {
                  "name": "identifier",
                  "valueString": "800"
                }
              ]
            },
            {
              "name": "form",
              "valueString": "adverse-event",
              "part": [
                {
                  "name": "title",
                  "valueString": "Adverse Event"
                },
                {
                  "name": "identifier",
                  "valueString": "1568"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

[dubdabasoduba]

This shows the composition with Parameters Resource instead of Binary Resource

[ellykits]

Using Parameters Resource is fine. We will have to write some custom logic to parse the resource into our current configuration model (data classes) instead of using them directly.

[ellykits]

@dubdabasoduba What would be the benefit of using Parameters resource. Just wondering if that extra step for mapping the resource to a configuration model is necessary.

[dubdabasoduba]

@dubdabasoduba What would be the benefit of using Parameters resource. Just wondering if that extra step for mapping the resource to a configuration model is necessary.

The benefit is that we leverage FHIR resources and do not have to define our own schemas. This makes it easier for us to do the following

• Write documentation on how to configure the FHIR core.
• Make sure the configurations are standard and anyone with a good understanding of FHIR resources can write them.

[pld]

Can we close this issue if we're using the Parameter resource?

[f-odhiambo]

Let me convert it to a discussion item , then will close it if not further action items is required

[f-odhiambo]

This has been fulfiled