Repository

[jamlung-ri]

@paulsonder I'm going to list out some details below for what information a user needs to see on a Repository, while trying to be generic with respect to the type of Repo.

• Basic required info:

  • Short name plus ID for the repo
  • OCL type (dictionary, source, collection, CodeSystem, ValueSet, ConceptMap, etc.)
  • Owner (i.e. org or user)
  • Latest released version number

• Secondary optional/helpful info (which would not be displayed primarily but should ideally be accessible and/or viewable):

  • Full repo name (plus a snippet of its description, maybe?)
  • Content summary: # of concepts and released versions
  • Date of last released version
  • Canonical URL
  • Permission level i.e. public for all, private, etc.
  • Default and supported locale(s)
  • (In the future) Flag for "trusted" or "verified" or something e.g. the real CIEL vs. someone else's CIEL subset

• GitHub-like attributes that we could someday try to leverage:

  • Activity sparklines (i.e. amount of activity in recent months)
  • Number of times favorited/subscribed by other users
  • Most common topics in the repo (e.g. top 3-5ish most common concept classes, which gives the user an idea of what all is in there

• Info specific for a "Classic Source" that you need to see on a search results page:

  • Source name, ID, canonical URL, type
  • Source owner
  • Latest released version ID with hover-over for release date (might include an indicator for "has updated since your last visit"?)
  • (If applicable) Trust indicator i.e. the blue checkmark sort of thing
  • Permission level
  • Summary of content:
    • Number of concepts / mappings
    • Number of released versions
    • Most common concept classes
    • Default and supported locale(s), ordered by most frequent use

• Info specific to "Classic Collection" that you need to see on a search results page:

  • Same as Source except:
    • Summary of content:
      • Use number of references instead of number of released versions
      • Use most commonly references source(s) instead of most common locales

• There is another requirement (detailed more in #1776) about the brief representation of Repositories via Chips. This should give a brief glimpse into the Repository, its owner, the version being pointed towards (if applicable), and some other information.

[jamlung-ri]

In addition to the info above, here are the CTAs and User Stories relevant to Repositories:

Object + CTA	User Story	Requirements
Repository: View	View metadata and content list of a repository	About page viewer; Empty state for a repository that has no About section; summary statistics (see above); concept list with hierarchy, card, and table views; mapping list with map type-, source-, and target-focused views; repo version navigator
Repository: Search	Find a specific repo using full text search or parameter-based search (e.g. any search param supported in FHIR spec or OCL API)	Support FHIR Search Parameters; support sorting and filtering by OCL attributes; repo list with card and table views
Repository: Compare	See a comparison of two versions of a specified repository, including a summary of differences (e.g. stats) and a list of specific changes (e.g. "New concepts", "Retired concepts", etc.	Select two versions to compare, which shows summary of differences between repos as outlined in #1753
Repository: Export	Download an export of a repository in preferred format	OCL zip, csv, and JSON formats; FHIR resource format(s) available, based on repo type (e.g. value set can be downloaded as FHIR ValueSet, Classic Source can be downloaded as CodeSystem or ConceptMap)
Repository: Bookmark / Star	Get notifications on selected repositories, e.g. new releases, new versions created.	Add repository to user's Bookmarked Repos list
Repository: Operations	View a list of possible operations and supported parameters and a way to trigger the operation and see results	See #1624
Repository: Share	Share/copy a link to a repo	Copy repo link to clipboard