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

Compare with Current View Page History

« Previous Version 14 Next »



A register_patient message will be sent together with all requests. This message contains both wmdaId and patientId of the patient.

/post_api_v1_PatientRegistration

Provision of the donor ID in every request must be changed.

Current structure is:

donor*

{

description:

Supply one node from the following

gridstring
nullable: true

maxLength: 19

minLength: 19

example: 9991012070433202000
adcu

{

id*string
maxLength: 13

N/A in EMDIS

}

cbu

{

id*string
maxLength: 17

CBU Identification2 CB_ID Opt 17

}

}

ADCU and CBU have similar structure, but adult donor has the ID (GRID) right away.

Suggested structure for the adult donors:

scd or adult

{

grid*string
nullable: true
maxLength: 19
minLength: 19
example: 9991012070433202000

}

5.0 - DONOR_CB message

It was agreed that we must implement DONOR_CB message API to preserve the original EMDIS logic. 

S&M APIs have the DONOR_CB message split into 

https://apispecs.wmda.info/?urls.primaryName=Search%20%26%20Match#/searches/retrieveFullReportDonors

and

https://apispecs.wmda.info/?urls.primaryName=Search%20%26%20Match#/searches/retrieveFullReportCBUs

In the future another message for ADCUs may come to play.

Proposal: change the Semantics by requesting an "updated donor" message instead of DONOR_CB.

  • WMDA will implement the endpoints to POST the mentioned reports for each donor type.
  • Participating registries will have to implement the above mentioned reports for both GET and POST (instead of DONOR_CB)
  • Here is the comparison of the DONOR_CB and the API endpoints: EMDIS vs API.xlsx

5.1 - Typing Request

Needed

/post_api_v1_TypingRequestRequest

5.2 - Typing Results

Needed

/post_api_v1_TypingResponseRequest

After the TYP_RES message, a DONOR_CB with the updated donor data is mandatory to ensure up-to-date master data. See 4.0 above.

5.3 - Sample Request

The SampleRequestRequest (and SampleRequestRetrieve) is used to request a VT for a specific donor/product for a patient. The message, as all requests, has an embedded 'register_patient' part. Next to the actual request informations the institutions needed are sent explicitly as an embedded 'addressBlock' (6.1).

The message ID (correlationGUID) of this message will be used as 'referenceCode' for the rest of the request related message flow.

SendRetrieve
SampleRequestRequest (comments reffer to changes to the current API definition)SampleRequestRetrieve
  • patient (in form of an embedded register_patient block)
  • donor (format change see above)
  • referenceCode (not needed anymore see text above)
  • requestDate
  • prod1
  • prod2
  • prod3
  • prod4
  • receptionDate1
  • receptionDate2
  • acceptableReceptionDaysOfWeek
  • institutionToSendSampleTo (as embedded addressBlock)
  • institutionPaying (as embedded addressBlock)
  • urgent
  • acknowledgementId (not needed anymore → MSG_RSP)
  • remark
  • MetaInformation
  • Payload
    • patient (in form of an embedded register_patient block)
    • donor (format change see above)
    • referenceCode (not needed anymore see text above)
    • requestDate
    • prod1
    • prod2
    • prod3
    • prod4
    • receptionDate1
    • receptionDate2
    • acceptableReceptionDaysOfWeek
    • institutionToSendSampleTo (as embedded addressBlock)
    • institutionPaying (as embedded addressBlock)
    • urgent
    • acknowledgementId (not needed anymore → MSG_RSP)
    • remark

5.4 - Sample Information

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_SampleInfoRequest

5.5 - Sample Arrival

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_SampleArrivalRequest

5.6 - Sample Results

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_SampleResponseRequest

5.7 - Infectious Disease Marker Request

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_InfectiousDiseaseMarkerRequestRequest

5.8 - Infectious Disease Marker Results

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_InfectiousDiseaseMarkerResultRequest

After the IDM_RES message, a DONOR_CB with the updated donor data is mandatory to ensure up-to-date master data. See 4.0 above.

5.9 - Reservation Request

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_ReservationRequestRequest

5.10 - Reservation Result

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_ReservationResultRequest

After the RSV_RES message a DONOR_CB with the updated donor status is mandatory to reflect the change. See 4.0 above.

5.11 - Workup Request

Future Phase

5.12 - Workup Status

Future Phase

5.13 - Request Cancellation

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_RequestCancellationRequest

5.14 - Request Rejected (NO_RES)

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_NoResultRequest

If the results cannot be delivered, a NO_RES message followed by a DONOR_CB message is returned which includes the new donor status. See 4.0 above.

5.15 - Result Reminder (RES_REM)

Needed

https://apispecs.wmda.info/?urls.primaryName=Connect%20API#/Message/post_api_v1_ResultReminderRequest

  • No labels