...
EMDIS rules from the EMDIS Semantics are modified accordingly to the new reality and are added to each message, where applicable.
The table below shows recommended sets of API endpoints to be implemented depending on your use of services:
Service in use API endpoint \ | 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] | no | no | no | no | highly recommended | |
| /searches/refresh [POST] | not yet available | |||||
| /searches/searchResults/donors [POST] | yes | no | yes | 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/retrieveMessages [POST] | yes | yes | check with Mark | |||
| 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 [GET] | 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 [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/sampleRequestRequest [POST] | yes (PR) | yes (PR) | ||||
| /api/v1/sampleRequestRetrieve [GET] | yes (DR, CBB) | yes (DR, CBB) | ||||
| /api/v1/sampleInfoRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | ||||
| /api/v1/sampleInfoRetrieve [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/sampleArrivalRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | ||||
| /api/v1/sampleArrivalRetrieve [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/sampleResponseRequest [POST] | yes (PR) | yes (PR) | ||||
| /api/v1/sampleResponseRetrieve [GET] | yes (DR, CBB) | yes (DR, CBB) | ||||
| /api/v1/infectiousDiseaseMarkerRequest [POST] | yes (PR) | yes (PR) | ||||
| /api/v1/infectiousDiseaseMarkerRequestRetrieve [GET] | yes (DR) | yes (DR) | ||||
| /api/v1/infectiousDiseaseMarkerResultRequest [POST] | yes (DR) | yes (DR) | ||||
| /api/v1/infectiousDiseaseMarkerResultRetrieve [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/reservationRequestRequest [POST] | yes (PR) | yes (PR) | under discussion in user group | |||
| /api/v1/reservationRequestRetrieve [GET] | yes (DR) | yes (DR) | ||||
| /api/v1/reservationResponseRequest [POST] | yes (DR) | yes (DR) | ||||
| /api/v1/reservationResponseRetrieve [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/reservationReleaseRequest [POST] | yes (PR) | yes (PR) | ||||
| /api/v1/reservationReleaseRetrieve [GET] | yes (DR) | yes (DR) | ||||
| /api/v1/requestCancellationRequest [POST] | yes (PR) | yes (PR) | ||||
| /api/v1/requestCancellationRetrieve [GET] | yes (DR) | yes (DR) | ||||
| /api/v1/requestRejectedRequest [POST] | yes (DR) | yes (DR) | ||||
| /api/v1/requestRejectedRetrieve [GET] | yes (PR) | yes (PR) | ||||
| /api/v1/resultReminderRequest [POST] | no | no | recommended | |||
| /api/v1/resultReminderRetrieve [GET] | no | no | recommended | |||
| GENERAL | ||||||
| /api/v1/messageResponse [POST] | yes | yes | ||||
| /api/v1/messageResponseRetrieve [GET] | yes | yes | ||||
| /api/v1/messageAcknowledgementRequest [POST] | all replaced by the messageResponse | |||||
| /api/v1/messageAcknowledgementRetrieve [GET] | ||||||
| /api/v1/warningRequest [POST] | ||||||
| /api/v1/warningRetrieve [GET] | ||||||
| /api/v1/messageDenialRequest [POST] | ||||||
| /api/v1/messageDenialRetrieve [GET] | ||||||
| CBU | ||||||
| /api/v1/cordBloodUnitReportRequestRequest | on hold | no | no | should be generalised to CBU and ADCUs, etc... | ||
| /api/v1/cordBloodUnitReportRequestRetrieve | on hold | yes (CBB) | yes (CBB) | |||
| /api/v1/cordBloodUnitReportResponseRequest | on hold | no | no | |||
| /api/v1/cordBloodUnitReportResponseRetrieve | on hold | yes (CBB) | yes (CBB) | |||
...