Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel1

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)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
, Enum: [ ALM, BLS, CBR, IDM, RSV, TYP, WOR ] 
Correct specs:

requestType

, string

Enum
, 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 ethnicityBug
/
WMDA: missing in original specs2024-09-2710532
endpoint: /health2024-06-179241endpoint: /authendpoint: /RegistryDetailsendpoint: /woid

Changelog for harmonising existing features

Technical Working Group (TWG) has decided to implement the following changes promptly, without a grace period, despite some being breaking changes. These changes aim to harmonise existing features. Following this, the WMDA team will continue developing new features.

We do not have a grace period; changes are delivered as soon as they are ready, following our agile Scrum process. Since Match-Connect is in the sandbox phase and no organisations are in production yet, this approach allows us to continuously improve without batching updates.

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
Rename "address" field to "institutionPaying"

Early adopter

Renamed "address" field to "institutionPaying" in TYP_REQ

FeatureType of changeRequested byWhat changedExpected Delivery DateActual Delivery DateWMDA ticketRemove "donorWeightKg", "donorHeightCm", "numberOfTransfusions", "numberOfPregnancies" fieldsFields removed

TWG

#37

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

endpoints.

Affected payloads:

  • /api/v2/
infectiousDiseaseMarkerResultRequest
  • extendedTypingRequestRequest (
IDM
  • TYP_
RES
  • REQ)
    • Request body:
response
    • request object
  • /api/v2/
infectiousDiseaseMarkerResultRetrieve
  • extendedTypingRequestRetrieve (
IDM
  • TYP_
RES
  • REQ) 
    • Response body: messages.originalMessage.
response
    • request object
2025-07-
312025
31→2025-
07
08-
30
04
11586Rename "address" field to "institutionPaying"    Field renamed"institutionPaying" in TYP_REQ
12920
Add optional field "ccr5"

Early adopter

#19

Renamed "address" field to 

Added optional field "ccr5" to marker object in IDM_REQ and IDM_RES endpoints.

Affected payloads:

  • /api/v2/
extendedTypingRequestRequest
  • infectiousDiseaseMarkerRequestRequest (
TYP
  • IDM_REQ)
    • Request body: request.marker object
  • /api/v2/
extendedTypingRequestRetrieve
  • infectiousDiseaseMarkerRequestRetrieve (
TYP
  • IDM_REQ)
 

    • Response body: messages.originalMessage.request
object

2025-07-31

2025-08-0412920Add optional field "ccr5"    Field added

Early adopter

#26

Added optional field "ccr5" to IDM_REQ and IDM_RES endpoints.

Affected payloads:

    • .marker object
  • /api/v2/
infectiousDiseaseMarkerRequestRequest
  • infectiousDiseaseMarkerResultRequest (IDM_
REQ/api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
Request body:
  • RES)
    • Request body:
request.marker object
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
    • Response body: messages.originalMessage.request.marker object
      • response.marker object
    • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
      • Response body: messages.originalMessage.response.marker object
    2025-07-
    312025
    31→2025-08-0412469

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

    Field added

    &

    Object changed to optional

    TWG

    #39

    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-0411596
    Remove "requestId" field from multiple endpoints
       

    Field removed

    TWG

    #30

    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-0611555
    Add
    new
    enum values "G", "M", "B", "H", "O"
       

    Enum values added

    Early adopter

    #24

    Added

    new

    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
      • object
    2025-08-14
    2025-08-0813032
    Rename "donorCcr5Status" to "ccr5" and added "abo", " rhesus" fields
       

    Fields added

    TWG

    #40

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

    IDM_RES endpoints.Added "ccr5" field to SMP_RES endpoints

    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-0812353
    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-0712465
    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-2812354
    Add hla object with optional fields

    TWG

    Added mandatory 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-2911587

    Upcoming features

    FeatureRequested byWhat changedExpected Delivery DateWMDA Ticket #
    endpoint: /upload AttachmentMC-RFC 03: Document ExchangeEndpoint to upload a file to blob storage.2025-09-1213195
    endpoint: /download AttachmentMC-RFC 03: Document ExchangeEndpoint to download a file from blob storage.2025-10-0213289
    endpoints: /genericDocumentExchangeRequestRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to send a document. And retrieve message with Retrieve endpoint.2025-10-0213196
    endpoints: /cordBloodUnitReportRequestRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to request a Cord Blood Unit Report. And retrieve message with Retrieve endpoint.
    13198
    endpoints: /cordBloodUnitReportResponseRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.
    13197
    Refine organisation, sampleType and statusReason
    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

    &

    Added enum values “RS” + “DE” (reserved, deleted) for "statusReason" field within 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

    10835
    Add value 'Q' as enumTWG

    Added enum value "Q" (Questionable) to the fields 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 & response.idm objects
    • /api/v2/sampleResponseRetrieve (SMP_RES)
      • Response body: messages.originalMessage.response & messages.originalMessage.response.idm objects

    12464
    Add Serology object to the Donor In Response blockTWG

    Added optional serology object with two fields to the Donor in Response block in TYP_RES, IDM_RES, RSV_RES 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 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 objects
    • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
      • Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 object
    • /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

    10817
    Add Embedded Attachment blockTWG

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

    Affected payloads:

    • /api/v2/
    infectiousDiseaseMarkerResultRequest
    • extendedTypingRequestRequest (
    IDM
    • TYP_
    RES
    • REQ)
      • Request body:
    response
      • new root-level attachment object
    • /api/v2/
    infectiousDiseaseMarkerResultRetrieve
    • extendedTypingRequestRetrieve (
    IDM
    • TYP_
    RES
    • REQ)
      • Response body: messages.originalMessage.
    response object
      • attachment object
    • /api/v2/
    sampleResponseRequest
    • extendedTypingResponseRequest (
    SMP
    • TYP_RES)
      • Request body
    : response
      • : new root-level attachment object
    • /api/v2/
    sampleResponseRetrieve
    • extendedTypingResponseRetrieve (
    SMP
    • TYP_RES)
      • Response body: messages.originalMessage.
    response object2025-08-142025-08-0812353
      • 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
    Remove "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other" fields & move these fields within SMP_RES endpoints     

    Fields removed

    &

    Fields moved to a different object in SMP_RES

    Early adopter

    #25

    Removed "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent", "other"  ("other" field present in the marker object only) fields from TYP_RES, IDM_REQ, IDM_RES, RSV_RES endpoints.

    Affected payloads:
    • /api/v2/
    extendedTypingResponseRequest
    • sampleResponseRequest (
    TYP
    • SMP_RES)
      • Request body:
    donor.idm object
      • new root-level attachment object
    • /api/v2/
    extendedTypingResponseRetrieve
    • sampleResponseRetrieve (
    TYP
    • SMP_RES)
      • Response body: messages.originalMessage.
    donor.idm
      • attachment object
    • /api/v2/
    infectiousDiseaseMarkerRequestRequest
    • sampleInfoRequest (
    IDM
    • SMP_
    REQ
    • INFO)
      • Request body:
     request.marker object
      • new root-level attachment object
    • /api/v2/
    infectiousDiseaseMarkerRequestRetrieve
    • sampleInfoRetrieve (
    IDM
    • SMP_
    REQ
    • INFO)
      • Response body: messages.originalMessage.
    request.marker
      • attachment object
    • /api/v2/
    infectiousDiseaseMarkerResultRequest
    • sampleArrivalRequest (
    IDM
    • SMP_
    RES
    • ARR)
      • Request body:
    response.marker, response.idm & donor.idm objects
      • new root-level attachment object
    • /api/v2/
    infectiousDiseaseMarkerResultRetrieve
    • sampleArrivalRetrieve (
    IDM
    • SMP_
    RES
    • ARR)
      • Response body:
    messages.originalMessage.response.marker, messages.originalMessage.response.idm &
      •  messages.originalMessage.
    donor.idm objects
      • attachment object
    • /api/v2/
    reservationResponseRequest
    • infectiousDiseaseMarkerRequestRequest (
    RSV
    • IDM_
    RES
    • REQ)
      • Request body:
    donor.idm object
      • new root-level attachment object
    • /api/v2/
    reservationResponseRetrieve
    • infectiousDiseaseMarkerRequestRetrieve (
    RSV
    • IDM_
    RES
    • REQ)
      • Response body: messages.originalMessage.
    donor.idm object

    Moved "mixedLymphocyteCultureGvh", "mixedLymphocyteCultureHvg", "gvhReactivityPercent", "hvgReactivityPercent" fields from  response.idm to response.lymphocyteReactivity object in SMP_RES endpoints.

      • attachment object
    • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
      • Request body: new root-level attachment object
    Affected payloads:
    • /api/v2/
    sampleResponseRequest
    • infectiousDiseaseMarkerResultRetrieve (
    SMP
    • IDM_RES)
      • Response body: messages.originalMessage.attachment object
    • /api/v2/reservationReleaseRequest
      • Request body: new root-level attachment object
    • /api/v2/reservationReleaseRetrieve
      • Response body:
    response.idm → response.lymphocyteReactivity object
      •  messages.originalMessage.attachment object
    • /api/v2/
    sampleResponseRetrieve
    • reservationRequestRequest (
    SMP
    • RSV_
    RES
    • REQ)
    • Response body: messages.originalMessage.response.idm → messages.originalMessage.response.lymphocyteReactivity object
    • 2025-08-142025-08-0712465Add HLA object with optional fields    

      Object added

      TWG

      #41

        • Request body: new root-level attachment object
      • /api/v2/reservationRequestRetrieve (RSV_REQ)
        • Response body: messages.originalMessage.attachment object
      • /api/v2/reservationResponseRequest (RSV_RES)
        • Request body: new root-level attachment object

      Added HLA object with optional fields to response object in TYP_RES endpoints.

      Affected payloads:
      • /api/v2/
      extendedTypingResponseRequest
      • reservationResponseRetrieve (
      TYP
      • RSV_RES)
        Request
          • Response body:
        response → response.hla
          •  messages.originalMessage.attachment object
        • /api/v2/
        extendedTypingResponseRetrieve
        • requestCancellationRequest (
        TYP
        • REQ_
        RES
        • CAN)
        • Response body: messages.originalMessage.response → messages.originalMessage.response.hla object
        • 2025-08-2811587

          Add "reservedPatientWmdaId" as optional field    

          Field added

          TWG

          #42

          Added "reservedPatientWmdaId" as optional field to the donor in response block in TYP_RES, IDM_RES, RSV_RES endpoints.

            • Request body: new root-level attachment object
          • /api/v2/requestCancellationRetrieve (REQ_CAN)
            • Response body: messages.originalMessage.attachment object
          Affected payloads:
          • /api/v2/
          extendedTypingResponseRequest
          • requestRejectedRequest (
          TYP
          • NO_RES)
            • Request body:
          donor
            • new root-level attachment object
          • /api/v2/
          extendedTypingResponseRetrieve
          • requestRejectedRetrieve (
          TYP
          • NO_RES)
            • Response body: messages.originalMessage.
          donor object
            • attachment object
          • /api/v2/
          infectiousDiseaseMarkerResultRequest
          • resultReminderRequest (
          IDM
          • RES_
          RES
          • REM)
            • Request body:
          donor
            • new root-level attachment object
          • /api/v2/
          infectiousDiseaseMarkerResultRetrieve
          • resultReminderRetrieve (
          IDM
          • RES_
          RES
          • REM)
            • Response body: messages.originalMessage.
          donor
            • attachment object
          • /api/v2/
          reservationResponseRequest (RSV_RES)
          • genericRequestRequest
            • Request body:
          donor object
            • new root-level attachment object
          • /api/v2/
          reservationResponseRetrieve (RSV_RES)
          • genericRequestRetrieve
            • Response body: messages.originalMessage.
          donor object2025-08-2812354

          Upcoming features sorted by priority/ expected delivery order

          Below you will find a list of features that are yet to be implemented into the Connect API. These are ranked according to priority and the expected delivery order. If you are missing any features in the Connect API, or have any feedback for us, please contact: support@wmda.info

          ...

          sortColumn1 ASC
            • attachment object

          12350
          endpoints: /extendedTypingResponseCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU
          13188
          endpoints: /infectiousDiseaseMarkerResultCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU
          11816
          endpoints: /reservationResponseCbuResponseRequest & RetrieveMC-RFC 02: Cord Blood EndpointsEndpoints according to source type CBU
          11726
          endpoints: /cancellationConfirmationRequest & RetrieveTWG

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


          13174
          endpoint: /alertRetrieveTWGEndpoint to retrieve alert messages. Alert can only be sent by WMDA to SMC network members.
          9793
          endpoint: /alertUpdateRetrieveTWGEndpoint to retrieve alert updates. Alert can only be sent by WMDA to SMC network members.

          ...


          9794