android-fhir icon indicating copy to clipboard operation
android-fhir copied to clipboard

Published 20 hours ago • verified publisher icon google

Loading implementationGuide (to SDK): Requirements

Open fredhersch opened this issue 4 years ago • 2 comments

Research and design the pattern for deploying a FHIR Implementation Guide to the SDK.

Two structured approaches:

  1. Use Knowledge Repository: https://www.hl7.org/fhir/capabilitystatement-knowledge-repository.html
  2. npm package: Requires using the FHIR publisher. May not be flexible enough

User story: As an implementer I can deploy a published IG either from a FHIR Knowledge Repository or via npm package

Steps:

  1. Loading initial resources
  2. Getting updates via new versions

Open questions for the SDK:

  1. How do you know if there are updates (manual process)
  2. How do you support different versions
  3. How do you make it configurable

fredhersch avatar Feb 19 '21 08:02 fredhersch

There are two distinct scenarios:

1. Server side deployment with sync

  • Here a server would act as a knowledge repository OR there is a separate process to deploy an IG to the FHIR server - e.g. this thread on the FHIR chat
  • The app would be set up to sync the latest resources using the SDK's sync approach * Questions/issues:
    • Are there challenges in managing meta-data assciated with a new deployment to a knowledge server .. is there anything the SDK/client-app needs to know?
    • Should this be a separate 'sync' process i.e. definitinal resources are treated differently to patient level resources?

2. Loading resources into an app via an SDK enabled process

  • Specify the IG package within the configuration as part of the build process
  • This could either be a local file OR a URL
  • The SDK would provide some methods for unpacking the contents and updating the resources in the db etc
  • When building a release of an app, the contents of the package are incorporated into the application
  • Could be set-up to check for new updates (during the build process)

Checking for updates

  • Using this approach, a client application could instruct the SDK to load a new package e.g. it receives an updated configuration setting that indicates a new version OR the client application implements some listener for updates to registered packages (if using a URL based approach)

cc: @jingtang10 @pld @joiskash @brynrhodes

fredhersch avatar Aug 08 '21 09:08 fredhersch

@kunjan8794 Can you use this current issue to start sharing out the requirements that you are working on? If you have a doc you can add a link here OR in the FHIR Chat group and we can request review/input there. How does that sound? Thanks

fredhersch avatar Feb 08 '22 09:02 fredhersch