...
The maximum amount of material, requested in one sample request or pre-collection sample request, is 100 ml, if not stated otherwise in the national rules. If the number of tubes is unassigned, not given in the request, the default value number of tubes is one.
new:
| 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 |
|
old:
| Send | Retrieve |
| SampleRequestRequest (comments reffer to changes to the current API definition) | SampleRequestRetrieve |
- 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
- Response
- deliveredAtUtc
- messageId
- responseType
- remark
|
- Response
- MetaInformation
- Send payload
|
...