Page History

Endpoints affected:

• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)

TWG

#37

Removed mismatched fields "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" from IDM_RES endpoints.

Affected payloads:

• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
  
  • Request body: response object
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
  
  • Response body: messages.originalMessage.response object

2025-07-31

Endpoints affected:

• /api/v2/extendedTypingRequestRequest (TYP_REQ)
• /api/v2/extendedTypingRequestRetrieve (TYP_REQ)

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

Endpoints affected:

• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)

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/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
  
  • Request body: response.marker object
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
  
  • Response body: messages.originalMessage.response.marker object

2025-07-31

Endpoints affected:

• /api/v2/textMessageRequest (TXT_MSG)
• /api/v2/textMessageRetrieve (TXT_MSG)

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

Endpoints affected:

• /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
• /api/v2/requestCancellationRequest (REQ_CAN)
• /api/v2/requestCancellationRetrieve (REQ_CAN)
• /api/v2/requestRejectedRequest (NO_RES)
• /api/v2/requestRejectedRetrieve (NO_RES)
• /api/v2/reservationReleaseRequest
• /api/v2/reservationReleaseRetrieve
• /api/v2/reservationDonorResponseRequest (RSV_RES)
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)
• /api/v2/resultReminderRequest (RES_REM)
• /api/v2/resultReminderRetrieve (RES_REM)
• /api/v2/sampleArrivalRequest (SMP_ARR)
• /api/v2/sampleArrivalRetrieve (SMP_ARR)
• /api/v2/sampleInfoRequest (SMP_INFO)
• /api/v2/sampleInfoRetrieve (SMP_INFO)
• /api/v2/sampleResponseRequest (SMP_RES)
• /api/v2/sampleResponseRetrieve (SMP_RES)
• /api/v2/textMessageRequest (TXT_MSG)
• /api/v2/textMessageRetrieve (TXT_MSG)

Field removed

TWG

#30

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/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/reservationDonorResponseRequest (RSV_RES)
  • Request body: response object
• /api/v2/reservationDonorResponseRetrieve (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/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

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 (RSV_RES)
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)
• /api/v2/sampleResponseRequest (SMP_RES)
• /api/v2/sampleResponseRetrieve (SMP_RES)

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:

• /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
  • Request body: donor.idm object
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
  • Request body: response.idm & donor.idm objects
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects
• /api/v2/reservationDonorResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor.idm object
• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.responce.idm object

Endpoints affected:

• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
• /api/v2/sampleResponseRequest (SMP_RES)
• /api/v2/sampleResponseRetrieve (SMP_RES)

Fields added

TWG

#41#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/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
  • Request body: response object
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.response object
• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response object

Endpoints affected:

• /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)
• /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
• /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
• /api/v2/reservationDonorResponseRequest (RSV_RES)
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)
• /api/v2/sampleResponseRequest (SMP_RES)
• /api/v2/sampleResponseRetrieve (SMP_RES)

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/reservationDonorResponseRequest (RSV_RES)
  • Request body: donor.idm object
• /api/v2/reservationDonorResponseRetrieve (RSV_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:

• /api/v2/sampleResponseRequest (SMP_RES)
  • Request body: response.idm → response.lymphocyteReactivity object
• /api/v2/sampleResponseRetrieve (SMP_RES)
  • Response body: messages.originalMessage.response.idm → messages.originalMessage.response.lymphocyteReactivity object

Endpoints affected:

• /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)

Object added

TWG

#41

Added HLA object without required values to response object in TYP_RES endpoints.

Affected payloads:

• /api/v2/extendedTypingDonorResponseRequest (TYP_RES)
  • Request body: response → response.hla object
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.response → messages.originalMessage.response.hla object

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 (RSV_RES)
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)

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/extendedTypingDonorResponseRequest (TYP_RES)
  • Request body: donor object
• /api/v2/extendedTypingDonorResponseRetrieve (TYP_RES)
  • Response body: messages.originalMessage.donor object
• /api/v2/infectiousDiseaseMarkerDonorResultRequest (IDM_RES)
  • Request body: donor object
• /api/v2/infectiousDiseaseMarkerDonorResultRetrieve (IDM_RES)
  • Response body: messages.originalMessage.donor object
• /api/v2/reservationDonorResponseRequest (RSV_RES)
  • Request body: donor object
• /api/v2/reservationDonorResponseRetrieve (RSV_RES)
  • Response body: messages.originalMessage.donor object