Below you can find a list of features that are currently available and upcoming for the Match-Connect API

Available features

FeatureRequested byWhat changedDelivery dateWMDA Ticket #

Initial setup

MVP
2023-09-156720
Endpoint: /sampleRequestRequestMVP
2023-09-226692
Endpoint: /sampleRequestRetrieveMVP
2023-09-276744

Endpoint: /availableMessages

MVP
2023-10-316746
Endpoint: /extendedTypingRequestRequestMVP
2023-11-216683

add sequence numbers

TWG
2023-11-227390
Endpoint: /extendedTypingRequestRetrieveMVP
2023-12-116684
Endpoint: /reservationResponseRequestMVP
2024-01-157654
HLA validationMVP
2024-01-257098
Endpoint: /reservationResponseRetrieveMVP
2024-02-207652
Endpoint: /messageResponseRequestMVP
2024-02-278167
Optimise message content validation by using JSON schemas for all endpointsWMDA
2024-03-128215
Unify wmdaResponse and metaInformation block following early adopter feedback

Early adopter


2024-03-14

8284
Adapt donor block following early adopter feedbackEarly adopter
2024-03-158283 & 8286
endpoint: /messageResponseRetrieveMVP
2024-03-208175
endpoint: /requestCancellationRequestMVP
2024-03-278052
endpoint: /requestCancellationRetrieveMVP
2024-03-298053
endpoint: /requestRejectedRequestMVP
2024-04-058194
endpoint: /requestRejectedRetrieveMVP
2024-04-058195
endpoint: /extendedTypingResponseRequestMVP
2024-04-188216
endpoint: /extendedTypingResponseRetrieveMVP
2024-04-198217
endpoint: /sampleArrivalRequestMVP
2024-04-298820
endpoint: /sampleArrivalRetrieveMVP
2024-04-298821
endpoint: /infectiousDiseaseMarkerResultRequestMVP
2024-05-218822
endpoint: /infectiousDiseaseMarkerResultRetrieveMVP
2024-05-218823
Fix example automated Swagger messageResponseRetrieveEarly adopter
2024-05-219117
Fix enums "reason" field requestRejected messagesEarly adopter
2024-05-219118
endpoint: /sampleInfoRequest 
MVP
2024-05-298824
endpoint: /sampleInfoRetrieve 
MVP
2024-05-298825
endpoint: /sampleResponseRequestMVP
2024-06-128826
endpoint: /sampleResponseRetrieveMVP
2024-06-128827
Add "emdisPatientId" to patient block + validation of "patientId" field to make sure it starts with 4 digitsEarly adopters, WMDA
2024-06-199229
endpoint: /infectiousDiseaseMarkerRequestMVP
2024-07-089087
endpoint: /infectiousDiseaseMarkerRequestRetrieveMVP
2024-07-089088
endpoint: /reservationRequestRequestMVP
2024-07-129089
endpoint: /reservationRequestRetrieveMVP
2024-07-129090
endpoint: /reservationReleaseRequestMVP
2024-07-249091
endpoint: /reservationReleaseRetrieveMVP
2024-07-249092
endpoint: /recoverMessagesMVP
2024-08-029788
endpoint: /genericRequestRequestMVP
2024-08-019789
endpoint: /genericRequestRetrieveMVP
2024-08-019790
endpoint: /resultReminderRequestMVP
2024-08-149791
endpoint: /resultReminderRequestRetrieveMVP
2024-08-149792
Update ENUMs for "requestType" field (requestCancellation + requestRejected endpoints)BugWMDA: original specs contain incorrect values
Description:
The ENUMs for the "requestType" field (requestCancellation + requestRejected endpoints) were defined incorrectly in the initial version of the semantics.  We want to correct this error by implementing the correct ENUMs.
Previous specs: requestType, string, maxLength: 3, Enum: [ ALM, BLS, CBR, IDM, RSV, TYP, WOR ] 
Correct specs: requestType, string, Enum: [ genericRequest, extendedTypingRequest, sampleRequest, infectiousDiseaseMarkerRequest ]		2024-08-2310010
endpoint: /updateRegisteredPatientRequestMVP
2024-09-049797
endpoint: /updateRegisteredPatientRetrieveMVP
2024-09-049798
endpoint: /pingRequestMVP
2024-09-119795
endpoint: /pingRetrieveMVP
2024-09-119796
endpoint: /textMessageRequest MVP
2024-09-2410001
endpoint: /textMessageRetrieveMVP
2024-09-2410001
Add "OT" as enum to ethnicityBugWMDA: missing in original specs2024-09-2710532
Remove "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" fields

TWG

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

Affected payloads:

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

2025-07-30

11586

v2.0

Rename "address" field to "institutionPaying"

Early adopter

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-08-04

12920

v2.0

Add optional field "ccr5"

Early adopter

Added optional field "ccr5" to marker object in 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/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: response.marker object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.response.marker object
2025-08-04

12469

v2.0

Change patient object to optional & add optional field "referenceMessageId"

TWG

Changed patient object to optional in TXT_MSG endpoints.

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

Affected payloads:

  • /api/v2/textMessageRequest
    • Request body: request object
  • /api/v2/textMessageRetrieve
    • Response body: messages.originalMessage.request object
2025-08-04

11596

v2.0

Remove "requestId" field from multiple endpoints

TWG

Removed "requestId" field from endpoints where "messageReferenceId" is used for identification.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: response object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.response object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: response object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (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/reservationResponseRequest (RSV_RES)
    • Request body: response object
  • /api/v2/reservationResponseRetrieve (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
2025-08-06

11555

v2.0

Add enum values "G", "M", "B", "H", "O"

Early adopter

Added enum values "G", "M", "B", "H", "O" to "antiToxoplasmosisStatus" and "antiEbvStatus" fields within idm object 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/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.idm object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.idm object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: response.idm & donor.idm objects
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.idm object
  • /api/v2/reservationResponseRetrieve (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
2025-08-08

13032

v2.0

Rename "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields

TWG

Renamed "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields to response object in IDM_RES endpoints.

Affected payloads:

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

&

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

Affected payloads:

  • /api/v2/sampleResponseRequest (SMP_RES)
    • Request body: response object
  • /api/v2/sampleResponseRetrieve (SMP_RES)
    • Response body: messages.originalMessage.response object
2025-08-08

12353

v2.0

Remove "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other" fields & move these fields within SMP_RES endpoints 

Early adopter

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/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.idm object
  • /api/v2/extendedTypingResponseRetrieve (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/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: response.marker, response.idm & donor.idm objects
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.response.marker, messages.originalMessage.response.idm & messages.originalMessage.donor.idm objects
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.idm object
  • /api/v2/reservationResponseRetrieve (RSV_RES)
    • Response body: messages.originalMessage.donor.idm object

&

Moved "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent" fields from response.idm to a new object response.lymphocyteReactivity 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
2025-08-07

12465

v2.0

Add optional field reservedPatientWmdaId 

TWG

Added optional field reservedPatientWmdaId  to the Donor In Response block in TYP_RES, IDM_RES, RSV_RES endpoints.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: donor object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.donor object
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor object
  • /api/v2/reservationResponseRetrieve (RSV_RES)
    • Response body: messages.originalMessage.donor object
2025-08-28

12354

v2.0

Add hla object with optional fields

TWG

Added required object hla with optional fields to response object in TYP_RES endpoints.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: response → response.hla object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.response → messages.originalMessage.response.hla object
2025-08-29

11587

v2.0

Add value 'Q' as enumTWG

Added enum value "Q" (Questionable) to the fields (antiCmvStatus, cmvNatStatus, hepatitisBSurfaceAntigenStatus, antiHepatitisBCoreStatus, antiHepatitisBSurfaceAntigenStatus, hepatitisBNatStatus, antiHepatitisCStatus, hepatitisCNatStatus, antiHepatitisEStatus, hepatitisENatStatus, antiHiv12Status, hiv1NatStatus, hivP24Status, antiHtlvStatus, syphilisStatus, westNileVirusNatStatus, chagasNatStatus, antiEbvStatus, antiToxoplasmosisStatus, parvoB19NatStatus) within idm object in TYP_RES, IDM_RES, RSV_RES, SMP_RES endpoints 

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.idm object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.idm object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: donor.idm & response.idm objects
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.donor.idm & messages.originalMessage.response.idm objects
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.idm object
  • /api/v2/reservationResponseRetrieve (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.response & messages.originalMessage.response.idm objects
2025-09-09

12464

v2.0

Refine organisation & sampleType
TWG

Added optional fields "phone", "fax", "email" to organisation object in TYP_RES, IDM_REQ, SMP_REQ endpoints.

Affected payloads:

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
    • Request body: request.institutionPaying.organisation object
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ) 
    • Response body: messages.originalMessage.request.institutionPaying.organisation object
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
    • Request body: request.institutionPaying.organisation object
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
    • Response body: messages.originalMessage.request.institutionPaying.organisation object
  • /api/v2/sampleRequestRequest (SMP_REQ)
    • Request body: request.institutionPaying.organisation object
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
    • Response body: messages.originalMessage.request.institutionPaying.organisation object

&

Renamed "ctSampleType" field to "sampleType" in TYP_REQ, SMP_ARR endpoints.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: response object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.response object
  • /api/v2/sampleArrivalRequest (SMP_ARR)
    • Request body: message object
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)
    • Response body: messages.originalMessage.message object
2025-09-16

10835

v2.0

endpoint: /upload AttachmentMC-RFC 03: Document ExchangeEndpoint to upload a file to blob storage.

2025-10-01

13195

v2.1

endpoint: /download AttachmentMC-RFC 03: Document ExchangeEndpoint to download a file from blob storage.2025-10-01

13289

v2.1

Add Serology object with two fields to hla.a, hla.b, hla.c, hla.drb1, hla.dqb1TWG

Added optional serology object with two fields to hla.a, hla.b, hla.c, hla.drb1, hla.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 objects
  • /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-10-03

10817

v2.0

Add extra logic when confirming reservationTWG

Soft fail is triggered when confirming Reservation Response (RSV_RES) endpoint without reserving the donor.

If "response.confirmed" is TRUE 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-07

13535

v2.0

Add extra validation for selected fieldsWMDA

Added following validations:

  1. "donor.dateOfBirth" field is required and nullable: false. Used in TYP_RES, IDM_RES, RSV_RES endpoints
  2. "hlaNomenclatureVersion" field has maxLenght: 5. Used in TYP_RES, SMP_RES endpoints
  3. "organisationId" is required, has minLength: 5, maxLength: 19, and the pattern: ^\\d{4}\\w{1,19}$. Used in institutionPaying object in TYP_REQ. IDM_REQ, SMP_REQ. Also in institutionToSendSampleTo object in SMP_REQ endpoint.
  4. "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-09

13617

v2.0

Add "antiChagas" field to the marker and idm objectsTWG

Added new optional field "antiChagasStatus" 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 .

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/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: response.marker, response.idm & donor.idm objects
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.response.marker, messages.originalMessage.response.idm  &  messages.originalMessage.donor.idm objects
  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.idm object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.idm object
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.idm object
  • /api/v2/reservationResponseRetrieve (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.response.idm object
2025-10-09

13562

v2.0

Add "remark" field 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-09

13562

v2.0

Change hla object. Required loci must have either DNA or Serology

TWG

Changed "dna" and "field1" to optional for loci A, B, DRB1 in hla object. Present in Embedded Adult Donor Block (TYP_RES, IDM_RES, RSV_RES) & Embedded Patient Block (TYP_REQ, Generic Request, IDM_REQ, RSV_REQ, SMP_REQ, Update Registered Patient). 

For required loci (A, B, DRB1) either DNA or Serology must be provided.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.hla object
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.hla object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: donor.hla object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.donor.hla object
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.hla object
  • /api/v2/reservationResponseRetrieve (RSV_RES)
    • Response body: messages.originalMessage.donor.hla object
  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
    • Request body: patient.hla object
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
    • Response body: messages.originalMessage.patient.hla object
  • /api/v2/GenericRequestRequest
    • Request body: patient.hla object
  • /api/v2/GenericRequestRetrieve
    • Response body: messages.originalMessage.patient.hla object
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
    • Request body: patient.hla object
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
    • Response body: messages.originalMessage.patient.hla object
  • /api/v2/reservationRequestRequest (RSV_REQ)
    • Request body: patient.hla object
  • /api/v2/reservationRequestRetrieve (RSV_REQ)
    • Response body: messages.originalMessage.patient.hla object
  • /api/v2/sampleRequestRequest (SMP_REQ)
    • Request body: patient.hla object
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
    • Response body: messages.originalMessage.patient.hla object
  • /api/v2/updateRegisteredPatientRequest
    • Request body: patient.hla object
  • /api/v2/updateRegisteredPatientRetrieve
    • Response body: messages.originalMessage.patient.hla object


 All fields in hla object changed to optional in SMP_RES endpoint.

 Affected payloads:

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

 

2025-11-06

13795

v2.0

 

Upcoming features

FeatureRequested byWhat changedExpected Delivery DateWMDA Ticket #
Patient's dateOfBirth field allows year-onlyTWG

Updated the regex pattern for the patient's dateOfBirth field to support both full ISO 8601 date (YYYY-MM-DD) and year-only (YYYY).

  Affected payloads:

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
    • Request body: patient.dateOfBirth field
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
    • Response body: messages.originalMessage.patient.dateOfBirth field
  • /api/v2/GenericRequestRequest
    • Request body: patient.dateOfBirth field
  • /api/v2/GenericRequestRetrieve
    • Response body: messages.originalMessage.patient.dateOfBirth field
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
    • Request body: patient.dateOfBirth field
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
    • Response body: messages.originalMessage.patient.dateOfBirth field
  • /api/v2/reservationRequestRequest (RSV_REQ)
    • Request body: patient.dateOfBirth field
  • /api/v2/reservationRequestRetrieve (RSV_REQ)
    • Response body: messages.originalMessage.patient.dateOfBirth field
  • /api/v2/sampleRequestRequest (SMP_REQ)
    • Request body: patient.dateOfBirth field
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
    • Response body: messages.originalMessage.patient.dateOfBirth field
  • /api/v2/updateRegisteredPatientRequest
    • Request body: patient.dateOfBirth field
  • /api/v2/updateRegisteredPatientRetrieve
    • Response body: messages.originalMessage.patient.dateOfBirth field
2025-12-18

13698

v2.0

Optional drb1 in the Donor in Response blockTWG

Made drb1 optional in the HLA object for the Donor in Response block.

Affected payloads:

  • api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.hla.drb1 field
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.hla.drb1 object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: donor.hla.drb1 object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.donor.hla.drb1 object
  • /api/v2/reservationResponseRequest (RSV_RES)
    • Request body: donor.hla.drb1 object
  • /api/v2/reservationResponseRetrieve (RSV_RES)
    • Response body: messages.originalMessage.donor.hla.drb1 object
2025-12-18

14412

v2.0

Rename textMessage endpoint.

Add Embedded Attachment block to multiple endpoints

TWG

/api/v2/textMessage endpoint renamed to /api/v2/infoMessage.

Added optional Embedded Attachment block (attachment object) to the root-level of the request body for endpoints: TYP_REQ, TYP_RES, SMP_REQ, SMP_RES, SMP_INFO, SMP_ARR, IDM_REQ, IDM_RES, reservationReleaseRequest, RSV_REQ, RSV_RES, REQ_CAN, NO_RES, RES_REM, genericRequestRequest, genericRequestRequest, infoMessage.

December 2025

12350

v2.1

endpoints: /requestRejectedDonorRegistryRequest & RetrieveTWGRequest rejected (NO_RES) endpoint that is used by the donor side and includes full donor block.Q1 2026

13534

v2.1

endpoints: /cancellationConfirmationRequest & RetrieveTWG

Endpoint that allows registry to response to requestCancellationRequest (REQ_CAN) and indicate whether or not it can carry out cancellation request.

Q1 2026

13174

v2.1

endpoint: /alertRetrieveTWGEndpoint to retrieve alert messages. Alert can only be sent by WMDA to SMC network members.Q1 2026

9793

v2.1

endpoint: /alertUpdateRetrieveTWGEndpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members.Q1 2026

9794

v2.1

endpoints: /cordBloodUnitReportRequestRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint.Q1 2026

13198

v2.2

endpoints: /cordBloodUnitReportResponseRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.Q1 2026

13197

v2.2

endpoints: /extendedTypingResponseCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU.Q1 2026

13188

v2.2

endpoints: /infectiousDiseaseMarkerResultCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU.Q1 2026

11816

v2.2

endpoints: /reservationResponseCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU.Q1 2026

11726

v2.2