Introduce person relationships

[kwa20]

Situation Description

Users expressed the desire to define relationships between persons for better management. Thus, they would like to do the following as a user in Sormas

• Open a person and define a new relationship by clicking on a designated button
• Search for the second person they want to define a relationship with
• Potentially select multiple persons at once to define relationships with
• Automatically define a reverse relationship during this process
• View the defined relationships on a designated card on the person form
• Remove the relationship by selecting an unlink icon in a respective entry
• Navigate to the linked person in a respective entry
• Freely configure the relationship types that are available for selection

NOTE: These links merely serve management purposes and have no epidemiological implications.

Feature Description

• Add a feature configuration called PERSON_RELATIONSHIPS (default = t) - all subsequent features will be active only if the feature is enabled

Configuration

• Add a 'Person Relationships' section to configurations
  • Add a 'New Entry' button to the top of the section
    • Upon clicking, open a creation form pop-up with the following fields
      • relationship name (compulsory)
      • reverse relationship name
      • external Id
  • Add a list of deposited relationship types
    • Edit icon (no caption)
    • Relationship name
    • Reverse relationship
    • External ID
  • Add an archive option when editing entries - don't show archived entries in drop-down selections
  • Add an all, archived, active filter to the top right of the list
  • Add an archive bulk action

Person form

• Add a card to the person form after all other cards; heading: 'Relationships'
  • Per linked person, display the relationshipType, the person firstName and lastName as well as the personUuid
  • Add an unlink icon - upon clicking, remove the link between the two persons
  • Add an edit icon - upon clicking, navigate to the linked person
• Add a button to the top right of the Relationship card called 'New Relationship'
  • Upon clicking, open a person search pop-up window (Heading: 'Search Person'). This window should include
    • A person search field that works exactly like the free text search field on the person directory
    • All other drop-down filters present on the person directory
    • A button to trigger the search, caption: 'Search Person' (similar as seen for search case when choosing a source case of a contact)
    • The list should include all the columns seen on the person directory
    • The list should initially be empty to avoid performance implications
    • The list should include multi-selection checkboxes
    • Add discard and confirm buttons to the bottom right of the window; confirm should be disabled until at least one person has been selected
• When persons have been selected and the selection confirmed, open a subsequent pop-up window (Heading: 'Define Relationships') that lists the selected persons in a line listing style (all person fields disabled).
• On the top of the window, add the details of the person being currently worked on
• Add a relationship drop-down field with all active values deposited in configurations
• Add a delete button to remove lines
• Add discard and save buttons to the bottom right of the form
• After saving, display all entries in the Relationships card on the person form

Note: The reverse relationship should be created in the same process and be displayed when opening the person selected as the second person in the search.

• For example: If we have a Mother - Child relationship, the mother as the initially edited person should display the relationship type that was chosen during the creation. When opening the person form of the child, the relationship type should be the reverse relationship type for the initially chosen one. examples:

Relationship name	Reverse relationship
Mother of	Child of
Child of	Mother of
Mother of	Daughter of

Error handling/open questions

• How to edit relationships after initial link? - using the person uuid for navigation and the edit icon for relationship edits would be rather inconsistent

  Possible Alternatives

• Somehow integrate the relationshipType into the customizable enum values

• Instead of pre-defining reverse relationships, add a 'reverse relationship' field to the relationship creation form showing the same deposited relationship types

  Additional Information

  

[kwa20]

@Marko-ilmkreis I've refined an issue we've talked about a while back. When you have time, could you please have a look and see if we can close https://github.com/hzi-braunschweig/SORMAS-Project/issues/5098 in favour of this specification?

[marko-arn]

@kwa20 That looks very good. In the info-box should not only displayed the UUID of the person it must show the name of the person. The dob is not needed I think, but the name.

Do we make a seperate issue for the values of the relationship. If so, please allow also "guardian of" and "foster parent of". We have to deal with it sometimes.

[kwa20]

@Marko-ilmkreis The info box would display the name, yes. 'Father Family' would be an example for that. We could actually think about adding dob and sex to the entry but if it isn't needed that would be fine too.

I think the specifications might get broken up further, yes. The idea for relationship values was that it's purely configurable by the user since they can be many and varied. We might be able to provide a value set to start off with which could be archived if not needed.

[bernardsilenou]

@kwa20

• What about having a general relationship module, ie not only between persons but between any two entities.
• eg add the relationship entity + flexible form builder
• add front end methods for admins on server to be able to define the forms for each relationship (just as mentioned in the figure above ). person to person, sample to case
• It may require some work to add the form builders, having server specific enums does not make it generic enough for such a feature.