...
| Send | Retrieve |
| extendedTypingRequestRequest | extendedTypingRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | Field | Details |
|---|
| resolutionRequired* | string
maxLength: 11
minLength: 11
example: HHHHMMM-H-HA character string with a fixed length in which each position represents an HLA locus. The coding of the resolution required for every position is: S = serological L = DNA low resolution M = DNA medium resolution H = DNA high resolution - (hyphen) = not requested. The character string is interpreted from left to right, with position 1 as the leftmost position. The positions for the HLA loci are defined as Position 1: HLA-A Position 2: HLA-B Position 3: HLA-C Position 4: HLA-DRB1 Position 5: HLA-DRB3 Position 6: HLA-DRB4 Position 7: HLA-DRB5 Position 8: HLA-DQA1 Position 9: HLA-DQB1 Position 10: HLA-DPA1 Position 11: HLA-DPB1 | | address | Embedded Address Block | | urgent* | boolean Urgent request URGENT Opt 1 | | 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 retrieval |
|
|
...
| Send | Retrieve |
| extendedTypingResponseRequest | extendedTypingResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response* | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode | string($uuid) | | hlaNomenclatureVersion | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | etSampleType | string
nullable: trueType of sample. AS = CBU Contiguous Attached Segment WB = Whole Blood Sample RC = Red Cell Fraction (pellet) FP = Blood Spotted Filter Paper ED = Extracted DNA Enum:
Array [ 5 ] | | 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 | | donor* | Embedded Donor Block | | patient* | Patient ID |
|
| | Expand |
|---|
| | limit | integer
default: 100
| | shouldPeek | boolean
default: false
Set to true if you want messages to remain available after retrieval |
|
|
...
This message is used to request a VT (verification typing) of a specific donor/product for a patient.
| Send | Retrieve |
|---|
| sampleRequestRequest (comments refer to changes to the current API definition) | sampleRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| request* | | Expand |
|---|
| | 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 | | 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: 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 retrieval |
|
|
Rules:
...