| Message | NEW | XXXX | NNNN |
|---|---|---|---|
| PAT_UPD | Y | DRB3/4/5 | DRB3/4/5 |
| Donor_DIFF | Y | DRB3/4/5 | DRB3/4/5 |
| TYP_RES | Y | DRB3/4/5 | DRB3/4/5 |
| SMP_RES | Y | DRB3/4/5 | DRB3/4/5 |
As one can see from the first sentence above, the API documentation is part of the new documentation set. This API documentation is called "swagger" for shortness. It is located at this publicly available address: https://apispecs.wmda.info/
At this address one can find both Search & Match API specifications and Connect API specifications:
Since the communication is now split to communication with WMDA's Search & Match and messaging with other registries, each API request in the Semantics may be represented in two styles:
Wherever suitable, we included EMDIS names of the messages in parentheses, e.g. 5.1 - Extended Typing Request (TYP_REQ).
In many cases, the current implementation of EMDIS messages will require a conversion of the flat EMDIS message structure into the nested (multi-level) structure of the API messages. All the fields in API have better names: e.g., REQ_DATE becomes requestDate.
EMDIS rules from the EMDIS Semantics are modified accordingly to the new reality and are added to each message, where applicable.
| API | Comment | mandatory for Patient & Search | mandatory for Patient & Search, download Registry | mandatory for Connect | mandatory for Connect, download Registry | Comment |
|---|---|---|---|---|---|---|
| SEARCH & MATCH | ||||||
| PATIENTS | ||||||
| /patients [POST] | Create a patient | yes | no | yes | no | |
| /patients [PUT] | Update an existing patient | no | no | yes | no | |
| /patients [GET] | Retrieved patients list | no | no | no | no | Search and Match Service Graphical User Interface (GUI) content, optional for participating organisations |
| /patients/{wmdaId} [GET] | Retrieve | no | no | no | no | Search and Match Service GUI content, optional for participating organisations |
| /patients/status [PUT] | yes | no | yes | no | ||
| /patients/user [PUT] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations | |
| SEARCH | ||||||
| /searches [POST] | yes | no | yes | no | for recommendations see semantics  | |
| /searches/patientSearches/{wmdaId} [GET] | yes | no | yes | no | ||
| /searches/refreshAllPatientSearches [POST] | no | no | no | no | Search and Match Service GUI content, optional for participating organisations | |
| /searches/{searchId} [GET] | yes | no | yes | no | ||
| /searches/refresh [POST] | not yet available | |||||
| /searches/searchResults/donors [POST] | ||||||
| /searches/searchResults/cbus [POST] | ||||||
| /searches/{searchId}/searchResults/adcu [GET] | ||||||
| /searches/{searchId}/searchResults/registries [GET] | ||||||
| /searches/{searchId}/searchResults/cbbs [GET] | ||||||
| /searches/selected/donors [POST] | ||||||
| /searches/selected/cbus [POST] | ||||||
| /searches/donors/{searchResultsId} [GET] | ||||||
| /searches/cbus/{searchResultsId} [GET] | ||||||
| CONNECT API | ||||||
| ATTACHMENT | ||||||
| /api/v1/attachmentTicket [POST] | ||||||
| /api/v1/attachmentDownloadURL [POST] | ||||||
| /api/v1/attachmentDownloadedNotification [POST] | ||||||
| RETRIEVE | ||||||
| /api/v1/retrieveMessages [POST] | ||||||
| ADMIN | ||||||
| /api/v1/alertRetrieve [GET] | ||||||
| /api/v1/alertUpdateRetrieve [GET] | ||||||
| PATIENT | ||||||
| /api/v1/updateRegisteredPatient [POST] | ||||||
| /api/v1/updateRegisteredPatientRetrieve [GET] | ||||||
| PING | ||||||
| /api/v1/pingRequest [POST] | ||||||
| /api/v1/pingRetrieve [POST] | ||||||
| TEXT MESSAGE | ||||||
| /api/v1/textMessageRequest [POST] | ||||||
| /api/v1/TextMessageRetrieve [GET] | ||||||
| REQUEST | ||||||
| /api/v1/genericRequestRequest [POST] | ||||||
| /api/v1/genericRequestRetrieve [GET] | ||||||
| /api/v1/extendedTypingRequestRequest [POST] | ||||||
| /api/v1/extendedTypingRequestRetrieve [GET] | ||||||
| /api/v1/extendedTypingResponseRequest [POST] | ||||||
| /api/v1/extendedTypingResponseRetrieve [GET] | ||||||
| /api/v1/sampleRequestRequest [POST] | ||||||
| /api/v1/sampleRequestRetrieve [GET] | ||||||
| /api/v1/sampleInfoRequest [POST] | ||||||
| /api/v1/sampleInfoRetrieve [GET] | ||||||
| /api/v1/sampleArrivalRequest [POST] | ||||||
| /api/v1/sampleArrivalRetrieve [GET] | ||||||
| /api/v1/sampleResponseRequest [POST] | ||||||
| /api/v1/sampleResponseRetrieve [GET] | ||||||
| /api/v1/infectiousDiseaseMarkerRequest [POST] | ||||||
| /api/v1/infectiousDiseaseMarkerRequestRetrieve [GET] | ||||||
| /api/v1/infectiousDiseaseMarkerResultRequest [POST] | ||||||
| /api/v1/infectiousDiseaseMarkerResultRetrieve [GET] | ||||||
| /api/v1/reservationRequestRequest [POST] | ||||||
| /api/v1/reservationRequestRetrieve [GET] | ||||||
| /api/v1/reservationResponseRequest [POST] | ||||||
| /api/v1/reservationResponseRetrieve [GET] | ||||||
| /api/v1/reservationReleaseRequest [POST] | ||||||
| /api/v1/reservationReleaseRetrieve [GET] | ||||||
| /api/v1/requestCancellationRequest [POST] | ||||||
| /api/v1/requestCancellationRetrieve [GET] | ||||||
| /api/v1/requestRejectedRequest [POST] | ||||||
| /api/v1/requestRejectedRetrieve [GET] | ||||||
| /api/v1/resultReminderRequest [POST] | ||||||
| /api/v1/resultReminderRetrieve [GET] | ||||||
| GENERAL | ||||||
| /api/v1/messageResponse [POST] | ||||||
| /api/v1/messageResponseRetrieve [GET] | ||||||
| /api/v1/messageAcknowledgementRequest [POST] | ||||||
| /api/v1/messageAcknowledgementRetrieve [GET] | ||||||
| /api/v1/warningRequest [POST] | ||||||
| /api/v1/warningRetrieve [GET] | ||||||
| /api/v1/messageDenialRequest [POST] | ||||||
| /api/v1/messageDenialRetrieve [GET] |