| Feature | Type of change | Requested by | What changed | Expected Delivery Date | Actual Delivery Date | WMDA ticket |
|---|
| Remove "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" fields | Endpoints affected: | Fields removed | TWG #37 | Removed mismatched fields "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" from IDM_RES endpoints. Affected payloads: - /api/v2/infectiousDiseaseMarkerDonorResultRequestinfectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: response object
- /api/v2/infectiousDiseaseMarkerDonorResultRetrieveinfectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.response object
| 2025-07-31 | 2025-07-30 | 11586 |
Endpoints affected: /api/v2/extendedTypingRequestRequest (TYP_REQ)/api/v2/extendedTypingRequestRetrieve (TYP_REQ)Rename "address" field to "institutionPaying" | Field renamed | Early adopter
#19 | Renamed "address" field to "institutionPaying" in TYP_REQ endpoints. Affected payloads: - /api/v2/extendedTypingRequestRequest (TYP_REQ)
- Request body: request object
- /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
- Response body: messages.originalMessage.request object
| 2025-07-31 | 2025-08-04 | 12920 |
| Add optional field "ccr5" | Field added | Early adopter #26 | Added optional field "ccr5" to IDM_REQ | Endpoints affected: | Field added | Early adopter #26 | Added optional field "ccr5" to IDM_REQ and IDM_RES endpoints. Affected payloads: - /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
- Request body: request.marker object
- /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
- Response body: messages.originalMessage.request.marker object
- /api/v2/infectiousDiseaseMarkerDonorResultRequestinfectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: response.marker object
- /api/v2/infectiousDiseaseMarkerDonorResultRetrieveinfectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.response.marker object
| 2025-07-31 | 2025-08-04 | 12469 |
Endpoints affected: /api/v2/textMessageRequest (TXT_MSG)/api/v2/textMessageRetrieve (TXT_MSG)Change patient object to optional & add optional field "referenceMessageId"
| Field added & Object changed to optional | TWG #39 | Changed patient object to optional. Added optional field "referenceMessageId" to TXT_MSG endpoints. Affected payloads: - /api/v2/textMessageRequest
- Request body: request object
- /api/v2/textMessageRetrieve
- Response body: messages.originalMessage.request object
| 2025-07-31 | 2025-08-04 | 11596 |
| Remove "requestId" field from multiple endpoints | Field removed | TWG #30 | Removed "requestId" field from endpoints where "messageReferenceId" is used for identification. Affected payloads: - /api/v2/extendedTypingResponseRequest
Endpoints affected: - /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
- Request body: response object
- /api/v2/extendedTypingDonorResponseRetrieveextendedTypingResponseRetrieve (TYP_RES)
- Response body: messages.originalMessage.response object
- /api/v2/infectiousDiseaseMarkerDonorResultRequestinfectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: response object
- /api/v2/infectiousDiseaseMarkerDonorResultRetrieveinfectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.response object
- //api/v2/requestCancellationRequest (REQ_CAN)
- Request body: message object
- /api/v2/requestCancellationRetrieve (REQ_CAN)
- Response body: messages.originalMessage.message object
- /api/v2/requestRejectedRequest (NO_RES)
- Request body: message object
- /api/v2/requestRejectedRetrieve (NO_RES)
- Response body: messages.originalMessage.message object
- /api/v2/reservationReleaseRequest
- Request body: request object
- /api/v2/reservationReleaseRetrieve
- Response body: messages.originalMessage.request object
- /api/v2/reservationDonorResponseRequestreservationResponseRequest (RSV_RES)
- Request body: response object
- /api/v2/reservationDonorResponseRetrievereservationResponseRetrieve (RSV_RES)
- Response body: messages.originalMessage.response object
- /api/v2/resultReminderRequest (RES_REM)
- Request body: message object
- /api/v2/resultReminderRetrieve (RES_REM)
- Response body: messages.originalMessage.message object
- /api/v2/sampleArrivalRequest (SMP_ARR)
- Request body: message object
- /api/v2/sampleArrivalRetrieve (SMP_ARR)
- Response body: messages.originalMessage.message object
- /api/v2/sampleInfoRequest (SMP_INFO)
- Request body: message object
- /api/v2/sampleInfoRetrieve (SMP_INFO)
- Response body: messages.originalMessage.message object
- /api//api/v2/sampleResponseRequest (SMP_RES)
- Request body: response object
- /api/v2/sampleResponseRetrieve (SMP_RES)
- Response body: messages.originalMessage.response object
- /api/v2/textMessageRequest (TXT_MSG)
- Request body: request object
- /api/v2/textMessageRetrieve (TXT_MSG)
| Field removed | TWG #30 | - Response body: messages.originalMessage.request object
| 2025-08-07 | 2025-08-06 | 11555 |
| Add new enum values "G", "M", "B", "H", "O" | Enum values added | Early adopter #24 | Added new enum values "G", "M", "B", "H", "O" to "antiToxoplasmosisStatus" and "antiEbvStatus" fields in TYP_RES, IDM_RES, RSV_RES, SMP_RES endpoints. G = IgG positive, IgM negative;
M = IgG negative, IgM positive;
B = Both IgG and IgM positive;
H = IgG positive, IgM not tested;
O = IgG negative, IgM not tested. Affected payloads: Removed "requestId" field from endpoints where "messageReferenceId" is used for identification. Affected payloads: /api/v2/extendedTypingDonorResponseRequest (TYP_RES)- Request body: response object
/api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)- Response body: messages.originalMessage.response object
/api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)- Request body: response object
/api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)- Response body: messages.originalMessage.response object
/api/v2/requestCancellationRequest (REQ_CAN)Request body: message object- /api/v2/requestCancellationRetrieveextendedTypingResponseRequest (REQTYP_CANRES)
- Response Request body: messages.originalMessage.message object donor.idm object
- /api/v2/requestRejectedRequestextendedTypingResponseRetrieve (NOTYP_RES)
- Request Response body: message messages.originalMessage.donor.idm object
- /api/v2/requestRejectedRetrieveinfectiousDiseaseMarkerResultRequest (NOIDM_RES)
- Response Request body: messagesresponse.originalMessage.message objectidm & donor.idm objects
- /api/v2/reservationReleaseRequest
- Request body: request object
infectiousDiseaseMarkerResultRetrieve (IDM_RES)/api/v2/reservationReleaseRetrieve- Response body: messages.originalMessage.response.idm & messages.originalMessage.request objectdonor.idm objects
- /api/v2/reservationDonorResponseRequestreservationResponseRequest (RSV_RES)
- Request body: response donor.idm object
- /api/v2/reservationDonorResponseRetrievereservationResponseRetrieve (RSV_RES)
- Response body: messages.originalMessage.response objectdonor.idm object
- /api/v2/resultReminderRequestsampleResponseRequest (SMP_RES_REM)
- Request body: message object response.idm object
- /api/v2/resultReminderRetrievesampleResponseRetrieve (SMP_RES_REM)
- Response body: messages.originalMessage.responce.message object
- /api/v2/sampleArrivalRequest (SMP_ARR)
- Request body: message object
- /api/v2/sampleArrivalRetrieve (SMP_ARR)
- Response body: messages.originalMessage.message object
- /api/v2/sampleInfoRequest (SMP_INFO)
- Request body: message object
- /api/v2/sampleInfoRetrieve (SMP_INFO)
- Response body: messages.originalMessage.message object
- /api/v2/sampleResponseRequest (SMP_RES)
- Request body: response object
- /api/v2/sampleResponseRetrieve (SMP_RES)
- Response body: messages.originalMessage.response object
- /api/v2/textMessageRequest (TXT_MSG)
- Request body: request object
- /api/v2/textMessageRetrieve (TXT_MSG)
- Response body: messages.originalMessage.request object
| 2025-08-07 | 2025-08-06 | 11555 |
Endpoints affected: | Enum values added | Early adopter #24 | Added new enum values "G", "M", "B", "H", "O" to "antiToxoplasmosisStatus" and "antiEbvStatus" fields in TYP_RES, IDM_RES, RSV_RES, SMP_RES endpoints. G = IgG positive, IgM negative;
M = IgG negative, IgM positive;
B = Both IgG and IgM positive;
H = IgG positive, IgM not tested;
O = IgG negative, IgM not tested. Affected payloads: | 2025-08-14 | 2025-08-08 | 13032 |
Endpoints affected: | Fields added | TWG #40 | Renamed "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields to IDM_RES endpoints. Added "ccr5" field to SMP_RES endpoints. Affected payloads: | 2025-08-14 | 2025-08-08 | 12353 |
| 2025-08-14 | 2025-08-08 | 13032 |
| Rename "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields | Fields added | TWG #40 | Renamed "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields to IDM_RES endpoints. Added "ccr5" field to SMP_RES endpoints. Affected payloads: - /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: response object
- /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.response object
Endpoints affected: | 2025-08-14 | 2025-08-08 | 12353 |
| Remove | Fields removed & Fields moved to a different object in SMP_RES | Early adopter #25 | Removed "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other" ("other" field present in the marker object only) fields from TYP_RES, IDM_REQ, IDM_RES, RSVfields & move these fields within SMP_RES endpoints . Affected payloads: | Fields removed & Fields moved to a different object in SMP_RES | Early adopter #25 | Removed "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other" ("other" field present in the marker object only) fields from TYP_RES, IDM_REQ, IDM_RES, RSV_RES endpoints. Affected payloads: /api/v2/extendedTypingDonorResponseRequest (TYP_RES)- Request body: donor.idm object
/api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)- Response body: messages.originalMessage.donor.idm object
/api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)- Request body: request.marker object
/api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)- Response body: messages.originalMessage.request.marker object
/api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)- Request body: response.marker, response.idm & donor.idm objects
/api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)Response body: messages.originalMessage.response.marker, messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects- /api/v2/reservationDonorResponseRequestextendedTypingResponseRequest (RSVTYP_RES)
- Request body: donor.idm object
- /api/v2/reservationDonorResponseRetrieveextendedTypingResponseRetrieve (RSVTYP_RES)
- Response body: messages.originalMessage.donor.idm object
Moved "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent" fields from response.idm to response.lymphocyteReactivity object in SMP_RES endpoints. Affected payloads:Endpoints affected: - /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
- Request body: request.marker object
- /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
- Response body: messages.originalMessage.request.marker object
- /api/v2/sampleResponseRequestinfectiousDiseaseMarkerResultRequest (SMPIDM_RES)
- Request body: response.idm → response.lymphocyteReactivity object marker, response.idm & donor.idm objects
- /api/v2/sampleResponseRetrieveinfectiousDiseaseMarkerResultRetrieve (SMPIDM_RES)
- Response body: messages.originalMessage.response.idm → marker,messages.originalMessage.response.lymphocyteReactivity object
| 2025-08-14 | 2025-08-07 | 12465 | - .idm & messages.originalMessage.donor.idm objects
- /api/v2/extendedTypingDonorResponseRequestreservationResponseRequest (TYPRSV_RES)
- Request body: donor.idm object
- /api/v2/extendedTypingDonorResponseRetrievereservationResponseRetrieve (TYPRSV_RES)
| Object added | TWG #41 | - Response body: messages.originalMessage.donor.idm object
Moved "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent" fields from response.idm to response.lymphocyteReactivity object in SMPAdded HLA object without required values to response object in TYP_RES endpoints. Affected payloads: - /api/v2/extendedTypingDonorResponseRequestsampleResponseRequest (TYPSMP_RES)
- Request body: response.idm → objectresponse.hlalymphocyteReactivity object
- /api/v2/extendedTypingDonorResponseRetrievesampleResponseRetrieve (TYPSMP_RES)
- Response body: messages.originalMessage.response.idm → messages.originalMessage.response.hlalymphocyteReactivity object
| 2025-08-28-14 | 2025-08-07 | 12465 |
Add HLA object with optional fields
| Object added | TWG #41 | Added HLA object with optional fields to response object in TYP_RES endpoints. Affected payloads: | 11587 | Endpoints affected: /api/v2/extendedTypingDonorResponseRequest (TYP_RES)/api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)/api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)- /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)/api/v2/reservationDonorResponseRequest (RSVextendedTypingResponseRequest (TYP_RES)
- Request body: response → response.hla object
- /api/v2/reservationDonorResponseRetrieveextendedTypingResponseRetrieve (RSVTYP_RES)
- Response body: messages.originalMessage.response → messages.originalMessage.response.hla object
| 2025-08-28 |
| 11587 |
Add "reservedPatientWmdaId" as optional field | Field added | TWG #42 | Added "reservedPatientWmdaId" as optional field to the donor in response block in TYP_RES, IDM_RES, RSV_RES endpoints. Affected payloads: - /api/v2/extendedTypingDonorResponseRequestextendedTypingResponseRequest (TYP_RES)
- Request body: donor object
- /api/v2/extendedTypingDonorResponseRetrieveextendedTypingResponseRetrieve (TYP_RES)
- Response body: messages.originalMessage.donor object
- /api/v2/infectiousDiseaseMarkerDonorResultRequestinfectiousDiseaseMarkerResultRequest (IDM_RES)
- Request body: donor object
- /api/v2/infectiousDiseaseMarkerDonorResultRetrieveinfectiousDiseaseMarkerResultRetrieve (IDM_RES)
- Response body: messages.originalMessage.donor object
- /api/v2/reservationDonorResponseRequest (RSV_RES)
- Request body: donor object
- /api/v2/reservationDonorResponseRetrievereservationResponseRetrieve (RSV_RES)
- Response body: messages.originalMessage.donor object
| 2025-08-28 |
| 12354 |