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

Available features

This table lists features and changes that are already deployed to the sandbox and production environments. For more details, refer to the sandbox Swagger and the production Swagger.

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 donorWeightKg, donorHeightCm, numberOfTransfusions, numberOfPregnancies fields in the following endpoints:

  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)

2025-07-30

11586

v2.0

Rename address field to institutionPaying

Early adopter

Renamed address field to institutionPaying in the following endpoints:

  • api/v2/extendedTypingRequestRequest (TYP_REQ)
  • api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
2025-08-04

12920

v2.0

Add optional field ccr5

Early adopter

Added optional field ccr5 to the marker object used in the following endpoints:

  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
2025-08-04

12469

v2.0

Add optional field referenceMessageId change

&

Change the patient object to optional

TWG

Added optional field referenceMessageId to the the request object & changed the patient object to optional in the following endpoints:

  • /api/v2/textMessageRequest
  • /api/v2/textMessageRetrieve
2025-08-04

11596

v2.0

Remove requestId field from multiple endpoints

TWG

Removed requestId field in the following endpoints: 

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/sampleInfoRequest (SMP_INFO)
  • /api/v2/sampleInfoRetrieve (SMP_INFO)
  • /api/v2/sampleArrivalRequest (SMP_ARR)
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)
  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)
  • /api/v2/reservationReleaseRequest
  • /api/v2/reservationReleaseRetrieve
  • /api/v2/requestCancellationRequest (REQ_CAN)
  • /api/v2/requestCancellationRetrieve (REQ_CAN)
  • /api/v2/requestRejectedRequest (NO_RES)
  • /api/v2/requestRejectedRetrieve (NO_RES)
  • /api/v2/resultReminderRequest (RES_REM)
  • /api/v2/resultReminderRetrieve (RES_REM)
  • /api/v2/textMessageRequest (TXT_MSG)
  • /api/v2/textMessageRetrieve (TXT_MSG)
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 in the idm object used in the following endpoints:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)

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

2025-08-08

13032

v2.0

Rename donorCcr5Status to ccr5 \

&

Add new fields abo, rhesus, and ccr5


TWG

1. Renamed donorCcr5Status field to ccr5 & added abo and rhesus fields to the response object used in the following endpoints:

  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)

2. Added ccr5 field to the response object in the following endpoints:

  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)
2025-08-08

12353

v2.0

Remove mixedLymphocyteCultureGvh , mixedLymphocyteCultureHvg, gvhReactivityPercent, hvgReactivityPercent, other fields from 4 endpoints

&

Move these fields in the /api/v2/sampleResponse endpoint

Early adopter

1. Removed mixedLymphocyteCultureGvh , mixedLymphocyteCultureHvg, gvhReactivityPercent, hvgReactivityPercent, other fields in the following endpoints:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)

2. Moved mixedLymphocyteCultureGvh , mixedLymphocyteCultureHvg, gvhReactivityPercent, hvgReactivityPercent, other fields to the response.idm  object to a new response.lymphocyteReactivity object in the following endpoints:

  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
2025-08-07

12465

v2.0

Add optional field reservedPatientWmdaId 

TWG

Added optional field reservedPatientWmdaId  to the Donor In Response block used in the following endpoints:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)
2025-08-28

12354

v2.0

Add hla object with optional fields

TWG

Added required object hla with optional fields to the response object in the following endpoints:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
2025-08-29

11587

v2.0

Add value Q as enum valueTWG

Added enum value Q (Questionable) to multiple fields within the idm object:

  • antiCmvStatus, cmvNatStatus, hepatitisBSurfaceAntigenStatus, antiHepatitisBCoreStatus, antiHepatitisBSurfaceAntigenStatus, hepatitisBNatStatus, antiHepatitisCStatus, hepatitisCNatStatus, antiHepatitisEStatus, hepatitisENatStatus, antiHiv12Status, hiv1NatStatus, hivP24Status, antiHtlvStatus, syphilisStatus, westNileVirusNatStatus, chagasNatStatus, antiEbvStatus, antiToxoplasmosisStatus, parvoB19NatStatus

used in the following endpoints

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)
2025-09-09

12464

v2.0

Refine organisation & sampleType objects
TWG

1. Added optional fields phone , fax , email to the organisation object used in the following endpoints

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
  • /api/v2/sampleRequestRequest (SMP_REQ)
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)

2. Renamed ctSampleType field to sampleType in the following endpoints.

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/sampleArrivalRequest (SMP_ARR)
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)
2025-09-16

10835

v2.0

New endpoint: /api/v2/uploadAttachmentMC-RFC 03: Document Exchange

New endpoint to upload a document

2025-10-01

13195

v2.1

New endpoint: /api/v2/downloadAttachmentMC-RFC 03: Document ExchangeNew endpoint to download a document2025-10-01

13289

v2.1

Add serology object with nested field1 and field2 to the hla objectTWG

Added serology object with nested field1 and field2 to the hla object

  • hla.a
  • hla.b
  • hla.c
  • hla.drb1
  • hla.dqb1

used in the following endpoints: 

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve
  • /api/v2/updateRegisteredPatientRequest
  • /api/v2/updateRegisteredPatientRetrieve
2025-10-03

10817

v2.0

Extra logic when confirming reservationTWG

A soft fail is triggered if the donor.Status is not RS (Reserved) when confirming a reservation via/api/v2/reservationResponseRequest (RSV_RES) endpoint.

The API will respond with HTTP 200 OK and include a warning in response:

"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. Made dateOfBirth field required and non-nullable in the Donor in Response block used in the following endpoints: 

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
  • /api/v2/reservationResponseRequest (RSV_RES)
  • /api/v2/reservationResponseRetrieve (RSV_RES)

2. Made organisationId field required in the in the institutionPaying and institutionToSendSampleTo objects used in the following endpoints:

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ) 
  • /api/v2/sampleRequestRequest (SMP_REQ)
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)

3. Added validation to the donorId field in the Donor in Request Donor block: the value must match the selected donorType (adult, adcu, cbu)

  • adult → grid (Length 19)
  • cbu cordId (Length 1-17)
  • adcu adcuId (Length 13)

used in the following endpoints:

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ) 
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/sampleInfoRequest (SMP_INFO)
  • /api/v2/sampleInfoRetrieve (SMP_INFO)
  • /api/v2/sampleArrivalRequest (SMP_ARR)
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)
  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/reservationReleaseRequest
  • /api/v2/reservationReleaseRetrieve
  • /api/v2/requestCancellationRequest (REQ_CAN)
  • /api/v2/requestCancellationRetrieve (REQ_CAN)
  • /api/v2/requestRejectedRequest (NO_RES)
  • /api/v2/requestRejectedRetrieve (NO_RES)
  • /api/v2/resultReminderRequest (RES_REM)
  • /api/v2/resultReminderRetrieve (RES_REM)
  • /api/v2/textMessageRequest (TXT_MSG)
  • /api/v2/textMessageRetrieve (TXT_MSG)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve
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 used in the following endpoints:

  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
2025-10-09

13562

v2.0

Add remark field to the /api/v2/sampleResponse (SMP_RES) endpoint

TWG

Added optional field remark  to the response object in the following endpoints:

  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
2025-10-09

13562

v2.0

Change validation for required loci

&

Updated hla object: required loci must provide either dna or serology


TWG

1. Added validation: for required loci (a ,b, drb1 ), either dna or serology must be provided.

2. Made dna and field1 fields optional for loci a ,b, drb1 in the hla object used in the following endpoints:

  • /api/v2/extendedTypingRequestRequest  (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve 
  • /api/v2/updateRegisteredPatientRequest 
  • /api/v2/updateRegisteredPatientRetrieve 

3. Made all fields in the response.hla object optional in the following endpoints:

  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
2025-11-06

13795

v2.0

 

Patient's dateOfBirth field allows year-onlyData Minimisation project

Updated the regex pattern ("^\\d{4}(-[01]\\d-[0-3]\\d)?$") for the patient's dateOfBirth field to support both full ISO 8601 date (YYYY-MM-DD) and year-only (YYYY) in the following endpoints:

  • /api/v2/extendedTypingRequestRequest  (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve 
  • /api/v2/updateRegisteredPatientRequest 
  • /api/v2/updateRegisteredPatientRetrieve 
2025-12-19

13698

v2.0

Change drb1 to optional in the Donor in Response blockTWG

Made drb1 optional in the hla object of the Donor in Response block used in the following endpoints:

  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
2025-12-22

14412

v2.0

Change maximum value to 99 for pregnanciesCount and transfusionsCount fields

WMDA

The maximum allowed value changed to 99 for pregnanciesCout and transfusionsCount fields of the Donor In Response block used in the following endpoints:

  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
2026-01-15

14174

v2.0

Make field field1 required in the dna and serology objectsWMDA

Made the field1 required in the dna and serology objects of  the hla object used in the following endpoints:

  • /api/v2/extendedTypingRequestRequest  (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResultRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve  (IDM_RES)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve 
  • /api/v2/updateRegisteredPatientRequest 
  • /api/v2/updateRegisteredPatientRetrieve
2026-01-29

14529

v2.0

Adjust validation rules for selected fields

TAG

1. Made the sampleType field optional in the following endpoints:

  • /api/v2/sampleArrivalRequest (SMP_ARR)
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)

2. Made the donorStillOfInterest field required in the following endpoints:

  • /api/v2/sampleResponseRequest (SMP_RES)
  • /api/v2/sampleResponseRetrieve (SMP_RES)

3. Made the diagnosisCode field required in the diagnosis object used in the following endpoints:

  • /api/v2/extendedTypingRequestRequest (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve (TYP_REQ)
  • /api/v2/sampleRequestRequest (SMP_REQ) 
  • /api/v2/sampleRequestRetrieve (SMP_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  •  /api/v2/reservationRequestRetrieve (RSV_REQ) 
  • /api/v2/GenericRequestRequest
  • /api/v2/GenericRequestRetrieve
  • /api/v2/updateRegisteredPatientRequest
  • /api/v2/updateRegisteredPatientRetrieve

4. Made the quantity  and numberOfTubes  fields optional in the prod objects (prod1, prod2, prod3, prod4in the following endpoints:

  • /api/v2/sampleRequestRequest (SMP_REQ)
  • /api/v2/sampleRequestRetrieve (SMP_REQ)

5. Added reservationRequest as enum value to the requestType field in the following endpoints:

  • /api/v2/requestCancellationRequest (REQ_CAN)
  • /api/v2/requestCancellationRetrieve (REQ_CAN)

6. Made the sampleExtractionDate field optional in the following endpoints:

  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)

7. Changed maxLength for the organisationId field to 23 in the following endpoints:

  • /api/v2/extendedTypingRequestRequest  (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)

8. Made the expirationDate field required in the following endpoints:

  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
2026-02-25

13605

v2.0

Upcoming features

This table lists features and changes that will soon be deployed to the sandbox and production environments. The Expected Delivery Date indicates when the change is likely to be available. Once deployed, the feature/change will move to the Available Features table above. For details, see the manually curated Swagger representing the future state of the API.

FeatureRequested byWhat changedExpected Delivery DateWMDA Ticket #

New endpoints

/api/v2/cancellationConfirmationRequest  & /api/v2/cancellationConfirmationRequest 

TAG

Added new endpoint /api/v2/cancellationConfirmation that allows registry to response to /api/v2/requestCancellationRequest (REQ_CAN) and indicate whether or not it can carry out the cancellation request.

2026-03-12

13174

v2.1

New endpoints

/api/v2/requestRejectedDonorRegistryRequest  & /api/v2/requestRejectedDonorRegistryRetrieve 

&

Adjust /api/v2/requestRejected endpoint

TAG

1. Added new endpoint /api/v2/requestRejectedDonorRegistry that includes Donor In Response block and must be used by the donor registry side.

2. Existing /api/v2/requestRejected endpoint to be used by the patient registry side.

Removed the following enum values from the requestType field: genericRequest, extendedTypingRequest, infectiousDiseaseMarkerRequest.

Removed the following enum values from the reason field: DO, DD, MR, PR, TX, MO, UC, NS, OT, UK, EX, MM.

March 2026

13534

v2.1

Rename two endpoints:

/api/v2/textMessage/api/v2/infoMessage

/api/v2/infectiousDiseaseMarkerResult → 

/api/v2/infectiousDiseaseMarkerResponse 

TAG

1. Renamed /api/v2/textMessage endpoint to /api/v2/infoMessage.

2. The infoMessage endpoint contains both text and attachment fields, therefore the text field made optional in:

  • /api/v2/infoMessageRequest
  • /api/v2/infoMessageRetrieve

3. Renamed /api/v2/infectiousDiseaseMarkerResult endpoint to /api/v2/infectiousDiseaseMarkerResponse.

March 2026

15372

v2.1

Add attachment object to multiple endpoints

TAG

Added optional attachment object (Embedded Attachment block) to the root level of the request body in the following endpoints:

  • /api/v2/extendedTypingRequestRequest  (TYP_REQ)
  • /api/v2/extendedTypingRequestRetrieve  (TYP_REQ)
  • /api/v2/extendedTypingResponseRequest  (TYP_RES)
  • /api/v2/extendedTypingResponseRetrieve  (TYP_RES)
  • /api/v2/sampleRequestRequest  (SMP_REQ)
  • /api/v2/sampleRequestRetrieve  (SMP_REQ)
  • /api/v2/sampleInfoRequest (SMP_INFO)
  • /api/v2/sampleInfoRetrieve (SMP_INFO)
  • /api/v2/sampleArrivalRequest (SMP_ARR)
  • /api/v2/sampleArrivalRetrieve (SMP_ARR)
  • /api/v2/sampleResponseRequest  (SMP_RES)
  • /api/v2/sampleResponseRetrieve  (SMP_RES)
  • /api/v2/infectiousDiseaseMarkerRequestRequest  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve  (IDM_REQ)
  • /api/v2/infectiousDiseaseMarkerResponseRequest  (IDM_RES)
  • /api/v2/infectiousDiseaseMarkerResponseRetrieve  (IDM_RES)
  • /api/v2/reservationRequestRequest  (RSV_REQ)
  • /api/v2/reservationRequestRetrieve  (RSV_REQ)
  • /api/v2/reservationResponseRequest  (RSV_RES)
  • /api/v2/reservationResponseRetrieve  (RSV_RES)
  • /api/v2/reservationReleaseRequest
  • /api/v2/reservationReleaseRetrieve
  • /api/v2/requestCancellationRequest (REQ_CAN)
  • /api/v2/requestCancellationRetrieve (REQ_CAN)
  • /api/v2/requestRejectedRequest (NO_RES)
  • /api/v2/requestRejectedRetrieve (NO_RES)
  • /api/v2/resultReminderRequest (RES_REM)
  • /api/v2/resultReminderRetrieve (RES_REM)
  • /api/v2/GenericRequestRequest 
  • /api/v2/GenericRequestRetrieve 
  • /api/v2/infoMessageRequest
  • /api/v2/infoMessageRetrieve
March 2026

12350

v2.1

Match-Connect API v2.1 (MVP)
New endpoint /api/v2/alertRetrieve TAGEndpoint to retrieve alert messages. Alert can only be sent by WMDA to SMC network members.2026

9793

v2.2

New endpoint /api/v2/alertUpdateRetrieve TAGEndpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members.2026

9794

v2.2

Extended Typing Response endpoints to support CBU donor typeMC-RFC 02: Cord Blood Endpoints

extendedTypingResponse endpoint to support CBU donor type.

2026

13188

v2.2

Infectious Disease Marker Response endpoints to support CBU donor typeMC-RFC 02: Cord Blood Endpoints

infectiousDiseaseMarkerResponse endpoint to support CBU donor type.

2026

11816

v2.2

Reservation Response endpoints to support CBU donor typeMC-RFC 02: Cord Blood Endpoints

reservationResponse endpoint to support CBU donor type.

2026

11726

v2.2

New endpoints

/api/v2/cordBloodUnitReportRequestRequest  &

/api/v2/cordBloodUnitReportRequestRetrieve 

MC-RFC 03: Document ExchangeEndpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint.2026

13198

v2.2

New endpoints

/api/v2/cordBloodUnitReportResponseRequest 

& /api/v2/cordBloodUnitReportResponseRetrieve 

MC-RFC 03: Document ExchangeEndpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.2026

13197

v2.2