Data Exchange Framework Documentation
Welcome to the Data Exchange Framework Documentation. Here, you’ll find detailed information on our standardized data schema, guidelines for integrating the schema into your systems, and best practices for using it effectively. This documentation is intended to support organizations in adopting and implementing the schema as part of their data management strategies for displaced communities.
Table of Contents
Schema Overview
The Data Exchange Framework Schema is a standardized model designed to harmonize data collection and sharing across different organizations. It provides clear definitions for fields, data types, and relationships, enabling consistent data management for displaced individuals and skilled immigration pathways.
Explore the full schema structure, including objects like Education, Work Experience, and Language Proficiency, along with the relationships between these entities.
Implementation Guide
Whether you’re starting with a new database or adapting the schema to an existing system, this implementation guide will help you get started. Below are the different options available:
- Creating a New Database: Use our schema as the foundation for your new database. Recommended for organizations building from scratch.
- Adopting the Schema in an Existing Database: Map your existing fields to our standardized schema to ensure compatibility.
- Using the Schema in APIs: Implement the schema as a shared interface to facilitate data exchange with other organizations.
For step-by-step instructions, refer to our Database Setup Guide and API Integration Guide.
Setting Up a Database
Follow these steps to set up your database using the Data Exchange Framework Schema:
- Study the schema file: Schema File
- Convert it to SQL or YAML for your various database setup needs
- Set up validation rules to ensure data integrity.
API Integration
Implementing the schema as part of an API allows for real-time data exchange and synchronization between systems. Use the schema as a standardized interface for receiving and sending candidate data.
Privacy
Protecting the privacy of candidate data is a fundamental priority. The schema is designed to facilitate anonymized data sharing to ensure that sensitive information is handled responsibly. Each field in the schema is marked with a required attribute set to either true or false.
Fields marked as true are essential for anonymized data sharing, meaning that they contain only non-identifiable information critical for matching and reporting purposes. On the other hand, fields marked as false are optional and may include identifiable data, which should only be shared with explicit consent and under appropriate data privacy guidelines.
This approach enables organizations to use the schema flexibly, sharing only anonymized information by including fields marked as true while maintaining the privacy and security of sensitive candidate data.
Community Contributions
This schema is a collaborative product, and we welcome contributions from the community. If you have suggestions for improvement or wish to participate in the working group’s efforts, feel free to reach out to us.
Governance and Change Management
The governance of the Data Exchange Framework is managed through a structured change management process that ensures all stakeholders have a say in major updates. This process is led by the chair and co-chair of the working group and involves member discussions, decision-making, and voting on changes.
For detailed information on the governance structure and change request process, visit the Governance and Change Management Page.
Frequently Asked Questions (FAQ)
Find answers to common questions and troubleshooting tips in our FAQ section.