You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 66 Next »

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

Available features

FeatureRequested byDelivery dateWMDA Ticket #

Initial setup

MVP2023-09-156720
Endpoint: /sampleRequestRequestMVP2023-09-226692
Endpoint: /sampleRequestRetrieveMVP2023-09-276744

Endpoint: /availableMessages

MVP2023-10-316746
Endpoint: /extendedTypingRequestRequestMVP2023-11-216683

add sequence numbers

TWG2023-11-227390
Endpoint: /extendedTypingRequestRetrieveMVP2023-12-116684
Endpoint: /reservationResponseRequestMVP2024-01-157654
HLA validationMVP2024-01-257098
Endpoint: /reservationResponseRetrieveMVP2024-02-207652
Endpoint: /messageResponseRequestMVP2024-02-278167
Optimise message content validation by using JSON schemas for all endpointsWMDA2024-03-128215
Unify wmdaResponse and metaInformation block following early adopter feedback

Early adopter

2024-03-14

8284
Adapt donor block following early adopter feedbackEarly adopter2024-03-158283 & 8286
endpoint: /messageResponseRetrieveMVP2024-03-208175
endpoint: /requestCancellationRequestMVP2024-03-278052
endpoint: /requestCancellationRetrieveMVP2024-03-298053
endpoint: /requestRejectedRequestMVP2024-04-058194
endpoint: /requestRejectedRetrieveMVP2024-04-058195
endpoint: /extendedTypingResponseRequestMVP2024-04-188216
endpoint: /extendedTypingResponseRetrieveMVP2024-04-198217
endpoint: /sampleArrivalRequestMVP2024-04-298820
endpoint: /sampleArrivalRetrieveMVP2024-04-298821
endpoint: /infectiousDiseaseMarkerResultRequestMVP2024-05-218822
endpoint: /infectiousDiseaseMarkerResultRetrieveMVP2024-05-218823
Fix example automated Swagger messageResponseRetrieveEarly adopter2024-05-219117
Fix enums "reason" field requestRejected messagesEarly adopter2024-05-219118
endpoint: /sampleInfoRequest 
MVP2024-05-298824
endpoint: /sampleInfoRetrieve 
MVP2024-05-298825
endpoint: /sampleResponseRequestMVP2024-06-128826
endpoint: /sampleResponseRetrieveMVP2024-06-128827
Add "emdisPatientId" to patient block + validation of "patientId" field to make sure it starts with 4 digitsEarly adopters, WMDA2024-06-199229
endpoint: /infectiousDiseaseMarkerRequestMVP2024-07-089087
endpoint: /infectiousDiseaseMarkerRequestRetrieveMVP2024-07-089088
endpoint: /reservationRequestRequestMVP2024-07-129089
endpoint: /reservationRequestRetrieveMVP2024-07-129090
endpoint: /reservationReleaseRequestMVP2024-07-249091
endpoint: /reservationReleaseRetrieveMVP2024-07-249092
endpoint: /recoverMessagesMVP2024-08-029788
endpoint: /genericRequestRequestMVP2024-08-019789
endpoint: /genericRequestRetrieveMVP2024-08-019790
endpoint: /resultReminderRequestMVP2024-08-149791
endpoint: /resultReminderRequestRetrieveMVP2024-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: [ ALM, BLS, CBR, IDM, RSV, TYP, WOR ] 

Correct specs:
requestType
string
Enum: [ genericRequest, extendedTypingRequest, sampleRequest, infectiousDiseaseMarkerRequest ]		2024-08-2310010
endpoint: /updateRegisteredPatientRequestMVP2024-09-049797
endpoint: /updateRegisteredPatientRetrieveMVP2024-09-049798
endpoint: /pingRequestMVP2024-09-119795
endpoint: /pingRetrieveMVP2024-09-119796
endpoint: /textMessageRequest MVP2024-09-2410001
endpoint: /textMessageRetrieveMVP2024-09-2410001
Add "OT" as enum to ethnicityBug/WMDA: missing in original specs2024-09-2710532
endpoint: /health


endpoint: /auth


endpoint: /RegistryDetails


endpoint: /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.

FeatureType of changeRequested byWhat changedExpected Delivery DateActual Delivery DateWMDA ticket

Endpoints affected:

Fields removed

TWG

#37

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

Affected payloads:

2025-07-31

2025-07-3011586

Endpoints affected:

Field renamed

Early adopter

#19

Renamed "address" field to "institutionPaying" in TYP_REQ endpoints.

Affected payloads:

2025-07-31

2025-08-0412920

Endpoints affected:

Field added

Early adopter

#26

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

Affected payloads:

2025-07-31

2025-08-0412469

Endpoints affected:

Field added

&

Object changed to optional

TWG

#39

Changed patient object to optional.

Added optional field "referenceMessageId" to TXT_MSG endpoints.

Affected payloads:

2025-07-312025-08-0411596

Endpoints affected:

Field removed

TWG

#30

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

Affected payloads:

2025-08-072025-08-0611555

Endpoints affected:

Enum values added

Early adopter

#24

Added new enum values "G", "M", "B", "H", "O" to "antiToxoplasmosisStatus" and "antiEbvStatus" fields 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:

2025-08-142025-08-0813032

Endpoints affected:

Fields added

TWG

#41

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

Added "ccr5" field to SMP_RES endpoints.

Affected payloads:

2025-08-142025-08-0812353

Endpoints affected:

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:


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

Affected payloads:

2025-08-142025-08-0712465

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

Rank based on early adopter preferenceFeatureRequested by WMDA ticket #
1endpoint: /alertRetrieveMVP9793
2endpoint: /alertUpdateRetrieveMVP9794
  • No labels