department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
283 stars 204 forks source link

[Other - Accessibility] Unnecessary information announced by screen readers. (00.00.1) #66642

Closed shiragoodman closed 3 weeks ago

shiragoodman commented 1 year ago

General Information

VFS team name

MHV

VFS product name

MHV Medical Records

VFS feature name

Allergies

Point of Contact/Reviewers

Brian DeConinck - @briandeconinck - Accessibility

*For more information on how to interpret this ticket, please refer to the Anatomy of a Staging Review issue ticket guidance on Platform Website.


Platform Issue

No VA.gov Experience Standard for the issue found.

Issue Details

On /medical-records/allergies, each allergy link has an aria-label that includes the date entered: [allergen] on [date]. Associating a date with the visible link text using an aria-label is a really good technique when you have multiple instances of the same item, like multiple doses of an immunization that took place on different dates. But it seems unlikely that someone is going to have multiple instances of the same allergy, and the date is reflective of something administrative (when it was logged) rather than something relevant to the user (when something occurred). I think most screen reader users are going to be able to still navigate through the screens effectively, but the dates in the aria-label may cause some confusion.

Link, screenshot or steps to recreate

Example code:

<a class="vads-u-margin--0" 
     aria-label="ATORVASTATIN/EZETIMIBE on September 13, 2023" 
     href="/my-health/medical-records/allergies/3214">
          ATORVASTATIN/EZETIMIBE
</a>

VA.gov Experience Standard

Category Number 00, Issue Number 00

Other References

Platform Recommendation

Unless there's actual patient data that would suggest the need to differentiate between multiple instances of an allergy, I think you can remove the aria-label entirely here and just have plain link text. This date differentiator is still likely to be valuable in other medical records domains, but it's not useful here.


VFS Guidance

BobbyBaileyRB commented 12 months ago

There's a possibility that allergy records might have repeating instances, that is why we are associating a date with the visible link text using an aria-label.

I would like to confirm this with @coultonbunney-usds before closing this ticket or making edits to the code.

bryan-riley-va commented 3 weeks ago

Can be closed/verified by Bobby