...
This message is used to send the results of the initial ET request back to the requesting registry.
Check paragraph '5.18 Extended Typing' for the related message flows.
| Send | Retrieve |
| TypingResponseRequestextendedTypingResponseRequest | TypingResponseRetrieveextendedTypingResponseRetrieve |
| 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: patient case is very urgentRemark REMARK Opt 120 |
|
| | recipient | integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 12344 digit ION of recipient | | donor | Embedded Donor Block | | patient | Embedded Patient Block |
|
| | Expand |
|---|
| | No parameters specified |
|
...
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.
| Send | Retrieve |
|---|
| SampleRequestRequest sampleRequestRequest(comments refer to changes to the current API definition) | SampleRequestRetrievesampleRequestRetrieve |
| 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 |
|
| | Expand |
|---|
| No parameters specified |
|
...
- 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.
...
This message is sent in response to a SMP_REQ and indicates the arrival date of the sample.
| Send | Retrieve |
| SampleArrivalRequestsampleArrivalRequest (comments refer to changes to the current API definition) | SampleArrivalRetrievesampleArrivalRetrieve |
| Expand |
|---|
| | Field | Details | | message | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | arrivalDate* | string($date-time) Proposed date of sample arrival ARRV_DATE Req 8 | | collectionDate | string($date-time)
nullable: trueDonor blood collection date COLL_DATE Opt 8 | | labelId* | string
maxLength: 19Verbatim verification typing (VT) sample label ID D_LABEL_ID Req 19 | | 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: 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 |
|
| | Expand |
|---|
| | No parameters specified |
|
...
If no SMP_RES can be sent then a NO_RES should be sent with the reason field populated to explain why.
| Send | Retrieve |
| SampleResponseRequestsampleResponseRequest (comments refer to changes to the current API definition) | SampleResponseRetrievesampleResponseRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| response | | Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | hlaNomenclatureVersion* | string
default: 3Major version of HLA Nomenclature HLA_NOM_VER Req 7 | | hla | {...} | | idm | {...} | | abo | string
nullable: trueEnum:
Array [ 4 ] | | rhesus | string
nullable: trueEnum:
Array [ 2 ] | | donorStillOfInterest | string
maxLength: 1Donor still of interest DON_ACCPT Req 1 Enum:
Array [ 2 ] |
|
| | 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 |
|
...
This message is used to request infectious disease marker test results of the selected donor. Expected return message is 'idm result' (5.8) or 'request rejected' (5.15).
| Send | Retrieve |
| InfectiousDiseaseMarkerRequestinfectiousDiseaseMarkerRequest | InfectiousDiseaseMarkerRequestRetrieveinfectiousDiseaseMarkerRequestRetrieve |
| Expand |
|---|
| | Field | Details |
|---|
| referenceCode* | string($uuid) | | markerAsArray | [...] | | marker* | integer
maxLength: 19
minLength: 19
example: 111110000111Binary fixed length string in which each position represents a test to be requested: Position 1: Blood group and rhesus Position 2: CMV status Position 3: Toxoplasmosis Position 4: EBV Position 5: HIV status Position 6: HIV P24 Position 7: Hepatitis B surface antigen Position 8: Antibody to Hepatitis B surface antigen Position 9: Antibody to Hepatitis B core antigen Position 10: Antibody to Hepatitis C virus Position 11: Lues status (Treponema pallidum) Position 12: ALT status Position 13: Antibody to HTLV1.V2 | | institutionPaying* | {...} | | acknowledgementId | string
maxLength: 17
nullable: true
example: 1234567890abcdefgAcknowledgement ID ACK_ID Opt 17 | | remark | string
maxLength: 120
nullable: true
example: Please also test for SARS-CoV-2Remark 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 |
|
...