design guidance and best practices

Partners seeking to develop a new data exchange should start by reading the “Exchange Design Guidance and Best Practices Document.” The document describes the process of designing a data exchange from beginning to end. It is intended for both technical and non-technical audiences. The first section provides information to help project participants understand the data exchange design process and avoid common pitfalls. The second, more technical section, “Data Exchange Design Best Practices,” will be of most use to technical architects, analysts, programmers, and exchange implementers.

data exchange components

A fully functional and documented data exchange is comprised of a number of different components, which are listed in the Flow Documentation Checklist. The checklist describes the required and optional documents that a group should plan to produce as part of the process of creating a new data exchange.

Some key required components include, XML schemas, Flow Configuration Documents (FCD), Data Exchange Templates (DET), and Trading Partner Agreements (TPAs).

• XML Schemas
  XML schemas are the software framework defining the data elements and rules in a data exchange. They define the structure, content and semantics of XML documents, which facilitate Node-to-Node exchanges of data among Network partners. Click here for more information on XML schemas and how to develop them to meet Exchange Network standards and guidelines.

• Data Exchange Templates (DETs)
  Data exchange templates list a schema’s data elements with their definitions and validation rules. They also give examples of data content. A DET is a more human readable version of the XML schema. They help implementers map their data to the schema. This DET template will help schema developers create DETs and schema for new data exchanges.

• Flow Configuration Documents (FCDs)
  FCDs identify and standardize the minimum information needed by partners to exchange data on the Network. They describe both a data exchange’s technical configuration and its business processes. The FCD Template provides an outline and suggested format for Network partners to use when creating an FCD for a new data exchanges.

• Trading Partner Agreements (TPAs)
  Trading Partner Agreements define in writing, for specific data exchanges, the participating partners’ individual and joint responsibilities in stewardship, security, and other items essential for the effective exchange of information on the Exchange Network. TPAs are intended to encourage partners to clarify the appropriate and agreed upon use, ownership, type, quality, and frequency of data exchanged between and among partners. The TPA Procedure outlines requirements for developing a TPA. You can also find additional tips for developing an effective TPA in this document entitled Trading Partner Agreements: Analysis and Best Practices.

Partners creating or updating a data exchange must submit each of the required resources in the Flow Documentation Checklist to the Network Technology Group for a review. The purpose of this review is to make sure exchanges follow Exchange Network standards and design rules, and to encourage the use of best practices. Click here to get more information on how to perform the Schema Conformance and Flow Documentation Review and to learn how to get your data exchange published to the Exchange Network website.