The table below shows recommended sets of API endpoints to be implemented depending on your use of services:
Service in use API endpoint \ | Recommended for Patient & Search | Recommended for Patient & Search, download Registry | Mandatory for Connect | Mandatory for Connect, Download Registry | Phase 1 | Phase 2 | Document? | Comment |
|---|---|---|---|---|---|---|---|---|
| SEARCH & MATCH | ||||||||
| PATIENTS | ||||||||
| /patients [POST] | yes | no | yes (PR) | yes (PR) | x | |||
| /patients [PUT] | no | no | yes (PR) | no | x | |||
| /patients/list [GET] | no | no | no | no | x | Search & Match Service Graphical User Interface (GUI) content, optional for participating organisations | ||
| /patients/{wmdaId} [GET] | no | no | no | no (but strongly recommended) | x | Search & Match Service GUI content, optional for participating organisations | ||
| /patients/status [PUT] | yes | no | no | no | x | 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 | x | Search & Match Service GUI content, optional for participating organisations | ||
| SEARCH | ||||||||
| /searches [POST] | yes | no | yes (PR) | no | x | |||
| /searches/patientSearches/{wmdaId} [GET] | yes | no | yes (PR) | no | x | |||
| /searches/refreshAllPatientSearches [POST] | no | no | no | no | x | 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 | x | Highly recommended | ||
| no | no | no | no | x | 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 | x | At least one of those is mandatory, | ||
| /searches/searchResults/cbus [POST] | x | |||||||
| /searches/{searchId}/searchResults/adcu [POST] | ||||||||
| /searches/{searchId}/searchResults/registries [GET] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| /searches/{searchId}/searchResults/cbbs [GET] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| /searches/selected/donors [POST] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| /searches/selected/cbus [POST] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| /searches/donors/{searchResultsId} [GET] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| /searches/cbus/{searchResultsId} [GET] | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| DASHBOARD | ||||||||
| for all | no | no | no | no | x | Search & Match Service GUI content, optional for participating organisations | ||
| CONNECT API | ||||||||
| ATTACHMENT | ||||||||
| /api/v2/attachmentTicket [POST] | no | no | Optional for participating organisations | |||||
| /api/v2/attachmentDownloadURL [POST] | no | no | Optional for participating organisations | |||||
| /api/v12/attachmentDownloadedNotification [POST] | no | no | Optional for participating organisations | |||||
| RETRIEVE | ||||||||
| /api/v2/availableMessages [GET] | yes | yes | x | Mandatory so individual endpoints will only be called if there is a message available at that endpoint. | ||||
| /api/v2/availableMessagesAll [POST] | Not implemented - Will only implement if early adopters request | |||||||
| /api/v2/recoverMessages [POST] | no | no | x | Optional | ||||
| ADMIN | ||||||||
| /api/v2/alertRetrieve [POST] | no | no | x | defer | Recommended | |||
| /api/v2/alertUpdateRetrieve [POST] | no | no | x | Recommended | ||||
| PATIENT | ||||||||
| /api/v2/updateRegisteredPatient [POST] | yes (PR) | yes (PR) | x | defer | ||||
| /api/v2/updateRegisteredPatientRetrieve [POST] | yes (DR) | yes (DR) | x | |||||
| PING | ||||||||
| /api/v2/pingRequest [POST] | no | no | x | Optional for participating organisations | ||||
| /api/v2/pingRetrieve [POST] | no | no | x | Optional for participating organisations | ||||
| TEXT MESSAGE | ||||||||
| /api/v2/textMessageRequest [POST] | no | no | x | Optional for participating organisations | ||||
| /api/v2/TextMessageRetrieve [POST] | no | no | x | Optional for participating organisations | ||||
| REQUEST | ||||||||
| /api/v2/genericRequestRequest [POST] | no | no | x | x | ||||
| /api/v2/genericRequestRetrieve [POST] | no | no | x | |||||
| /api/v2/extendedTypingRequestRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/extendedTypingRequestRetrieve [POST] | no | no | x | recommended for DCs or CBBs with incompletely typed donors / cbus | ||||
| /api/v2/extendedTypingResponseRequest [POST] | no | no | x | x | recommended for DCs with incompletely typed donors | |||
| /api/v2/extendedTypingResponseRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/extendedTypingResponseRequestCbu [POST] | no | no | x | x | recommended for CBBs with incompletely typed cbus | |||
| /api/v2/extendedTypingResponseRetrieveCbu [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/sampleRequestRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/sampleRequestRetrieve [POST] | yes (DR, CBB) | yes (DR, CBB) | x | |||||
| /api/v2/sampleInfoRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | x | x | ||||
| /api/v2/sampleInfoRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/sampleArrivalRequest [POST] | yes (DR, CBB) | yes (DR, CBB) | x | x | ||||
| /api/v2/sampleArrivalRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/sampleResponseRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/sampleResponseRetrieve [POST] | yes (DR, CBB) | yes (DR, CBB) | x | |||||
| /api/v2/infectiousDiseaseMarkerRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/infectiousDiseaseMarkerRequestRetrieve [POST] | yes (DR) | yes (DR) | x | |||||
| /api/v2/infectiousDiseaseMarkerResultRequest [POST] | yes (DR) | yes (DR) | x | x | ||||
| /api/v2/infectiousDiseaseMarkerResultRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/infectiousDiseaseMarkerCbuResultRequest [POST] | yes (CBB) | yes (CBB) | x | x | ||||
| /api/v2/infectiousDiseaseMarkerCbuResultRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/reservationRequestRequest [POST] | no (PR) | no (PR) | x | x | reservations are mandatory upon any other request | |||
| /api/v2/reservationRequestRetrieve [POST] | yes (DR) | yes (DR) | x | |||||
| /api/v2/reservationResponseRequest [POST] | yes (DR) | yes (DR) | x | x | ||||
| /api/v2/reservationResponseRetrieve [POST] | yes (PR) | yes (PR) | x | reservation response will be sent after every request | ||||
| /api/v2/reservationCbuResponseRequest [POST] | yes (CBB) | yes (CBB) | x | x | ||||
| /api/v2/reservationCbuResponseRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/reservationReleaseRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/reservationReleaseRetrieve [POST] | yes (DR) | yes (DR) | x | |||||
| /api/v2/requestCancellationRequest [POST] | yes (PR) | yes (PR) | x | x | ||||
| /api/v2/requestCancellationRetrieve [POST] | yes (DR) | yes (DR) | x | |||||
| /api/v2/requestRejectedRequest [POST] | yes (DR) | yes (DR) | x | x | ||||
| /api/v2/requestRejectedRetrieve [POST] | yes (PR) | yes (PR) | x | |||||
| /api/v2/resultReminderRequest [POST] | no | no | x | x | recommended | |||
| /api/v2/resultReminderRetrieve [POST] | no | no | x | recommended | ||||
| GENERAL | ||||||||
| /api/v2/messageResponse [POST] | yes | yes | x | |||||
| /api/v2/messageResponseRetrieve [POST] | yes | yes | x | |||||
| CBU | ||||||||
| /api/v2/cordBloodUnitReportRequestRequest [POST] | no | no | x | should be generalised to CBU and ADCUs, etc... | ||||
| /api/v2/cordBloodUnitReportRequestRetrieve [POST] | yes (CBB) | yes (CBB) | ||||||
| /api/v2/cordBloodUnitReportResponseRequest [POST] | yes (CBB) | yes (CBB) | x | |||||
| /api/v2/cordBloodUnitReportResponseRetrieve [POST] | no | no | ||||||
Change log new semantics April 2025:
CBU endpoints and responses
The semantics now include the specifications of the CBU endpoints. This also includes a specific endpoint as a response to the ExtendedTypingRequest and the InfectiousDiseaseMarkerRequest. See next paragraph.
ExtendedTypingResponse and InfectiousDiseaseMarkerResult splitted to CBU and Adult donor specific endpoints
Before there was one endpoint available as a response for the ExtendedTypingRequest and one endpoint as a response to the InfectiousDiseaseMarkerRequest. In the new version of the semantics there are now separate endpoints for the CBU (Cord's) and (Adult) donors. This means the following endpoints are added to the semantics:
Document Exchange
Following the RFC (link), the semantics now include the specifications for (general) document exchange. The semantics hold four new general endpoints to accommodate document exchange, including:
and four endpoints for sending and retrieving cordBloodUnitReport(s), with specific endpoints:
Attachment block added to existing and new endpoints
To provide the possibility to exchange the information of an attachment together with the request/response message send to the receiving registry of an attachment that is uploaded, and can be downloaded by the receiving registry, in the semantics an attachment block is added to some of the endpoints.
ExtendedTypingResponse HLA information
The HLA block is now included in the response block of the extendedtypingresponse. The block itself is required, whereas the fields within the block are not technically required as this is dependent on the request.
Field name harmonization for consistency
Fields within the ExtendedTyping and InfectiousDiseaseMarker endpoints were harmonized to align with the fields as mentioned within other endpoints.
Sample response, addition of ccr5
The ccr5 field is added to the response block of the sampleResponse endpoint.