Versions Compared

Old Version 75

changes.mady.by.user Vova Maystruk

Saved on

compared with

New Version 76

changes.mady.by.user Vova Maystruk

Saved on

Key

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

...

Added optional fields "phone", "fax", "email" to organisation REQREQ endpoints.extendedTypingRequestRequest REQrequestinstitutionPaying.organisation objectextendedTypingRequestRetrieve TYPREQ .request.institutionPaying.organisation objectinfectiousDiseaseMarkerRequestRequest IDMREQ request.institutionPaying.organisation objectinfectiousDiseaseMarkerRequestRetrieve IDMREQrequestinstitutionPaying.organisationsampleRequestRequest REQ request.institutionPaying.organisation sampleRequestRetrieve REQ body: 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 objectextendedTypingResponseRetrieve Response body: messages.originalMessage.response objectsampleArrivalRequest (SMP_ARR)
  • Request body: message object
/api/v2/sampleArrivalRetrieve (SMP_ARRmessage 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: object body: donor object object/api/v2/reservationResponseRequest (RSV_RES)Request body: donor objectreservationResponseRetrieve Response messagesoriginalMessagedonor object

    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 objectinfectiousDiseaseMarkerResultRequest IDMRESdonoridm & response.idm objectsinfectiousDiseaseMarkerResultRetrieve IDMRES: messages.originalMessage.donor.idm & response.idm objectsreservationResponseRequest RSVRES donor.idm objectreservationResponseRetrieve RSVRESdonoridmsampleResponseRequest RES response.idm sampleResponseRetrieve RESresponse & messages.originalMessage.response.idm objectsAdded optional serology object with two fields to the Donor in Response block in TYP_RES, IDM_RES, RSV_RES TYP_RES)Request body: donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1, donor.hla.dqb1 objectsdonor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c, messages.originalMessage.donor.hla.drb1, messages.originalMessage.donor.hla.dqb1 objectsinfectiousDiseaseMarkerResultRequest IDMRES donor.hla.dqb1 donor.hla.a, donor.hla.b, donor.hla.c, donor.hla.drb1,infectiousDiseaseMarkerResultRetrieve IDMRES body: messages.originalMessage.donor.hla.a, messages.originalMessage.donor.hla.b, messages.originalMessage.donor.hla.c,
    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.13198endpoints: /cordBloodUnitReportResponseRequest & RetrieveMC-RFC 03: Document ExchangeEndpoint used to respond to Cord Blood Unit Report request. And retrieve message with Retrieve endpoint.13197Refine organisation, sampleType and statusReason
    		TWG
    Add value 'Q' as enumTWG

    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-1112464
    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.
        10835Add value 'Q' as enumTWG
          • 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
        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.
        2025-09-1112464Add Serology object to the Donor In Response blockTWG
          • 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

        		10835
        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.
        		13197donor.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/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

        ...