Donor entity: Rules for blank values

[kcullion]

This may need to be revisited based to make these rules consistent with what's decided for clinical exceptions (eg. using "Unknown" vs. "Not Available").

General Approach for blank fields and hidden fields

(from slack convo March 16)

• we use the mockups you provided to give the minimum set of fields to show - we show those fields even if their value is empty
• then if we have additional data for that item we add those fields into the table as well to make sure we don't hide any data
• so we only show an empty value if you include it on the mockups, otherwise things are shown/hidden dynamically

Not Applicable fields

Show N/A for the following cases:

• [ ] 2. If vital_status = Alive, then cause_of_death = N/Aand survival_time = N/A

• [ ] If clinical_tumour_staging_system (primary_diagnosis.tsv) is NOT any edition of the AJCC cancer staging system, then Clinical TNM Category = N/A For example:

• [ ] if pathological_tumour_staging_system (specimen.tsv) is NOT any edition of the AJCC cancer staging system, then Pathological TNM Category = N/A

• [ ] if recurrence_tumour_staging_system or posttherapy_tumour_staging_system (followup.tsv) is NOT any edition of the AJCC cancer staging system, then Recurrence TNM Category = N/A and Posttherapy TNM Category = N/A

Not Available fields

• [ ] 1. Show -- when a value is missing and doesn't pertain to the above use cases

Note for reviewing hidden fields:

• [ ] make sure the hidden fields are properly hidden: Summary card: hiding some fields based on gender value (note we said, if the edge case shows up where a male donor has a value for the hidden fields (eg. # preganancies) - then show this field and value: https://github.com/icgc-argo/platform-ui/issues/1862 Specimen Tab: hide tumour related fields for Normal specimen https://github.com/icgc-argo/platform-ui/issues/2127

Just for reference

Melanie sent this resource for the meaning behind missing values. Putting here for adding onto this spec https://ena-docs.readthedocs.io/en/latest/submit/samples/missing-values.html

[kcullion]

We may need a backend ticket for returning these values just to be consumed by the front end? Also these can the -- and N/A values be generalized in one ticket - they will be displayed in multiple contexts like on the donor entity page, and the file entity page. @blabadi @demariadaniel please advise.

[blabadi]

@kcullion @joneubank adding Jon here since he is working on the clinical API and indexing So Jon, the thing here is we need the UI to be able to distinguish between N/A or empty values, and we need this consistent across the platform so my suggestion is to make sure the clinical API enforce these rules above in the ticket and include the right response so the index or anything that queries the API get N/A where applicable.

not sure if you are still in the middle of this or need a new ticket or have something else in mind to avoid encoding business rules in the FE