Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable ValueSet expansion in the Search API so developers can search by ValueSet rather than disjunction of codes #609

Open
fredhersch opened this issue Jul 1, 2021 · 4 comments
Labels
help wanted Extra attention is needed type:enhancement New feature or request

Comments

@fredhersch
Copy link
Collaborator

fredhersch commented Jul 1, 2021

Describe the solution you'd like

Add functionality to the search API to find concepts within a ValueSet resource:

  • By code
  • By DisplayName

Return the concept (from the CodeSystem) or Concept Not Found

Estimated effort: 10 days

@jingtang10
Copy link
Collaborator

For value sets that are expanded, it's very simple to look up the codes within the expansion of the valueset. There doesn't need to be any api or utilities for reading an already expanded value set. Even if this is a common operation by developers, there is very little value in providing a common API for that.

So within this issue we should focus on search by value set where a code is the searched parameter. For example, find observations with a code in a given value set .

@Tarun-Bhardwaj Tarun-Bhardwaj added help wanted Extra attention is needed and removed P2 Medium priority issue labels Jul 28, 2021
@fredhersch
Copy link
Collaborator Author

Based on discussion with @jingtang10 and @aditya-07 there is no additional search API required here.

An example is: return all Blood Pressure observations for a given Patient using the code(s) for Blood Pressure

Steps to achieve this:

  1. Client app: Get the code or codes for blood pressure: e.g search within ValueSet Resource. Return a single code or set of codes
  2. Client app construct query via SDK to find observation with code value = code1 OR code 2 (uses the search OR operator support)
  3. Uses the search by observations of different types (Search by multiple resource types #611) to return all observations for a given patient
  4. Client app retrieves a collection of observation resources with codes that represent Blood Pressure

@jingtang10
Copy link
Collaborator

jingtang10 commented Aug 13, 2021

agreed. in other words, this can be achieved now (with the OR operator implemented) if the look up from valueset -> codes is done by the app.

if we want to make this better(?) for devs, we can make it so that you don't have to do the look up but only need to provide the valueset url to the search API. but that is probably slightly lower priority (since there is a solution for the app).

@jingtang10 jingtang10 changed the title Resolve ValueSet lookups via Search API Enable ValueSet expansion in the Search API so developers can search by ValueSet rather than disjunction of codes Aug 13, 2021
@Tarun-Bhardwaj
Copy link

De-prioritized for now. Nice to have feature to simplify, hence moving this out of Q3 scope as per discussion with Jing & Fred.

@Tarun-Bhardwaj Tarun-Bhardwaj removed this from the Q3 2021 milestone Sep 22, 2022
@jingtang10 jingtang10 removed the Search label Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed type:enhancement New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

3 participants