...
| Send | Retrieve |
|---|
| SampleRequestRequest (comments refer to changes to the current API definition) | SampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request | | Expand |
|---|
| | requestDate | string($date-time) Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd] | | prod1 | {...} | | prod2 | {...} | | prod3 | {...} | | prod4 | {...} | | earliestDateCanReceive | string($date-time) Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd] | | latestDateCanReceive | string($date-time)
nullable: trueLatest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd] | | acceptableReceptionDaysOfWeek | integer
nullable: true
minLength: 7
maxLength: 7
example: 1111100Weekdays acceptable for reception. Binary fixed length string for the 7 days in the week. 1110000 means acceptable days for reception are Monday, Tuesday and Wednesday, not acceptable days are Thursday, Friday, Saturday or Sunday. | | institutionToSendSampleTo | Embedded Address Block | | institutionPaying | Embedded Address Block | | urgent | boolean Urgent request URGENT Opt 1 | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120
nullable: true
example: patient case is very urgentRemark 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 | Field
|
| Expand |
|---|
Details | recipient | | deliveredAtUtc | string($date-time) Server-supplied timestamp showing time of Message delivery to recipient's inbox queue | | referenceMessageId | 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 block* | {patient block} | | donor* | | description: | Supply one node from the following | | adult | {...} | | adcu | {...} | | cbu | {...} |
| | referenceCode* | string($uuid) | | requestDate* | string($date-time) Request date REQ_DATE Req 8 | prod1* | | responseType | stringEnum:
Array [ 3 ] | | remark | [...] |
|
| | Expand |
|---|
| No parameters specified |
| Expand |
|---|
| | Field | Details |
|---|
| originalMessage | {...} |
| 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* | address block Address of the institution the sample must be sent to | | institutionPaying* | address block Details of the institution that must pay for the service | | 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 | |
| Expand |
|---|
| | 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 | Expand |
|---|
| | Field | Details |
|---|
| 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* | {patient block} | | 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* | address block Address of the institution the sample must be sent to | | institutionPaying* | address block Details of the institution that must pay for the service | | 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.
...