HHAeXchange Contact Sync: Required Database View Specification #
Overview #
To enable contact synchronization with HHAeXchange, a database view is required that provides contact information. This view will be used to sync contact data with Dataphone.
Required Columns #
The view must include the following fields for each contact:
| Column Name | Description |
| id | Unique identifier for the contact. Must be unique across all rows. |
| FirstName | First name of the contact |
| MiddleName | Middle name of the contact (optional) |
| LastName | Last name of the contact |
| HomePhone | Primary contact number |
| Phone2 | Secondary contact number (optional) |
| Phone3 | Additional contact number (optional) |
| Street1 | Primary street address |
| Street2 | Secondary address line (optional) |
| City | City |
| State | State |
| Zip | ZIP/postal code |
Note: The exact column names aren’t critical — we’ll handle mapping between the database fields and our internal contact fields.
Column Constraints #
- The id column must contain unique values for each contact. This identifier is used to detect new, updated, or removed contacts during synchronization.
Tag Columns (Optional) #
Any additional columns in the view may be treated as tags. In this case:
- The column name is interpreted as the tag category.
- The value is the tag value assigned to that contact.
Example:
| Language | ReferralSource |
| Spanish | CaseWorker |
| English | Hospital |
This means the contact has a Language tag of Spanish and a ReferralSource tag of CaseWorker.
Notes on Tags:
- Tag columns are optional and flexible.
- Contacts can have multiple tag columns.
