ClinGen / clincoded

This GCI/VCI 1.0 platform has now been retired, and replaced with our new 2.0 platform:
https://github.com/ClinGen/gene-and-variant-curation-tools/issues
MIT License
25 stars 9 forks source link

VCI Expert Review and Approval - Provisional Interpretation #1423

Closed jimmyzhen closed 6 years ago

jimmyzhen commented 7 years ago

Implement the Provisional Interpretation section, which consists of the following requirements:

  1. Section panel title: Provisional Interpretation
  2. A dropdown of by Individual or on behalf of Group options for the user to select.
  3. Dropdown label: Interpretation being saved 'by Individual' or 'on behalf of Group'
  4. Display of form fields for labels ClinGen Group Name OR Non-ClinGen Group Name. Either one of these fields is required if the on behalf of Group option is selected.
  5. A Save as Provisional Interpretation button for the user to save the selected option from the dropdown.
  6. The dropdown selection is required if the user wants to save the provisional interpretation.
  7. Display of a note with message: Note: Saving as a Provisional Interpretation does not submit it to ClinVar.
  8. Display of the Current Saved Provisional Interpretation, including the timestamp.
wrightmw commented 6 years ago

@jimmyzhen ClinVar VariationID: 10000 does not load data in this instance. It doesn't load in this test instance but it does work in the normal demo and prod interfaces.

@jimmyzhen ClinVar VariationID: 17000 did work in the test instance when I created it as part of 10001 Affiliation but when I went back in and tried to enter VariationID: 17000 as part of Affiliation 10002 it would no longer load any data. In other words, it seems like this loading issue arises when a curator from an Affiliation tries to enter a ClinVar VariationID that has already been entered by a curator from a different Affiliation.

✔️

wrightmw commented 6 years ago

oooh -- good catch @wrightmw ! Same in GCI (probably obvious)

✔️

selinad commented 6 years ago

@wrightmw @jimmyzhen I'm thinking we don't need this text any more (on Evaluation Summary)

image

To clarify -- this was confusing the 2nd time through when I'd already saved as Provisional

@selinad Do you mean get rid or it altogether or just the second time around? I think H & S requested this text.

selinad commented 6 years ago

@jimmyzhen @wrightmw I may be confused -- I thought it was possible to save an interpretation as LP or P, just not as Provisional. I got this trying to save going around the 2nd time after an Approved

image

selinad commented 6 years ago

@jimmyzhen this note works great the first time around when there has not bee a previously saved Provisional. One change to text if possible:

image

"The option to save an Interpretation as Provisional will not appear when the saved calculated or modified value is "Likely Pathogenic" or "Pathogenic" and there is no associated disease."

✔️

jimmyzhen commented 6 years ago

I thought it was possible to save an Interoperation as LP or P, just not as Provisional. I got this trying to save going around the 2nd time after an Approved

@selinad, in regards to your comments above, you need to provide an explanation to the modified pathogenicity before you can save the interpretation.

@jimmyzhen sorry, I think my point is why is the warning bar there -- I can save it if it's not provisional (after providing a reason)

@jimmyzhen it does not happen if I haven't saved as Provisional before image

selinad commented 6 years ago

@jimmyzhen If I get a warning I can't save as Provisional then go back and add a disease and View Summary again, it gives me the Provisional box. The provisional box should only appear after a Save of the Classification

image

selinad commented 6 years ago

Need a space between sentences in this text:

image

✔️

selinad commented 6 years ago

@jimmyzhen If I had Modified to LP, then go back around and add more and get Calculated of P, then it still says "LP" for Modification, but if I change to P it makes me give a reason...is the same logic being used in GCI and VCI? thx!

image

jimmyzhen commented 6 years ago

@selinad, I don't know whether they are using the very same logic, although they kinda behave similarly.

selinad commented 6 years ago

@jimmyzhen here's what it does in GCI

image

wrightmw commented 6 years ago

@jimmyzhen An empty "Provisional Classification entered by" field in editable box is filled upon saving. Perhaps get rid of this from editable box and only display once saved?

wrightmw commented 6 years ago
wrightmw commented 6 years ago
wrightmw commented 6 years ago

screen shot 2018-04-05 at 3 21 24 pm

wrightmw commented 6 years ago

screen shot 2018-04-05 at 3 29 19 pm

wrightmw commented 6 years ago

It's looking pretty fantastic so far @jimmyzhen ... you've done an amazing job with this!

selinad commented 6 years ago

image

@jimmyzhen it happens even when I don't have to add a disease -- in this case, had just made a change to another criteria and saved -- you can see I was presented with Provisional option: image


@selinad According to the screen shot(s), there is a disease associated with the interpretation...

selinad commented 6 years ago

@jimmyzhen adding a 2nd Prov and 2nd Approved Interpretation works GREAT! image

selinad commented 6 years ago

@selinad, @wrightmw, I can't seem to be able to reproduce the problem anymore.

wrightmw commented 6 years ago

@selinad I don't think that bug is fixed because I am getting the same issue

selinad commented 6 years ago

Here is the one for Provisional: image

Suggested text: "When ready, you may save this Interpretation as Approved. Once you have saved it as Approved, you will not be able to undo it, but you will be able to save a new current Approved Interpretation, archiving the current one and retaining access to its Evaluation Summary."

wrightmw commented 6 years ago

@selinad re. text above...

Suggested text: "When ready, you may save this Provisional Interpretation as Approved. Once you have saved it as Approved it will become uneditable, but you will be able to save a new current Approved Interpretation, thus archiving this current one and retaining access to its Evaluation Summary."

selinad commented 6 years ago

Looks good @wrightmw -- thank you!

selinad commented 6 years ago
selinad commented 6 years ago

image

selinad commented 6 years ago

@jimmyzhen I think the above also occurs if I add a disease back....

image

selinad commented 6 years ago

p.s. love the "Approve this Saved Provisional" button!!!!

wrightmw commented 6 years ago

@jimmyzhen Just been looking at your new instance. It looks phenomenal! Love the orange "Approve this Saved Provisional" button!

wrightmw commented 6 years ago

And I am now able to work on the same variant as part of different Affiliations. Great!

wrightmw commented 6 years ago

@jimmyzhen @selinad

When you first visit an Interpretation, you get to see "All Existing Interpretations", which is great, but this is not behaving quite right.

Here are the headers for the existing Interpretations I randomly created:

1) An APPROVED "likely pathogenic" interpretation from the Hereditary Cancer WG Affiliation screen shot 2018-04-08 at 6 46 57 pm

2) An APPROVED/NEW PROVISIONAL "benign" interpretation by the Rett/Angelman screen shot 2018-04-08 at 6 48 04 pm

3) A PROVISIONAL VUS interpretation by the RASopathy EP screen shot 2018-04-08 at 6 51 44 pm

4) An IN PROGRESS interpretaion by the KCNQ1 EP.. for this one I have only Saved an Evaluation Summary... nothing else screen shot 2018-04-08 at 7 00 58 pm

5) I started an Interpretation as BCM-Education...added evidence ...but I have not saved an Evaluation Summary yet... so no status screen shot 2018-04-08 at 7 31 12 pm

Now when I go in as a different Affiliation, this time as "No Affiliation" and I go to the Evidence View for the above 5 examples, here is my header: screen shot 2018-04-08 at 7 35 32 pm

screen shot 2018-04-08 at 7 32 40 pm

Therefore, we are inconsistently showing the "In Progress" status.

wrightmw commented 6 years ago

Btw, as you can see I can definitely work on the same variant as different Affiliations. Whatever you did with the elastic search is working! Great!

selinad commented 6 years ago

@jimmyzhen @wrightmw this is what I saw before. I started an Interpretation, saved as BA1 Met -- you can see it responds I saved, but I don't get update button. Also criteria bar does not change... @jimmyzhen let me know if I should make a ticket....I believe a curator was writing in about this and I asked for more info.

Note criteria bar -- also, Summary shows no criteria saved

image

I then try to do PM2 and have the same problem: image

First time in for a new variant and BS1 seems to work (and after this I was able to modify it to PM2 and it saved....almost as if saving as BS1 first works, but saving as BA1 or PM2 first doesn't work. Summary looks as expected) image

selinad commented 6 years ago

@jimmyzhen when I clicked on the orange Approved button, it went back to In progress and I was not able to get the chance to Approve:

image

selinad commented 6 years ago

@jimmyzhen @wrightmw If I go go back to Summary to Approve a saved Provisional that was benign after adding more evidence and it's now pathogenic, I get this, which is very nice. image

However, if I click to save it as Approved (orange button), I get this, which seems correct, but we may need to make certain curators aren't thinking they are saving the pathogenic....I'm not sure what to do for this, or whether we should worry right now?

image

Could we have some "simple feedback" on the save evaluation part saying not yet saved? When they click button, it would say saved?

selinad commented 6 years ago

@jimmyzhen steps for buggy thing

image

selinad commented 6 years ago

@jimmyzhen thoughts:

jimmyzhen commented 6 years ago

@selinad,

the white is hard to see in the orange bar...should we make this text black so we can see Provisional vs. Approved?

I made the text bold and it seems to read better now: image

we have this text in GCI -- analogous text could be helpful in eliminating confusion in VCI (or maybe it is there and not displaying...

There is currently a similar paragraph of note text in the VCI (see the screen shot above). Although it may not be exactly the same text you see in GCI, it is there when the approval form entry panel shows.

jimmyzhen commented 6 years ago

@selinad,

However, if I click to save it as Approved (orange button), I get this, which seems correct, but we may need to make certain curators aren't thinking they are saving the pathogenic....I'm not sure what to do for this, or whether we should worry right now?...Could we have some "simple feedback" on the save evaluation part saying not yet saved? When they click button, it would say saved?

There is also a paragraph of note text in the VCI being shown when the provisional form entry panel is displayed (upon saving the evaluation). You may choose to update it if it suits the needs. For anything more complicated or needing a more well thought-out user experience, I would suggest we look into that in subsequent releases if this is not a showstopper.

selinad commented 6 years ago

Testing steps

All in all looks great!!! Just the one bug when I saved as LP (see above) and there was missing ability to save the existing Prov as Approved....

Dashboard -- was I supposed to see this as Approved? It shows none image

here is is when I go into it: image

wrightmw commented 6 years ago

Previous error I reported whereby "Approved/New Provisional" was being incorrectly reported as just "Provisional" in the "All Existing Interpretations" section has now been fixed. Thanks Jimmy! @selinad I have added some Affiliations for you in this new testing instance... you should see them next time you logout and back in again.

wrightmw commented 6 years ago

@wrightmw @jimmyzhen -- I was not able to see any status in the Dashboard for the VCI, but was able to see the Approved + New Provisional for the GCI (one the Dashboard.
@jimmyzhen sorry -- I see your checkmark and I did a shift refresh and can see buttons on Dashboard! Now works great!!!! image

screen shot 2018-04-11 at 9 14 45 am

..when I go back to the dashboard it says just "Provisional":

screen shot 2018-04-11 at 9 15 11 am
wrightmw commented 6 years ago

Whereas, as I said earlier... in the "All Existing Interpretations" section this is now reporting correctly. Which is fantastic! Thanks Jimmy!

screen shot 2018-04-11 at 9 21 07 am
jimmyzhen commented 6 years ago

@jimmyzhen please see comments to your comments :-) @selinad,

Please see my responses to your feedback from your testing last night:

were we going to remove "In Progress" though? I thought it disappeared upon first save.

"In progress" remains until the 1st Provisional is saved.

modify to LP and give reason, save again; expect to see old provisional and ability to approve it, but see this (should still let me Approve original one, right? go back to Summary -- looks good except that still can't approve 1st provisional even though I haven't saved a second Provisional

As the way it is implemented now, I am disabling the ability to approve a saved Provisional as soon as the user saves changes in the Summary. The thinking behind it is that the user should provision the newly saved changes in the Summary again prior to approving it.

selinad commented 6 years ago

Hi @jimmyzhen , @wrightmw discovered a bug when we were demo'ing for the curators. The current approved moves to archived -- it should have a green flag instead of a file box image

@wrightmw confirmed this is independent of whether disease added or not

selinad commented 6 years ago

@jimmyzhen feedback from curators: 1) loved the workflow and no confusion around it! 2) adding "current" before green flag and "archived" before file would be good -- if this is not possible, could we make the icons a tad larger -- feedback was the file box looked like a trash can =:-0

selinad commented 6 years ago

@jimmyzhen would it be "quick" to have the gray "View Approved Summary" (or Provisional) have a blue border? NOT NECESSARY at all (they were fine with it being gray) but if quick it may make it more obvious it's clickable.

selinad commented 6 years ago

@jimmyzhen one more bug, which seems to be related to a long variant name -- problems on Dashboard display

screen shot 2018-04-12 at 10 47 40 am
jimmyzhen commented 6 years ago

@selinad, @wrightmw,

Please use the following instance to review the changes and fixes in regards to your comments and reports above: https://jz-approval-workflow.demo.clinicalgenome.org

Thanks!

selinad commented 6 years ago

@jimmyzhen looks GREAT!!!! I couldn't break it! Nicely done. Only 2 small items: