...
This message is used to request a sample to be used for a verifcation typing in the lab of the sending registry.
| Send (Post) | Retrieve (Post) |
|---|
| sampleRequestRequest(comments refer to changes to the current API definition) | sampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | requestingRegistryReferenceCode | string
maxLength: 15
example:XX12345 | | 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. E.g., 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 | | urgentisUrgent | 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: the patient case is very urgentRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344-digit ION of the receiving registry | | patient* | Embedded Patient Block | | donor* | Donor ID |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrievalafter retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...
This message is used to send relevant secondary information which may arise in the context of sample request.
Send (Post)
| Retrieve (Post)
|
| sampleInfoRequest (comments refer to changes to the current API definition) | sampleInfoRetrieve |
| Expand |
|---|
| | message* | | Expand |
|---|
| | requestingRegistryReferenceCode | string
maxLength: 15
example:XX12345 | | referenceCode* | string($uuid) | | informationType* | string
maxLength: 3
minLength: 3Information Type INFO_TYPE Req 3 Enum:
Array [ 12 ] | | remark | string
nullable: trueRemark REMARK Opt 120 |
|
| | receivingRegistry* | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344-digit ION of the receiving registry | | patient* | Patient wmdaId ID provided by the WMDA | | donor* | Embedded Donor Block |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval | | messageSequenceNumber | integer
examplet: 12345 Optional field to request a message with a specific messageSequenceNumber. If that message (no longer) exists then no message will be returned. |
|
|
...