Versions Compared

Old Version 140

changes.mady.by.user Albert Mustafin

Saved on

compared with

New Version 141

changes.mady.by.user Deepa Mallapareddy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HLA-DRB1 low resolution:
---L-------
HLA-DRB1 serological:
---S-------
HLA-DRB1 high resolution:
---H-------
HLA-DRB1 and HLA-DQB1 high resolution:
---H----H--

  • Intermediate resolution (M) translates to the non-high resolution.
  • The coding schema theoretically allows more combinations than the previous bitstring (e.g. non-high DRB1 typing). The actually valid combinations have to be published in the national rules of each registry. The local user interfaces will have to take care that no invalid or previously undefined requests are issued.
  • Combinations are possible, i.e. several loci may be requested in one message.
  • The appropriate action if the typing request cannot be accepted or has to be changed by the recipient, e.g. due to national rules, is to inform the requesting side what was done. If only the resolution was changed (the sender will receive something different than ordered - either more or less) or only a part of the requested loci were accepted (the sender will only receive parts of what was ordered): send a MSG_RSP containing the warning.

5.2 - Extended Typing Results (TYP_RES)

...

SendRetrieve
sampleRequestRequest (comments refer to changes to the current API definition)sampleRequestRetrieve
Expand
titleRequest
FieldDetails
request
Expand
title...
requestDatestring($date-time)

Request date REQ_DATE Req 8 yyyy-MM-dd [or yyyyMMdd]

prod1{...}
prod2{...}
prod3{...}
prod4{...}
earliestDateCanReceivestring($date-time)

Earliest date of sample reception REC_DATE1 Req 8 yyyy-MM-dd [or yyyyMMdd]

latestDateCanReceivestring($date-time)
nullable: true

Latest date of sample reception REC_DATE2 Opt 8 yyyy-MM-dd [or yyyyMMdd]

acceptableReceptionDaysOfWeekinteger
nullable: true
minLength: 7
maxLength: 7
example: 1111100

Weekdays 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.

institutionToSendSampleToEmbedded Address Block
institutionPayingEmbedded Address Block
urgentboolean

Urgent request URGENT Opt 1

acknowledgementIdstring
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
maxLength: 120
nullable: true
example: patient case is very urgent

Remark REMARK Opt 120

recipientinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...

No parameters specified

Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

Rules:

  • The fields ”earliest and latest date of sample reception” represent the lower and upper limit of a period of time in which the blood sample has to be received. If the second date is missing the sample may be received any time after the first date.
  • The quantity for the first product is optional when requesting DNA from a cord blood unit. In all other requests, the quantity fields for any of the corresponding product fields are required if a product is requested.
  • Number of tubes requested in a sample request or marrow request:
    • 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.

5.4 - Sample Information (SMP_INFO)

...

SendRetrieve
sampleInfoRequest (comments refer to changes to the current API definition)sampleInfoRetrieve
Expand
titleRequest...
referenceCode*string($uuid)
informationType*string
maxLength: 3
minLength: 3

Information Type INFO_TYPE Req 3

Enum:
Array [ 12 ]
remarkstring
nullable: true

Remark REMARK Opt 120

recipientinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patient*Patient ID
donor*Embedded Donor Block
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

Rules:

  • The 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” and 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 results nor a Request Rejected message 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.

5.5 - Sample Arrival (SMP_ARR)

...

SendRetrieve
sampleResponseRequest (comments refer to changes to the current API definition)sampleResponseRetrieve
Expand
titleRequest...
FieldDetails
response
Expand
title...
FieldDetails
referenceCode*string($uuid)
hlaNomenclatureVersion*string
default: 3

Major version of HLA Nomenclature HLA_NOM_VER Req 7

hla{...}
idm{...}
abostring
nullable: trueEnum:
Array [ 4 ]
rhesusstring
nullable: trueEnum:
Array [ 2 ]
donorStillOfIntereststring
maxLength: 1

Donor still of interest DON_ACCPT Req 1

Enum:
Array [ 2 ]
recipientinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patient*Patient ID
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
originalMessage{...}
metaInformationEmbedded Meta Block

Rules:

  • donorStillOfInterest = ”N” means: donor can be released immediately.
  • donorStillOfInterest = ”Y” means: please prolong donor reservation according to your national rules.
  • The fields for the infectious disease markers are included in this message in order to give the transplant centers the possibility to report the results of IDMs they might have tested.
  • If Sample Results cannot be sent then a Request Rejected message should be sent with the reason field populated to explain why.

5.7 - Infectious Disease Marker Request (IDM_REQ)

...

SendRetrieve
infectiousDiseaseMarkerRequestinfectiousDiseaseMarkerRequestRetrieve
Expand
titleRequest...
FieldDetails
referenceCode*string($uuid)
markerAsArray[...]
marker*integer
maxLength: 19
minLength: 19
example: 111110000111

Binary fixed length string in which each position represents a test to be requested: details in Data Dictionary

institutionPaying*Embedded Address Block
acknowledgementIdstring
maxLength: 17
nullable: true
example: 1234567890abcdefg

Acknowledgement ID ACK_ID Opt 17

remarkstring
maxLength: 120
nullable: true
example: Please also test for SARS-CoV-2

Remark REMARK Opt 120

recipient*integer
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

patient*Embedded Patient Block
donor*Donor ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

Rules:

  • Several distinct requests for the same patient / donor pair at a time are possible, for example, a verification typing and a CMV status, but each request has to be answered by an individual IDM Results, i.e. results must not be ”concatenated” to a single result message. Multiple IDM
    requests for the same patient / donor pair have to be disjoint (i.e. may not contain identical markers). The occurrence of multiple requests should be an exception. Normally, all markers required should be requested within one message.

5.8 - Infectious Disease Marker Results (IDM_RES)

...

SendRetrieve
infectiousDiseaseMarkerResultRequestinfectiousDiseaseMarkerResultRetrieve
Expand
titleRequest...
FieldDetails
referenceCode*string($uuid)
markerAsArray[...]
markerinteger
maxLength: 19
minLength: 19
example: 111110000111

Binary fixed length string in which each position represents a test to be requested: details are in Data Dictionary

sampleExtractionDatestring($date-time)
nullable: true

Date of sample extraction D_EXTR_DATE Opt 8

donorCcr5Statusstring
maxLength: 2
nullable: true

Donor CCR5 status D_CCR5 Opt 2

donorWeightKginteger($int32)
maximum: 999
minimum: 0
nullable: true

Donor weight in kilograms D_WEIGHT Opt 3

donorHeightCminteger($int32)
maximum: 999
minimum: 0
nullable: true
example: 175

Donor height in centimetres D_HEIGHT Opt 3

numberOfTransfusionsinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of transfusions D_NMBR_TRANS Opt 1

numberOfPregnanciesinteger($int32)
maximum: 9
minimum: 0
nullable: true

Number of pregnancies D_NMBR_PREG Opt 1

idm{...}
remarkstring
maxLength: 120
nullable: true

Remark REMARK Opt 120

recipientinteger
maximum: 9999
minimum: 0
maxLength: 4
minLength: 4
example: 1234

4 digit ION of recipient

donor*Embedded Donor Block
patient*Patient ID
Expand
titleResponse...
FieldDetails
wmdaResponseEmbedded WMDA Response Block
Expand
titleRequest...
No parameters specified
Expand
titleResponse...
FieldDetails
originalMessage{...}
metaInformationEmbedded Meta Block

Rules

  • The common use of IDM Results message is in response to Sample Request message, in addition to shipment of the donor blood sample. Please note there may be charge involved with this service. If a fee is charged, it may come as a separate item or might be included in the price of the sample shipment. Such IDM Results messages can be sent via a regular EMDIS message - the remote hub must be able to handle it appropriately. The IDM Results must have the same referenceCode as the Sample Request message.
  • IDM Results message can be generated in response to two different message requests:

      ...

        • Sample Request does not specify what set of infectious disease markers to be tested

      ...

        • IDM Request does specify what set of infectious disease markers to be tested
      • The field marker is a required field.
      • For those hubs reporting infectious disease markers during verification typing, the marker field should contain the IDMs actually tested. There is a fixed length binary field for the IDM Results message. The blood group may be also reported.
      • IDM results can be also reported as a part of Sample Results message by the hub (transplant center) that requested the blood sample. This is to give the transplant centers the possibility to report the results of IDMs they might have tested.

      5.9 - Reservation Request (RSV_REQ)

      ...