Page History

Endpoints affected:

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

TWG

#37

Removed mismatched fields from the response object in IDM_RES endpoints.
4 fields removed:

• donorWeightKg
• donorHeightCm
• numberOfTransfusions
• numberOfPregnancies

2025-07-31

Endpoints affected:

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

Early adopter

#19

Field renamed to be more informative and consistent. 

"address" renamed to "institutionPaying" within the request object in TYP_REQ endpoints.

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 missing optional "ccr5" field to the marker object in IDM_REQ and IDM_RES endpoints.

Added "ccr5" field to the marker object in the following request and response bodies:

• IDM_REQ endpoints:
  • infectiousDiseaseMarkerRequestRequest
    
    • Request body: request.marker
  • infectiousDiseaseMarkerRequestRetrieve
    • Response body: messages.originalMessage.request.marker
• IDM_RES endpoints:
  • infectiousDiseaseMarkerDonorResultRequest
    • Request body: response.marker
  • infectiousDiseaseMarkerDonorResultRetrieve
  • Response body: messages.originalMessage.response.marker

2025-07-31

Endpoints affected:

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

Field added

&

Object changed to optional

TWG

#39

Added optional field "referenceMessageId" to the request object in TXT_MSG endpoints.

And changed "patient" object to optional.

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 (REM_RES)
• /api/v2/resultReminderRetrieve (REM_RES)
• /api/v2/sampleArrivalRequest (SMP_ARR)
• /api/v2/sampleArrivalRetrieve (SMP_ARR)
• /api/v2/sampleInfoRequest (SMP_RES)
• /api/v2/sampleInfoRetrieve (SMP_RES)
• /api/v2/sampleResponseRequest (SMP_RES)
• /api/v2/sampleResponseRetrieve (SMP_RES)
• /api/v2/textMessageRequest (TXT_MSG)
• /api/v2/textMessageRetrieve (TXT_MSG)

Field removed

TWG

#30

Unnecessary "requestId" field removed from the endpoints affected because "messageReferenceId" is used for identification.

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 enum values G, M, B, H, O to "antiToxoplasmosisStatus" and "antiEbvStatus" fields in both response.idm and donor.idm objects.

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.

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

Added "abo" and " rhesus" fields to the response object in IDM_RES endpoints. And renamed "donorCcr5Status" to "ccr5".

Added "ccr5" field to the response object in SMP_RES endpoints.

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

Early adopter

#25

Fields removed from idm and marker objects:

• mixedLymphocyteCultureGvh
• mixedLymphocyteCultureHvg
• gvhReactivityPercent
• hvgReactivityPercent
• other (present in the marker object only)

Endpoints with idm and marker objects:

• TYP_RES - donor.idm object
• IDM_REQ - request.marker object
• IDM_RES - response.marker, response.idm, donor.idm objects
• RSV_RES - donor.idm object

Within sampleResponse (SMP_RES) endpoints 4 fields (mixedLymphocyteCultureGvh, mixedLymphocyteCultureHvg, gvhReactivityPercent
hvgReactivityPercent) are moved from response.idm object to response object.