Feature	Requested by	What changed	Delivery date	WMDA Ticket #
Initial setup	MVP		2023-09-15	6720
Endpoint: /sampleRequestRequest	MVP		2023-09-22	6692
Endpoint: /sampleRequestRetrieve	MVP		2023-09-27	6744
Endpoint: /availableMessages	MVP		2023-10-31	6746
Endpoint: /extendedTypingRequestRequest	MVP		2023-11-21	6683
add sequence numbers	TWG		2023-11-22	7390
Endpoint: /extendedTypingRequestRetrieve	MVP		2023-12-11	6684
Endpoint: /reservationResponseRequest	MVP		2024-01-15	7654
HLA validation	MVP		2024-01-25	7098
Endpoint: /reservationResponseRetrieve	MVP		2024-02-20	7652
Endpoint: /messageResponseRequest	MVP		2024-02-27	8167
Optimise message content validation by using JSON schemas for all endpoints	WMDA		2024-03-12	8215
Unify wmdaResponse and metaInformation block following early adopter feedback	Early adopter		2024-03-14	8284
Adapt donor block following early adopter feedback	Early adopter		2024-03-15	8283 & 8286
endpoint: /messageResponseRetrieve	MVP		2024-03-20	8175
endpoint: /requestCancellationRequest	MVP		2024-03-27	8052
endpoint: /requestCancellationRetrieve	MVP		2024-03-29	8053
endpoint: /requestRejectedRequest	MVP		2024-04-05	8194
endpoint: /requestRejectedRetrieve	MVP		2024-04-05	8195
endpoint: /extendedTypingResponseRequest	MVP		2024-04-18	8216
endpoint: /extendedTypingResponseRetrieve	MVP		2024-04-19	8217
endpoint: /sampleArrivalRequest	MVP		2024-04-29	8820
endpoint: /sampleArrivalRetrieve	MVP		2024-04-29	8821
endpoint: /infectiousDiseaseMarkerResultRequest	MVP		2024-05-21	8822
endpoint: /infectiousDiseaseMarkerResultRetrieve	MVP		2024-05-21	8823
Fix example automated Swagger messageResponseRetrieve	Early adopter		2024-05-21	9117
Fix enums "reason" field requestRejected messages	Early adopter		2024-05-21	9118
endpoint: /sampleInfoRequest	MVP		2024-05-29	8824
endpoint: /sampleInfoRetrieve	MVP		2024-05-29	8825
endpoint: /sampleResponseRequest	MVP		2024-06-12	8826
endpoint: /sampleResponseRetrieve	MVP		2024-06-12	8827
Add "emdisPatientId" to patient block + validation of "patientId" field to make sure it starts with 4 digits	Early adopters, WMDA		2024-06-19	9229
endpoint: /infectiousDiseaseMarkerRequest	MVP		2024-07-08	9087
endpoint: /infectiousDiseaseMarkerRequestRetrieve	MVP		2024-07-08	9088
endpoint: /reservationRequestRequest	MVP		2024-07-12	9089
endpoint: /reservationRequestRetrieve	MVP		2024-07-12	9090
endpoint: /reservationReleaseRequest	MVP		2024-07-24	9091
endpoint: /reservationReleaseRetrieve	MVP		2024-07-24	9092
endpoint: /recoverMessages	MVP		2024-08-02	9788
endpoint: /genericRequestRequest	MVP		2024-08-01	9789
endpoint: /genericRequestRetrieve	MVP		2024-08-01	9790
endpoint: /resultReminderRequest	MVP		2024-08-14	9791
endpoint: /resultReminderRequestRetrieve	MVP		2024-08-14	9792
Update ENUMs for "requestType" field (requestCancellation + requestRejected endpoints)	Bug	WMDA: 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-23	10010
endpoint: /updateRegisteredPatientRequest	MVP		2024-09-04	9797
endpoint: /updateRegisteredPatientRetrieve	MVP		2024-09-04	9798
endpoint: /pingRequest	MVP		2024-09-11	9795
endpoint: /pingRetrieve	MVP		2024-09-11	9796
endpoint: /textMessageRequest	MVP		2024-09-24	10001
endpoint: /textMessageRetrieve	MVP		2024-09-24	10001
Add "OT" as enum to ethnicity	Bug	WMDA: missing in original specs	2024-09-27	10532
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-31 → 2025-07-30 (expected vs actual delivery date)	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-07-31→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-07-31→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-07-31 → 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-07 → 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-14 → 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-14 → 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-14 → 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 → 2025-08-28	12354 v2.0
Add hla object with optional fields	TWG	Added mandatory object 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-28 → 2025-08-29	11587 v2.0
Add value 'Q' as enum	TWG	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-11 → 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-25 → 2025.09.1616	10835 10835 v2.0
endpoint: /upload Attachment	MC-RFC 03: Document Exchange	Endpoint to upload a file to blob storage.	2025-10-02 → 2025-10-01	13195 v2.1
endpoint: /download Attachment	MC-RFC 03: Document Exchange	Endpoint to download a file from blob storage.	2025-10-02 → 2025-10-01	13289 v2.1

Upcoming features

Feature

Requested byWhat changedExpected Delivery DateWMDA Ticket #

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

TWG

Added optional serology object with two fields to hla.a, hla.b, hla.c, hla.drb1, hla.dqb1

withing

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

object

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

09

10-

25

03

10817

v2.0

Add extra logic when confirming reservation

TWG

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

If "response.confirmed"

= YES

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-

08

07

13535

v2.0

Add extra validation for selected fields

WMDA

Added following validations:

"donor.dateOfBirth" field is

mandatory and

required and nullable: false. Used in TYP_RES, IDM_RES, RSV_RES endpoints
"hlaNomenclatureVersion" field has maxLenght: 5. Used in TYP_RES, SMP_RES endpoints
"organisationId" is required, has minLength: 5, maxLength: 19,

nullable: false,

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.
"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-

08

09

13617

v2.0

Add "antiChagas" field to the marker and idm objects

TWG

Added new optional field "

antiChagas

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

object2025-10-08

13562

v2.0

"remark" field added to the

object)

endpoints

endpoints .

Affected payloads:

/api/v2/

sampleResponseRequest

infectiousDiseaseMarkerRequestRequest (

SMP

IDM_

RESTWG

Optional field "remark" added to the response object in SMP_RES endpoint.

Affected payloads:

REQ)

endpoint

- Request body: request.marker object

/api/v2/

sampleResponseRequest

infectiousDiseaseMarkerRequestRetrieve (

SMP

IDM_

RES

REQ)

Request

- Response body:

response

- messages.originalMessage.request.marker object
/api/v2/

sampleResponseRetrieve

infectiousDiseaseMarkerResultRequest (

SMP

IDM_RES)

Response

- 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

messages.originalMessage.response object

Added Embedded Attachment block to multiple endpoints to the root level of the request body.

Affected payloads:

/api/v2/extendedTypingRequestRequest (TYP_REQ)

Request body: new root-level attachment object

/api/v2/extendedTypingRequestRetrieve (TYP_REQ)

Response body: messages.originalMessage.attachment object

/api/v2/extendedTypingResponseRequest (TYP_RES)

Request body: new root-level attachment object

/api/v2/extendedTypingResponseRetrieve (TYP_RES)

Response body: messages.originalMessage.attachment object

/api/v2/sampleRequestRequest (SMP_REQ)

Request body: new root-level attachment object

/api/v2/sampleRequestRetrieve (SMP_REQ)

Response body: messages.originalMessage.attachment object

/api/v2/sampleResponseRequest (SMP_RES)

Request body: new root-level attachment object

/api/v2/sampleResponseRetrieve (SMP_RES)

Response body: messages.originalMessage.attachment object

/api/v2/sampleInfoRequest (SMP_INFO)

Request body: new root-level attachment object

/api/v2/sampleInfoRetrieve (SMP_INFO)

Response body: messages.originalMessage.attachment object

/api/v2/sampleArrivalRequest (SMP_ARR)

Request body: new root-level attachment object

/api/v2/sampleArrivalRetrieve (SMP_ARR)Response body: messages.originalMessage.attachment object new root-level attachment object objectattachmentinfectiousDiseaseMarkerResultRequest IDMRES new root-level attachment objectinfectiousDiseaseMarkerResultRetrieve IDMRES objectattachmentreservationReleaseRequest new root-level attachment object/v2/reservationReleaseRetrieve objectattachmentreservationRequestRequest (RSV_REQ) new root-level attachment objectreservationRequestRetrieve (RSV_REQ) attachment object

/api/v2/reservationResponseRequest (RSV_RES)

Request body: new root-level attachment object

/reservationResponseRetrieve RSVResponse messagesoriginalMessageattachment objectrequestCancellationRequest REQ_CAN)

Request body: new root-level attachment object

/api/v2/requestCancellationRetrieve (REQ_CAN .attachment objectrequestRejectedRequest NO new root-level attachment objectrequestRejectedRetrieve NO attachmentresultReminderRequest _REM new root-level attachment objectresultReminderRetrieve _REM

9794

v2.1

Feature	Requested by	What changed	Expected Delivery Date	WMDA Ticket #
Patient's `dateOfBirth` field allows year-only	Data Minimisation project	Updated the regex pattern for the patient's `dateOfBirth` field to support both full ISO 8601 date (YYYY-MM-DD) and year-only (YYYY). New regex pattern: "^\\d{4}(-[01]\\d-[0-3]\\d)?$" 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
2025-10-08	13562 v2.0
Selected fields are made mandatory in generalInformation & metaInformation objects	WMDA	Mandatory enforcement added for specific fields according to Semantics in: Embedded 'generalInformation' Response block: "limit", "totalCount", "remainingCount", "isSuccessful", "summary" fields. Embedded Meta Information block: "referenceMessageId", "deliveredAtUtc", "sendingRegistry", "messageSequenceNumber", "messageType" fields "responseType" field made optional	2025-10-08	13561 v2.0
endpoints: /genericDocumentExchangeRequestRequest & Retrieve	MC-RFC 03: Document Exchange	Endpoint used to send a document. And retrieve message with Retrieve endpoint.	13196 v2.1	endpoints: /cordBloodUnitReportRequestRequest & Retrieve	MC-RFC 03: Document Exchange	Endpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint.	13198 v2.1	endpoints: /cordBloodUnitReportResponseRequest & Retrieve	MC-RFC 03: Document Exchange	Endpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.	13197 v2.1	Add Embedded Attachment block	TWG
/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 block	TWG	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	attachment object /api/v2/ genericRequestRequest Request body: new root-level attachment object textMessage endpoint renamed to /api/v2/ genericRequestRetrieveResponse body: messages.originalMessage.attachment object 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 & Retrieve	TWG	Request rejected (NO_RES) endpoint that is used by the donor side and includes full donor block.	Q1 2026	13534 v2.1
endpoints: /cancellationConfirmationRequest & Retrieve	TWG	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: /alertRetrieve	TWG	Endpoint to retrieve alert messages. Alert can only be sent by WMDA to SMC network members.	Q1 2026	9793 v2.1
endpoint: /alertUpdateRetrieve	TWG	Endpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members.	9793 v2.1	endpoint: /alertUpdateRetrieve	TWG	Endpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members.	to SMC network members.	Q1 2026	9794 v2.1
endpoints: /cordBloodUnitReportRequestRequest & Retrieve	MC-RFC 03: Document Exchange	Endpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint.	Q1 2026	13198 v2.2
endpoints: /cordBloodUnitReportResponseRequest & Retrieve	MC-RFC 03: Document Exchange	Endpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.	Q1 2026	13197 v2.2
endpoints: /extendedTypingResponseCbuResponseRequest & Retrieve	MC-RFC 02: Cord Blood Endpoints	Endpoints according to source type CBU.	Q1 2026	13188 v2.2
endpoints: /infectiousDiseaseMarkerResultCbuResponseRequest & Retrieve	MC-RFC 02: Cord Blood Endpoints	Endpoints according to source type CBU.	Q1 2026	11816 v2.2
endpoints: /reservationResponseCbuResponseRequest & Retrieve	MC-RFC 02: Cord Blood Endpoints	Endpoints according to source type CBU.	Q1 2026	11726 v2.2

Page tree

Versions Compared

Old Version 91

New Version Current

Key

Upcoming features

Upcoming features

Page tree

Page History

Versions Compared

Old Version 91

New Version Current

Key

Upcoming features

Upcoming features