The province or state associated with the address. For Canadian and US addresses, this should be the accepted 2 digit province or state code.
| Business Object | Address |
|---|---|
| Optionality | Optional |
| Data Format | Simple String (20) |
State/Province may also refer to the following:
Unless otherwise specified, this data element should adhere to the guidelines below.
When this data element is presented, it should be formatted as per guidelines below:
When this data element is displayed, where Address Format is equal to Mail-CA it should adhere to the following guidelines:
| Field Name | Province |
|---|---|
| Null Values | Blank |
| Hint Text | None |
| Security Requirements | None |
When this data element is displayed, where Address Format is equal to Mail-US it should adhere to the following guidelines:
| Field Name | State |
|---|---|
| Null Values | Blank |
| Hint Text | None |
| Security Requirements | None |
When this data element is displayed, where Address Format is NOT equal to Mail-CA or Mail-US it should adhere to the following guidelines:
| Field Name | Region |
|---|---|
| Null Values | Blank |
| Hint Text | None |
| Security Requirements | None |
When this data element is available to be edited, a Combo / Drop Down Control should be used as outlined below, where Address Format is equal to Mail-CA:
| Field Name | Province / State |
|---|---|
| Mandatory? | Yes |
| Style | Select with Autocomplete |
| Selection Values | Contains the following Canadian Provinces:
The value saved is just the first two characters of the value (i.e. AB is saved when selecting 'AB - Alberta'). |
| Selection Sort Order | Alphabetically |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank |
| Allow Multiple Values? | No |
| Hint Text | None |
| Security Requirements | None |
When this data element is available to be edited, a Combo / Drop Down Control should be used as outlined below, where Address Format is equal to Mail-US:
| Field Name | State |
|---|---|
| Mandatory? | Yes |
| Style | Select with Autocomplete |
| Selection Values | Contains the following states:
The value saved is just the first two characters of the value (i.e. AB is saved when selecting 'AK - Alaska'). |
| Selection Sort Order | Alphabetically |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank |
| Allow Multiple Values? | No |
| Hint Text | None |
| Security Requirements | None |
When this data element is available to be edited, a Combo / Drop Down Control should be used as outlined below, where Address Format is NOT equal to Mail-CA OR Mail-US:
| Field Name | Region |
|---|---|
| Mandatory? | No |
| Style | Simple String |
| Default Value | The existing value if available. Otherwise there is no default. |
| Null Value | Blank |
| Allow Multiple Values? | No |
| Hint Text | None |
| Security Requirements | None |
When this data element is displayed in a PASIprep Data Grid it should adhere to the following guidelines:
| Column Heading | Province |
|---|---|
| Column Width | Auto |
| Filtering Style | Set |
| Contains | The formatted value of the data element. |
| Null Values | Blank |
| Column Security Requirements | This column is always available. |
| Data Security Requirements | The data in this column is always available. |