These guidelines are intended to provide a baseline set of Match-Connect administration practices for all Match-Connect participants. Due to the critical nature of business operations facilitated via Match-Connect, it is expected that these guidelines will be followed closely and consistently. This should ensure the ongoing success of message exchange between Match-Connect partners.
- The Match-Connect system architecture is based on privacy and security by design principles. Deviation from these principles has to be justified, documented, and approved. Typically, a trade-off has to be made between privacy/security and overall system complexity.
- A registry-specific Match-Connect contact person should respond to all Match-Connect-related inquiries within 24 hours (excluding weekends), regardless of the content of the inquiry.
Information on how to reach a registry-specific Match Connect contact person will be published on WMDA Share. - Inquiries that reference system problems (for example, problems with sending/receiving of messages) should be given high priority.
- Sufficient time and care should be devoted to development and testing when establishing a connection with Match-Connect. Close collaboration is often necessary between new Match-Connect partners and WMDA to ensure that business and system expectations are adequately met on all sides before exchanging Match-Connect messages in production environments.
- If a new Match-Connect partner does not want to implement the whole set of available message types, reasonable groups of message types should be implemented together. (TBD: reasonable sets of messages, also known as EMDIS implementation level.)
- Generally faxes and emails should be avoided in an electronic communication system. If they become necessary, it’s recommended not to mix channels in message groups. For example, if the TYP_REQ was in Match-Connect, the result should be in Match-Connect as well and not by fax/email (and vice versa).
The implementation of the central part of the Match-Connect architecture (broker, central hub) is based on the following principles:
- No data of Match-Connect participants is kept after retrieval by the receiving hub
- No data (payload) of Match-Connect messages is changed
- Ensure integrity and traceability of the messages exchanged (for details see Chapter 6.0).
The Match-Connect system acts as a central broker of information exchange between registries participating in the Match-Connect ecosystem, also called the central hub from here on. The central hub bears the responsibility to:
- route information from the sending registry to the receiving registry and maintain information integrity
- provide meta information to aid in the investigation of message failures or data synchronization problems
- provide meta information for traceability
- ensure the integrity of the data in the Search & Match Service
- perform syntactic validation of the information (e.g. appropriate information structure, allowable values, valid dates, etc)
In performing these duties, the Match-Connect system will inspect the contents of messages to determine who to route messages to and to perform basic validation. This content is not intended to be reviewed by administrators of the system except in cases where this is required to analyze message failures or data synchronization problems. The central system will never modify original message contents but additional meta information "blocks" will be added to ensure the receiving registry is aware of:
- Which registry sent the information
- What type of information is contained
- A message identifier
- A timestamp
- Any failed validations detected by the Match-Connect system
- A sequence number to know if any message is missing.
The high-level message flow can be found in Chapter 5.
1.1 - Definitions / Abbreviations
| Term | Definition | Aliases / Abbreviations |
|---|---|---|
| Application Programming Interface | A way for two or more computer programs to communicate with each other. A type of software interface, offering a service to other pieces of software. | API |
| Cord Blood Bank | An organization representing an inventory of cord blood units | CBB |
| Client Uniform Resource Locator | Client URL (cURL, pronounced “curl”) is a command line tool that enables data exchange between a device and a server through a terminal. | cURL / CURL |
| Differential upload | A differential upload (DIFF) is a method of synchronizing the donor / cord listings of registries with the WMDA. A differential upload is a file containing only records which contain updates, as opposed to a full (FULL) file which contains all donor or cord records, regardless of whether the individual records have updates. | DIFF |
| Donor Registry | A registry representing donors | DR |
| European Marrow Donor Information System | A peer-to-peer system used for facilitation of the search and procurement process amongst registries. This includes the EMDIS Communication System (ECS) which defines a protocol for message exchange and the various implementations of ECS (Ester, PerlECS, etc). At a conceptual level, the EMDIS network includes the individual software implementations of each EMDIS hub (typically a registry). | EMDIS |
| Hypertext Transfer Protocol | The Hypertext Transfer Protocol (HTTP) is the foundation of the World Wide Web, and is used to load webpages using hypertext links. HTTP is an application layer protocol designed to transfer information between networked devices and runs on top of other layers of the network protocol stack. | HTTP |
| Human Leukocyte Antigen | The human leukocyte antigen (HLA) system or complex is a complex of genes on chromosome 6 in humans which encode cell-surface proteins responsible for regulation of the immune system. The HLA system is also known as the human version of the major histocompatibility complex (MHC) found in many animals. | HLA |
| Match-Connect | The APIs and central system of the WMDA used for facilitation of the search and procurement process amongst registries. This includes the infrastructure for routing of information between participating registries and associated business logic as defined in the Match-Connect Semantics. APIs contained within Match-Connect are:
The Match-Connect system is intended as a centralized alternative to (and evolution of) the EMDIS system. | Central Hub MC |
| Patient Registry | A registry representing patients | PR |
| Representational State Transfer | Representational State Transfer (REST) is a software architectural style that was created to guide the design and development of the architecture for the World Wide Web. REST defines a set of constraints for how the architecture of a distributed, Internet-scale hypermedia system, such as the Web, should behave | REST RESTful |
| Search & Match Service | The APIs and user interface (UI) of the WMDA used for searching the global inventory of available donors and cord blood units by transplant centers and registries. APIs contained within the Search & Match Service are:
These APIs are leveraged in tandem with the Connect APIs as part of the overall Match-Connect system. | Search & Match SM / S&M |
| Swagger | Swagger is a suite of tools for API developers and a former specification upon which the OpenAPI Specification is based. |
v1.0.1