(feat) O3-3249: Introduce helper function to get well-formatted patient display name.

[xprl-gjf]

Requirements

• This PR has a title that briefly describes the work done including the ticket number. Ensure your PR title includes a conventional commit label (such as feat, fix, or chore, among others). See existing PR titles for inspiration.

For changes to apps

• My work conforms to the O3 Styleguide and design documentation.

If applicable

• My work includes tests or is validated by existing tests.
• I have updated the esm-framework mock to reflect any API changes I have made.
  (No API changes made)

Summary

FHIR patient responses may now include a well-formatted display name as per FM2-631.

Despite this, there are many locations in the O3 frontend where a patient name is displayed explicitly as ${givenName} ${familyName}.

In going through the codebase to fix this, it becomes apparent that there is value in adopting a consistent approach to getting the patient display name.

Screenshots

N/A

Related Issue

https://openmrs.atlassian.net/browse/O3-3249
https://openmrs.atlassian.net/browse/O3-2115

Other

I already have open pull requests on openmrs-esm-patient-management:

• openmrs-esm-patient-management 1141
• openmrs-esm-patient-management 1142
• openmrs-esm-patient-management 1143

I will pause those changes until this pull request is completed.

[xprl-gjf]

@ibacher I'd like to know if you think this is the correct place for this code, or should it be somewhere else such as esm-patient-common-lib. I don't know if esm-patient-common-lib is available for every module that needs this functionality, perhaps including cohort app, laboratory app, etc.

[ibacher]

Thanks @xprl-gjf! A couple of notes:

1. This isn't a refactor at all. It's adding a new function to the library, so it's a (feat).
2. We prefer to have tickets versus just PRs (the description here is fine for a ticket).
3. When adding a new file to one of the libraries, please include a /** @category */ comment at the top.
4. Remember to actually run the commit scripts, particularly the documentation script.

[ibacher]

PS Yes, it's perfectly acceptable to put something like this here.

[gracepotma]

Wow, thank you @xprl-gjf!