Versions Compared

Key

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

...

FeatureRequested byWhat changedExpected Delivery DateWMDA Ticket #
Add Serology object with two fields to hla.a, hla.b, hla.c , drb1, dqb1TWG

Added optional serology object with two fields to hla.a, hla.b, hla.c , drb1, dqb1 withing hla object for TYP_RES, IDM_RES, RSV_RES, SMP_RES, TYP_REQ, Generic Request, IDM_REQ, RSV_REQ, SMP_REQ, Update Registered Patient endpoints.

Affected payloads:

  • /api/v2/extendedTypingResponseRequest (TYP_RES)
    • Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 & response.hla.a, response.hla.b, response.hla.c, reponse.hla.drb1, response.hla.dqb1 objects
  • /api/v2/extendedTypingResponseRetrieve (TYP_RES)
    • Response body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1messages.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
  • /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-2510817
Add "antiChagas" field to the marker and idm objectsTWG

Added new optional field "antiChagas" to the marker and idm objects in IDM_REQ (request.marker object), IDM_RES (response.marker , response.idm & donor.idm objects), TYP_RES (donor.idm object), RSV_RES (donor.idm object), SMP_RES (response.idm object) endpoints 

2025-10-08 

"dateOfBirth" field is mandatory.

Selected fields are made mandatory in generalInformation & metaInformation objects

WMDA

Mandatory enforcement added for specific fields according to Semantics in:

  • Embedded Meta Information block: "referenceMessageId", "deliveredAtUtc", "sendingRegistry", "messageSequenceNumber", "messageType" fields
    • "responseType" fields made optional
  • Embedded 'generalInformation' Response block: "limit", "totalCount", "remainingCount", "isSuccessful", "summary" fields.
  • Embedded Adult Donor Block (donor in response): "dateOfBirth" field
2025-10-08 

"remark" field added 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-08 
endpoint: /upload AttachmentMC-RFC 03: Document ExchangeEndpoint to upload a file to blob storage.2025-0910-120213195
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
Add Embedded Attachment blockTWG

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
  • /api/v2/infectiousDiseaseMarkerRequestRequest (IDM_REQ)
    • Request body: new root-level attachment object
  • /api/v2/infectiousDiseaseMarkerRequestRetrieve (IDM_REQ)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/infectiousDiseaseMarkerResultRequest (IDM_RES)
    • Request body: new root-level attachment object
  • /api/v2/infectiousDiseaseMarkerResultRetrieve (IDM_RES)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/reservationReleaseRequest
    • Request body: new root-level attachment object
  • /api/v2/reservationReleaseRetrieve
    • Response body: messages.originalMessage.attachment object
  • /api/v2/reservationRequestRequest (RSV_REQ)
    • 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
  • /api/v2/reservationResponseRetrieve (RSV_RES)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/requestCancellationRequest (REQ_CAN)
    • Request body: new root-level attachment object
  • /api/v2/requestCancellationRetrieve (REQ_CAN)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/requestRejectedRequest (NO_RES)
    • Request body: new root-level attachment object
  • /api/v2/requestRejectedRetrieve (NO_RES)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/resultReminderRequest (RES_REM)
    • Request body: new root-level attachment object
  • /api/v2/resultReminderRetrieve (RES_REM)
    • Response body: messages.originalMessage.attachment object
  • /api/v2/genericRequestRequest
    • Request body: new root-level attachment object
  • /api/v2/genericRequestRetrieve
    • Response body: messages.originalMessage.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

...