...
- The Match-Connect technical specifications consist of an OpenAPI specification and the documents listed below. When developing a Match-Connect implementation, all content of the following documents is relevant and needs to be considered:
- The Semantics of Match-Connect Messages
- The Match-Connect Data Dictionary
- A Donor block is embedded in every result message, i.e., TYP_RES, IDM_RES, SMP_RES, RSV_RES, or NO_RES message, as the donor record changes in its source.
- More generally: every time data on a match list provided by donor upload changes, a DIFF upload becomes necessary to update the master data.
- The term" donor" in this document usually refers to "adult donor", "cord blood unit", or "adult donor cryopreserved unit."
- The paying institution (INST_PAY) has to be of the institution type (INST_TYPE) FIN.
- Empty/blank/missing fields in the payload mean deletion.
- Consequently, empty/blank integer or float values must be provided as null values.
- The WMDA nomenclature files (http://hla.alleles.org/wmda/index.html) must be used for all HLA fields. The central hub and/or the receiving registry may reject messages with invalid values. The details are described in the WMDA Guidelines for use of HLA Nomenclature (https://www.nature.com/articles/bmt201393; follow the link" Supplementary information").
- The Match-Connect semantics for the WMDA-approved additional codes are defined as follows:
| Message\Value | NEW | XXXX | NNNN |
|---|---|---|---|
| Patient block (see 6 - Administration) | Y | DRB3/4/5 | DRB3/4/5 |
| Donor block (see 6 - Administration) | Y | DRB3/4/5 | DRB3/4/5 |
| Typing response | Y | DRB3/4/5 | DRB3/4/5 |
| Sample response | Y | DRB3/4/5 | DRB3/4/5 |
...
Service in use API endpoint \ | Recommended for Patient & Search | Recommended for Patient & Search, download Registry | Mandatory for Connect | Mandatory for Connect, Download Registry | Comment |
|---|---|---|---|---|---|
| SEARCH & MATCH | |||||
| PATIENTS | |||||
| /patients [POST] | yes | no | yes (PR) | no | |
| /patients [PUT] | no | no | yes (PR) | no | |
| /patients [GET] | no | no | no | no | Search and Match Service Graphical User Interface (GUI) content, optional for participating organisations |
| /patients/{wmdaId} [GET] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /patients/status [PUT] | yes | no | no | no | Recommended if search results need to stay up-to-date. In that case patient status can be set to "ACT" in Search & Match. |
| /patients/user [PUT] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| SEARCH | |||||
| /searches [POST] | yes | no | yes (PR) | no | |
| /searches/patientSearches/{wmdaId} [GET] | yes | no | yes (PR) | no | |
| /searches/refreshAllPatientSearches [POST] | no | no | no | no | Not required. Search results will stay up-to-date if patient status is set to "ACT" in Search & Match. |
| /searches/{searchId} [GET] | no | no | no | no | Highly recommended |
/searches/searchResultsRefresh | no | no | no | no | Not required. Search results will stay up-to-date if patient status is set to "ACT" in Search & Match. |
| /searches/searchResults/donors [POST] | yes | no | yes (PR) | no | At least one of those is mandatory, |
| /searches/searchResults/cbus [POST] | |||||
| /searches/{searchId}/searchResults/adcu [GET] | |||||
| /searches/{searchId}/searchResults/registries [GET] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /searches/{searchId}/searchResults/cbbs [GET] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /searches/selected/donors [POST] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /searches/selected/cbus [POST] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /searches/donors/{searchResultsId} [GET] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /searches/cbus/{searchResultsId} [GET] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| DASHBOARD | |||||
| for all | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| CONNECT API | |||||
| ATTACHMENT | |||||
| /api/v1/attachmentTicket [POST] | no | no | Optional for participating organisations | ||
| /api/v1/attachmentDownloadURL [POST] | no | no | Optional for participating organisations | ||
| /api/v1/attachmentDownloadedNotification [POST] | no | no | Optional for participating organisations | ||
| RETRIEVE | |||||
| /api/v1/availableMessages [POST] | yes | yes | Mandatory so individual endpoints will only be called if there is a message available at that endpoint. | ||
| ADMIN | |||||
| /api/v1/alertRetrieve [GET] | no | no | Recommended | ||
| /api/v1/alertUpdateRetrieve [GET] | no | no | Recommended | ||
| PATIENT | |||||
| /api/v1/updateRegisteredPatient [POST] | yes (PR) | yes (PR) | |||
| /api/v1/updateRegisteredPatientRetrieve [GET] | yes (DR) | yes (DR) | |||
| PING | |||||
| /api/v1/pingRequest [POST] | no | no | Optional for participating organisations | ||
| /api/v1/pingRetrieve [POST] | no | no | Optional for participating organisations | ||
| TEXT MESSAGE | |||||
| /api/v1/textMessageRequest [POST] | no | no | Optional for participating organisations | ||
| /api/v1/TextMessageRetrieve [GET] | no | no | Optional for participating organisations | ||
| REQUEST | |||||
| /api/v1/genericRequestRequest [POST] | no | no | |||
| /api/v1/genericRequestRetrieve [GET] | no | no | |||
| /api/v1/extendedTypingRequestRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/extendedTypingRequestRetrieve [POST] | no | no | recommended for DCs with incompletely typed donors | ||
| /api/v1/extendedTypingResponseRequest [POST] | no | no | recommended for DCs with incompletely typed donors | ||
| /api/v1/extendedTypingResponseRetrieve [POST] | yes (PR) | yes (PR) | |||
| /api/v1/sampleRequestRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/sampleRequestRetrieve [POST] | yes (DR, CBB) | yes (DR, CBB) | |||
| /api/v1/sampleInfoRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | |||
| /api/v1/sampleInfoRetrieve [POST] | yes (PR) | yes (PR) | |||
| /api/v1/sampleArrivalRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | |||
| /api/v1/sampleArrivalRetrieve [POST] | yes (PR) | yes (PR) | |||
| /api/v1/sampleResponseRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/sampleResponseRetrieve [POST] | yes (DR, CBB) | yes (DR, CBB) | |||
| /api/v1/infectiousDiseaseMarkerRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/infectiousDiseaseMarkerRequestRetrieve [POST] | yes (DR) | yes (DR) | |||
| /api/v1/infectiousDiseaseMarkerResultRequest [POST] | yes (DR) | yes (DR) | |||
| /api/v1/infectiousDiseaseMarkerResultRetrieve [POST] | yes (PR) | yes (PR) | |||
| /api/v1/reservationRequestRequest [POST] | no (PR) | no (PR) | reservations are mandatory upon any other request | ||
| /api/v1/reservationRequestRetrieve [POST] | yes (DR) | yes (DR) | |||
| /api/v1/reservationResponseRequest [POST] | yes (DR) | yes (DR) | |||
| /api/v1/reservationResponseRetrieve [POST] | yes (PR) | yes (PR) | reservation response will be sent after every request | ||
| /api/v1/reservationReleaseRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/reservationReleaseRetrieve [POST] | yes (DR) | yes (DR) | |||
| /api/v1/requestCancellationRequest [POST] | yes (PR) | yes (PR) | |||
| /api/v1/requestCancellationRetrieve [POST] | yes (DR) | yes (DR) | |||
| /api/v1/requestRejectedRequest [POST] | yes (DR) | yes (DR) | |||
| /api/v1/requestRejectedRetrieve [POST] | yes (PR) | yes (PR) | |||
| /api/v1/resultReminderRequest [POST] | no | no | recommended | ||
| /api/v1/resultReminderRetrieve [POST] | no | no | recommended | ||
| GENERAL | |||||
| /api/v1/messageResponse [POST] | yes | yes | |||
| /api/v1/messageResponseRetrieve [POST] | yes | yes | |||
| CBU | |||||
| /api/v1/cordBloodUnitReportRequestRequest | no | no | should be generalised to CBU and ADCUs, etc... | ||
| /api/v1/cordBloodUnitReportRequestRetrieve | yes (CBB) | yes (CBB) | |||
| /api/v1/cordBloodUnitReportResponseRequest | no | no | |||
| /api/v1/cordBloodUnitReportResponseRetrieve | yes (CBB) | yes (CBB) | |||
2.3 API authentication
| Include Page | ||||
|---|---|---|---|---|
|
...