| Feature | Requested by | What changed | Expected Delivery Date | WMDA Ticket # |
|---|
| Add Serology object with two fields to hla.a, hla.b, hla.c , drb1, dqb1 | TWG | Added optional serology object with two fields to hla.a, hla.b, hla.c , drb1, dqb1 withing hla object for TYP_RES, IDM_RES, RSV_RES, SMP_RES, TYP_REQ, Generic Request, IDM_REQ, RSV_REQ, SMP_REQ, Update Registered Patient endpoints. Affected payloads: - /api/v2/extendedTypingResponseRequest (TYP_RES)
- Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 & response.hla.a, response.hla.b, response.hla.c, reponse.hla.drb1, response.hla.dqb1 objects
- /api/v2/extendedTypingResponseRetrieve (TYP_RES)
- Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 & messages.originalMessage.response.hla.a, messages.originalMessage.response.hla.b, messages.originalMessage.response.hla.c, messages.originalMessage.response.hla.drb1, messages.originalMessage.response.hla.dqb1 objects
- /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 object
- /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 objects
- /api/v2/reservationResponseRequest (RSV_RES)
- Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 objects
- /api/v2/reservationResponseRetrieve (RSV_RES)
- Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 objects
- /api/v2/sampleResponseRequest (SMP_RES)
- Request body: response.hla.a, response.hla.b, response.hla.c, reponse.hla.drb1, response.hla.dqb1 objects
- /api/v2/sampleResponseRetrieve (SMP_RES)
- Response body: messages.originalMessage.response.hla.a, messages.originalMessage.response.hla.b, messages.originalMessage.response.hla.c, messages.originalMessage.response.hla.drb1, messages.originalMessage.response.hla.dqb1 objects
- /api/v2/extendedTypingRequestRequest (TYP_REQ)
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
- /api/v2/GenericRequestRequest
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/GenericRequestRetrieve
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
- /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
- /api/v2/reservationRequestRequest (RSV_REQ)
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/reservationRequestRetrieve (RSV_REQ)
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
- /api/v2/sampleRequestRequest (SMP_REQ)
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/sampleRequestRetrieve (SMP_REQ)
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
- /api/v2/updateRegisteredPatientRequest
- Request body: patient.hla.a, patient.hla.b, patient.hla.c, patient.hla.drb1, patient.hla.dqb1 objects
- /api/v2/updateRegisteredPatientRetrieve
- Response body: messages.originalMessage.patient.hla.a, messages.originalMessage.patient.hla.b, messages.originalMessage.patient.hla.c, messages.originalMessage.patient.hla.drb1, messages.originalMessage.patient.hla.dqb1 objects
| 2025-09-25 | 10817 v2.0 |
| Add extra logic when confirming reservation | TWG | Soft fail is triggered when confirming Reservation Response (RSV_RES) endpoint without reserving the donor. If "response.confirmed" = YES and "donor.status" ≠ RS (reserved), API will respond with a soft fail - 200 OK and include a warning: "responseType": /"warning"
"wmdaRemarks":
"remarkType": "invalidInformation"
"description": "Donor Status must be RS (reserved) when confirming reservation" | 2025-10-08 | 13535 v2.0 |
| Add extra validation for selected fields | WMDA | Added following validations: - "donor.dateOfBirth" field is mandatory and nullable: false. Used in TYP_RES, IDM_RES, RSV_RES endpoints
- "hlaNomenclatureVersion" field has maxLenght: 5. Used in TYP_RES, SMP_RES endpoints
- "organisationId" has minLength: 5, maxLength: 19, nullable: false, and the pattern: ^\\d{4}\\w{1,19}$. Used in institutionPaying object in TYP_REQ. IDM_REQ, RSV_REQ, SMP_REQ & institutionToSendSampleTo object in SMP_REQ endpoints.
- "donorId" field in Embedded Donor Block (donor in request object) has the following validation in TYP_REQ, genericRequest, IDM_REQ, REQ_CAN, NO_RES, RSV_REQ, reservationRelease, RES_REM, SMP_ARR, SMP_INFO, SMP_REQ, SMP_RES, TXT_MSG endpoints:
- If donorType is adult, then grid must be provided with minLength: 19, maxLength: 19
- If donorType is adcu, then adcuId must be provided with minLength: 13, maxLength: 13
- If donorType is cbu, then cordId must be provided with minLength: 1, maxLength: 17
| 2025-10-08 | 13617 v2.0 |
| Add "antiChagas" field to the marker and idm objects | TWG | Added new optional field "antiChagas" to the marker and idm objects in IDM_REQ (request.marker object), IDM_RES (response.marker , response.idm & donor.idm objects), TYP_RES (donor.idm object), RSV_RES (donor.idm object), SMP_RES (response.idm object) endpoints | 2025-10-08 | 13562 v2.0 |
"remark" field added to the /api/v2/sampleResponseRequest (SMP_RES) endpoint | TWG | Optional field "remark" added to the response object in SMP_RES endpoint. Affected payloads: - /api/v2/sampleResponseRequest (SMP_RES)
- Request body: response object
- /api/v2/sampleResponseRetrieve (SMP_RES)
- Response body: messages.originalMessage.response object
| 2025-10-08 | 13562 v2.0 |
Selected fields are made mandatory in generalInformation & metaInformation objects | WMDA | Mandatory enforcement added for specific fields according to Semantics in: - Embedded 'generalInformation' Response block: "limit", "totalCount", "remainingCount", "isSuccessful", "summary" fields.
- Embedded Meta Information block: "referenceMessageId", "deliveredAtUtc", "sendingRegistry", "messageSequenceNumber", "messageType" fields
- "responseType" field made optional
| 2025-10-08 | 13561 v2.0 |
| endpoints: /genericDocumentExchangeRequestRequest & Retrieve | MC-RFC 03: Document Exchange | Endpoint used to send a document. And retrieve message with Retrieve endpoint. |
| 13196 v2.1 |
| endpoints: /cordBloodUnitReportRequestRequest & Retrieve | MC-RFC 03: Document Exchange | Endpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint. |
| 13198 v2.1 |
| endpoints: /cordBloodUnitReportResponseRequest & Retrieve | MC-RFC 03: Document Exchange | Endpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint. |
| 13197 v2.1 |
| Add Embedded Attachment block | TWG | Added Embedded Attachment block to multiple endpoints to the root level of the request body. Affected payloads: - /api/v2/extendedTypingRequestRequest (TYP_REQ)
- Request body: new root-level attachment object
- /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
- Response body: messages.originalMessage.attachment object
- /api/v2/extendedTypingResponseRequest (TYP_RES)
- Request body: new root-level attachment object
- /api/v2/extendedTypingResponseRetrieve (TYP_RES)
- Response body: messages.originalMessage.attachment object
- /api/v2/sampleRequestRequest (SMP_REQ)
- Request body: new root-level attachment object
- /api/v2/sampleRequestRetrieve (SMP_REQ)
- Response body: messages.originalMessage.attachment object
- /api/v2/sampleResponseRequest (SMP_RES)
- Request body: new root-level attachment object
- /api/v2/sampleResponseRetrieve (SMP_RES)
- Response body: messages.originalMessage.attachment object
- /api/v2/sampleInfoRequest (SMP_INFO)
- Request body: new root-level attachment object
- /api/v2/sampleInfoRetrieve (SMP_INFO)
- Response body: messages.originalMessage.attachment object
- /api/v2/sampleArrivalRequest (SMP_ARR)
- Request body: new root-level attachment object
- /api/v2/sampleArrivalRetrieve (SMP_ARR)
- Response body: messages.originalMessage.attachment object
- /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
- Request body: new root-level attachment object
- /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
- Response body: messages.originalMessage.attachment object
- /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: new root-level attachment object
- /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.attachment object
- /api/v2/reservationReleaseRequest
- Request body: new root-level attachment object
- /api/v2/reservationReleaseRetrieve
- Response body: messages.originalMessage.attachment object
- /api/v2/reservationRequestRequest (RSV_REQ)
- Request body: new root-level attachment object
- /api/v2/reservationRequestRetrieve (RSV_REQ)
- Response body: messages.originalMessage.attachment object
- /api/v2/reservationResponseRequest (RSV_RES)
- Request body: new root-level attachment object
- /api/v2/reservationResponseRetrieve (RSV_RES)
- Response body: messages.originalMessage.attachment object
- /api/v2/requestCancellationRequest (REQ_CAN)
- Request body: new root-level attachment object
- /api/v2/requestCancellationRetrieve (REQ_CAN)
- Response body: messages.originalMessage.attachment object
- /api/v2/requestRejectedRequest (NO_RES)
- Request body: new root-level attachment object
- /api/v2/requestRejectedRetrieve (NO_RES)
- Response body: messages.originalMessage.attachment object
- /api/v2/resultReminderRequest (RES_REM)
- Request body: new root-level attachment object
- /api/v2/resultReminderRetrieve (RES_REM)
- Response body: messages.originalMessage.attachment object
- /api/v2/genericRequestRequest
- Request body: new root-level attachment object
- /api/v2/genericRequestRetrieve
- Response body: messages.originalMessage.attachment object
|
| 12350 v2.1 |
| endpoints: /reservationDonorResponseRequest & Retrieve | TWG | Request rejected (NO_RES) endpoint that is used by the donor side and includes full donor block. |
| 13534 v2.1 |
| endpoints: /cancellationConfirmationRequest & Retrieve | TWG | Endpoint that allows registry to response to requestCancellationRequest (REQ_CAN) and indicate whether or not it can carry out cancellation request. |
| 13174 v2.1 |
| endpoint: /alertRetrieve | TWG | Endpoint to retrieve alert messages. Alert can only be sent by WMDA to SMC network members. |
| 9793 v2.1 |
| endpoint: /alertUpdateRetrieve | TWG | Endpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members. |
| 9794 v2.1 |
| endpoints: /extendedTypingResponseCbuResponseRequest & Retrieve | MC-RFC 02: Cord Blood Endpoints | Endpoints according to source type CBU |
| 13188 v2.2 |
| endpoints: /infectiousDiseaseMarkerResultCbuResponseRequest & Retrieve | MC-RFC 02: Cord Blood Endpoints | Endpoints according to source type CBU |
| 11816 v2.2 |
| endpoints: /reservationResponseCbuResponseRequest & Retrieve | MC-RFC 02: Cord Blood Endpoints | Endpoints according to source type CBU |
| 11726 v2.2 |