ConsumerDataStandardsAustralia / standards-maintenance

This repository houses the interactions, consultations and work management to support the maintenance of baselined components of the Consumer Data Right API Standards and Information Security profile.
41 stars 9 forks source link

Adding support for given names #394

Closed WestpacOpenBanking closed 2 years ago

WestpacOpenBanking commented 3 years ago

Description

We note that in some cases a person’s first and middle names may sometimes be captured and stored within a single field in IT systems typically as “first names” or “given names”. An common example is the Australian passport application form which currently captures only family name and given names. Currently the CommonPerson schema specifies the firstName as optional and the middleName as mandatory, however to be able to accurately cater for the scenario above we propose that the standards allow for the provision of Given Name/s (a list of all the customer’s first and middle names) in these circumstances.

Area Affected

The CommonPerson object definition which is provided as part of Get Customer and Get Customer Detail API responses.

Change Proposed

We recommend adding a ‘Given Name/s’ list to the CommonPerson object definition.

CDR-API-Stream commented 3 years ago

Please note, Westpac have indicated to the DSB they would like to include this issue in the next standards-maintenance iteration. Priority will be discussed with community members on the commencement of Iteration 8.

CDR-API-Stream commented 3 years ago

Thanks @WestpacOpenBanking, first name and middle names are substitutes for given names. You can provide one "given name" in the firstName field and all remaining given names in the middleNames array.

Example Full name Given Names firstName value middleNames[] value lastName
A - given names can be determined Michael James Smith "Michael", "James" "Michael" ["James"] "Smith"
B - hyphenated compound first name Mary-Jane Smith "Mary-Jane" "Mary-Jane" [ ] "Smith"
C - compound given names as first name cannot be separated John Paul Taylor "John Paul" "John Paul" [ ] "Taylor"
C2 - compound first names with middle names John Paul Henry Arthur Taylor "John Paul", "Henry", "Arthur" "John Paul" ["Henry", "Arthur" ] "Taylor"
C3 - many given names are held by the DH as a single string and decomposition cannot be determined John Paul Winston Taylor "John Paul Winston" "John Paul Winston" [ ] "Taylor"
D - many given names but only one first name Julie Louise Amanda Alice Cooper "Julie", "Louise", "Amanda", "Alice" "Julie" ["Louise", "Amanda", "Alice"] "Cooper"
E - many given names but the person associated by a non-first given name Mary Barbara Hamilton Cartland "Mary", "Barbara", "Hamilton" "Barbara" ["Mary", "Hamilton"] "Cartland"
F - Non-English name where surname is presented first Nguyen Thi Minh Khai "Thi", "Minh", "Khai" "Thi" ["Minh", "Khai"] "Nguyen"
G - Person only has one name Rhianna null [ ] "Rhianna"

Are there any instances where firstName and middleNames fields cannot be used to correctly present all given names?

Notes:

CDR-API-Stream commented 3 years ago

Based on discussion in the maintenance iteration call, examples C2 and C3 have been provided.

WestpacOpenBanking commented 3 years ago

We are supportive of the proposed option. We request that the changes be incorporated directly into the data standards to avoid ambiguity on whether data holder implementations would be compliant with the data standards when implementing this option. Alternatively, if the data standards are not updated to reflect this change, we request that guidance is published stating that this approach would be compliant with rule 4.6 (4).

CDR-API-Stream commented 3 years ago

Hi @WestpacOpenBanking, this change is now staged for review: https://github.com/ConsumerDataStandardsAustralia/standards-staging/compare/release/1.11.1...maintenance/394

The change includes clarifying documentation to the standards to deal with the handling of given names under these situations. Because it is a documentation fix, this change is intended for release v1.11.1.

CDR-API-Stream commented 2 years ago

This issue has been included in the v1.11.1 documentation errata and patch release.

This issue will be closed accordingly.