Addresses are specified in a number of CDS schemas:
A number of questions have arisen as to how addresses should be represented, and what values are appropriate for certain fields. Some of these questions are answered below, and in related articles.
The schema description for this array states that this array requires at least one entry. However, if there is no physical address data available, this array may be returned empty. See Clarification of physicalAddresses in CommonPhysicalAddressWithPurpose.
In the array of CommonPhysicalAddressWithPurpose objects, the standards require that no more than one address has a
REGISTERED. The standards do not require that an address with a
purpose of value
REGISTERED is supplied. See Common physical address with purpose entries.
In an address schema, the
state field in the CommonSimpleAddress schema is mandatory. For an address in Australia, this field must be filled from the enumeration of states and territories in Australia. The state field can be free text if the address is not in Australia. In this case, use free text to specify a state, county or other division in a country other than Australia. If there is no equivalent division, the
state field can be returned with the value of an empty string (""). See CommonSimpleAddress
state value for international addresses. This is not the same as returning a null value, or not returning the field.