General considerations:
A patient registration embedded block will be sent together with each request. This block contains both wmdaId and patientId of the patient.
The donor requested has to be reserved at the remote hub and reported back to the requesting hub / donor registry by a DONOR_CB with D_STATUS = ”RS”.
...
After the TypingResults (TYP_RES) message which includes an embedded donor (DONOR_CB) block, a separate update must be made to the Search & Match system with the updated donor data to ensure up-to-date master data.
5.3 - Sample Request
...
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 information the institutions needed are sent explicitly as an embedded 'addressBlock' (6.1).
...
| Send | Retrieve |
|---|
| SampleRequestRequest (comments reffer to changes to the current API definition) | SampleRequestRetrieve |
Request | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | Payload |
|---|
| patient* | {...} | | donor* | {...} | | referenceCode* | string($uuid) | | requestDate* | string($date-time) Request date REQ_DATE Req 8 | | prod1* | {...} | | prod2 | {...} | | prod3 | {...} | | prod4 | {...} | | receptionDate1* | string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd] | | receptionDate2 | string($date-time)
nullable: trueLatest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd] | | acceptableReceptionDaysOfWeek | string
nullable: trueWeekdays acceptable for reception ACC_DAYS Opt 7 | | institutionToSendSampleTo* | string
maxLength: 14Institution the sample has to be sent to INST_SMP_SENT Req 10 | | institutionPaying* | string
maxLength: 10Institution paying INST_PAY Req 10 | | urgent | boolean Urgent request URGENT Opt 1 | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
nullable: trueRemark REMARK Opt 120 |
Response | deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue | | referenceMessageId | string($uuid) | | responseType | stringEnum:
Array [ 3 ] | | remark | [...] |
| Request No parameters specified Response | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | correlationGuid* | string($uuid) Sender generated GUID used to correlate response acknowledgement | | Payload | | patient* | {...} | | donor* | {...} | | referenceCode* | string($uuid) | | requestDate* | string($date-time) Request date REQ_DATE Req 8 | | requestDateEmdis | string
nullable: true
readOnly: trueEMDIS format of Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | prod1* | {...} | | prod2 | {...} | | prod3 | {...} | | prod4 | {...} | | receptionDate1* | string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd] | | receptionDate1Emdis | string
nullable: true
readOnly: trueEMDIS format of Earliest date of sample reception REC_DATE1 Req 8 | | receptionDate2 | string($date-time)
nullable: trueLatest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd] | | receptionDate2Emdis | string
nullable: true
readOnly: trueEMDIS format of Latest date of sample reception REC_DATE2 Opt 8 | | acceptableReceptionDaysOfWeek | string
nullable: trueWeekdays acceptable for reception ACC_DAYS Opt 7 | | institutionToSendSampleTo* | string
maxLength: 14Institution the sample has to be sent to INST_SMP_SENT Req 10 | | institutionPaying* | string
maxLength: 10Institution paying INST_PAY Req 10 | | urgent | boolean Urgent request URGENT Opt 1 | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
nullable: trueRemark REMARK Opt 120 |
|
5.
...
4 - Sample Information
The SampleInfoRequest (and SampleInfoRetrieve) is used to sent relevant secondary information which may arise in the context of sample request.
...
| Send | Retrieve |
| SampleInfoRequest (comments reffer to changes to the current API definition) | SampleInfoRetrieve |
- Payload
- patient (just the wmdaID)
- donor (format change see above)
- referenceCode (see text above)
- informationType
- remark
- Response
- deliveredAtUtc
- messageId
- responseType
- remark
|
- Response
- MetaInformation
- Send payload
|
5.
...
5 - Sample Arrival
The SampleArrivalRequest (and SampleArrivalRetrieve) is used to transmit proposed date of sample arrival.
...
| Send | Retrieve |
| SampleArrivalRequest (comments refer to changes to the current API definition) | SampleArrivalRetrieve |
- Payload
- patient (just the wmdaID)
- donor (format change see above)
- referenceCode (see text above)
- arrivalDate
- collectionDate
acknowledgementId (not needed anymore → MSG_RSP)- labelId (is there a usecase for this ID, where it is not the donor ID?)
- aampleType (missing: was this field dropped by purpose?)
- remark
- Response
- deliveredAtUtc
- messageId
- responseType
- remark
|
- Response
- MetaInformation
- Send payload
|
5.
...
6 - Sample Results
The SampleResponseRequest (and SampleResponseRetrieve) is used to transmit the results of the sample request.
...