...
The referenceCode is the 'messageId' from the request message.
EMDIS Semantic:
- The SMP_INFO message can only be exchanged in one direction: from donor side to patient side.
- Sample information is always referencing a sample request.
- Sample information is only valid as long as the referenced sample request is considered as ”open” or the donor is reserved for this patient after the sample request.
- A request is considered as ”open” as long as the patient registry has neither reported the sample result nor a ”service cannot be performed (NO_RES)” information nor a request cancellation.
- There might be several sample information messages within the context of one sample request. Subsequent sample information is regarded as new or additional information and not as updates.
| Send | Retrieve |
| SampleInfoRequest (comments refer to changes to the current API definition) | SampleInfoRetrieve |
| Expand |
|---|
| | referenceCode* | string($uuid) | | informationType* | string
maxLength: 3
minLength: 3Information Type INFO_TYPE Req 3 Enum:
Array [ 12 ] | | remark | string
nullable: trueRemark REMARK Opt 120 | | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | patient* | Embedded Patient Block | | donor* | Embedded Donor Block |
|
| | Expand |
|---|
| | No parameters specified |
|
...
| Send | Retrieve |
| ReservationReleaseRequest | ReservationReleaseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient Block | | donor* | Embedded Donor Block | | referenceCode* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason | string
maxLength: 3
minLength: 3
nullable: trueReason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
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 | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
...
| Send | Retrieve |
| RequestCancellationRequest | RequestCancellationRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient* | Embedded Patient Block | | donor* | Embedded Donor Block | | referenceCode* | string($uuid) | | requestType* | string
maxLength: 3Type of request REQ_TYPE Req 3 | | reason | string
maxLength: 3
minLength: 3
nullable: trueReason of request cancellation REASON_CNCL Opt 3 | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
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 | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
...
| Send | Retrieve |
| ResultReminderRequest | ResultReminderRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| sender* | string
maxLength: 4
minLength: 4
example: 56784 digit ION of sender | | sentAtUtc* | string($date-time) Server-supplied timestamp showing UTC time sender posted (i.e. sent) MessageRequest. | | deliveredAtUtc* | string($date-time) Server-supplied timestamp showing UTC time of Message delivery to recipient's inbox queue. | | payload* | | Expand |
|---|
| | Field | Details |
|---|
| patient | Embedded Patient Block | | donor | Embedded Donor Block | | requestDate | string($date-time)
nullable: trueRequest date REQ_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | referenceCode* | string($uuid) | | resultType* | string
maxLength: 9Type of result reminded RES_TYPE Req 9 | | expirationDate | string($date-time)
nullable: trueRequest date EXPI_DATE Opt 8 yyyy-MM-dd [or yyyyMMdd] | | remark | string
maxLength: 120
nullable: trueRemark REMARK Opt 120 |
|
| | recipient* | string
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 | | messageType | string Message types supported by WmdaConnect Enum:
Array [ 21 ] |
|
| | Expand |
|---|
| | No parameters specified |
|
...