Archived 2022-10-11. Content moved to CDS Guide, Data formats - schemas.
Question
Arrays included in the Standards such as phoneNumbersand emailAddressesare mandatory, however the description states that those arrays be empty.
However, with the physicalAddresses array, the description states that it must contain at least one address. Does this mean that this array cannot be returned empty?
If this is the case, how is a data holder expected to respond in the below scenarios
- where a customer does not have an (any) address in their core backend systems OR
- if the address is not a valid address (in the case of data quality issue) OR
- if data for any of the mandatory fields in the relevant schema CommonPhysicalAddressWithPurpose is not available in the core systems.
Answer
If no valid physical address can be provided then an empty array in accordance with the email and phone number arrays can be provided.
Comments
2 comments
This appears to violate the standards that say "Must contain at least one address." ?
This is a good point. Unfortunately, in the scenario raised the only other option (unless the standards are changed) is a schema non-compliant response or for the data holder to make up data. The response provided is the lesser of these three evils.
It is, however, an inconsistency that should be addressed. I have raised a maintenance item to address this via the standards maintenance process.
Maintenance item link is: https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/391
Please sign in to leave a comment.